# Ratio's DSM plotting library
This crate enables the plotting or drawing of Dependency Structure Matrices as SVG figures. It
features a a trait-based approach which enables you to keep your data as much as-is as possible
and only requires the bare minimum to be exposed using primarily Rust primitives.
Take a look at the [`traits::Component`](https://docs.rs/ratio-dsm/latest/ratio_dsm/traits/trait.Component.html) trait for the typical structure of an SVG component and
the [`traits::Dsm`](https://docs.rs/ratio-dsm/latest/ratio_dsm/traits/trait.Dsm.html) for a single trait that on implementation allows for the
[`dsm::DsmComponent`](https://docs.rs/ratio-dsm/latest/ratio_dsm/dsm/struct.DsmComponent.html) to be constructed.
## Documentation
Please refer to the crate's documentation on [docs.rs](https://docs.rs/ratio-dsm) for more information on it's usage.
## Changelog
This repository keeps a [CHANGELOG.md](https://gitlab.com/ratio-case-os/rust/ratio-case/-/blob/main/ratio-dsm/CHANGELOG.md) according to the recommendations by [Keep a Changelog](https://keepachangelog.com/).
## Contributions
Contributions are welcome! By submitting a contribution, you agree to license your work under the terms of the [Mozilla Public License 2.0](https://mozilla.org/MPL/2.0/). Please ensure that your contributions adhere to the existing code style and include appropriate tests and documentation where applicable.
### To get started:
1. Fork the repo
1. Create a new branch
1. Make your changes
1. Make sure you run `just fix` to adhere to the project's formatting
1. Submit a merge request with a clear description of the changes
### Licensing
This project is licensed under the [Mozilla Public License 2.0](https://mozilla.org/MPL/2.0/). You are free to use, modify, and distribute this code, provided that any files you modify or create that are based on MPL-licensed files also remain under the MPL. You must include a copy of the license with the source and make the source code available when distributing binaries.
See the [LICENSE](https://gitlab.com/ratio-case-os/rust/ratio-dsm/-/blob/main/ratio-dsm/LICENSE) file for the full license text.
**Code examples both in the docstrings and rendered documentation thereof are free to use!**
At Ratio, we are huge supporters of open-source code and the open-source community. In our Python projects we usually strive to use one of the (L)GPL flavors. These are difficult to pair with compiled codebases, however, which is where we see the MPL-2.0 as a great fit for our open-source Rust efforts. It's a weak copyleft license that just protects the source as it is written and encourages changes to the crate's source to be published accordingly. It's sort of "automagically" implied and done right when `cargo` would pull in the source files to build with, as (the mentioning of) the license is included in the header of each file, and any binaries you generate with them are not of our concern from a distribution perspective.
Enjoy the code!