Complex modeling infrastructure: a modulare framework for multi-modal modeling of scientific data.
- LONGER DESCRIPTION HERE
For more information about the diffpy.cmi library, please consult our online documentation.
If you use diffpy.cmi in a scientific publication, we would like you to cite this package as
diffpy.cmi Package, https://github.com/diffpy/diffpy.cmi
The preferred method is to use Miniconda Python and install from the "conda-forge" channel of Conda packages.
To add "conda-forge" to the conda channels, run the following in a terminal.
conda config --add channels conda-forge
We want to install our packages in a suitable conda environment.
The following creates and activates a new environment named diffpy.cmi_env
conda create -n diffpy.cmi_env diffpy.cmi conda activate diffpy.cmi_env
To confirm that the installation was successful, type
python -c "import diffpy.cmi; print(diffpy.cmi.__version__)"
The output should print the latest version displayed on the badges above.
If the above does not work, you can use pip to download and install the latest release from
Python Package Index.
To install using pip into your diffpy.cmi_env environment, type
pip install diffpy.cmi
If you prefer to install from sources, after installing the dependencies, obtain the source archive from
GitHub. Once installed, cd into your diffpy.cmi directory
and run the following
pip install .
You may consult our online documentation for tutorials and API references.
If you see a bug or want to request a feature, please report it as an issue and/or submit a fix as a PR.
Feel free to fork the project and contribute. To install diffpy.cmi in a development mode, with its sources being directly used by Python rather than copied to a package directory, use the following in the root directory
pip install -e .
To ensure code quality and to prevent accidental commits into the default branch, please set up the use of our pre-commit hooks.
- Install pre-commit in your working environment by running
conda install pre-commit. - Initialize pre-commit (one time only)
pre-commit install.
Thereafter your code will be linted by black and isort and checked against flake8 before you can commit. If it fails by black or isort, just rerun and it should pass (black and isort will modify the files so should pass after they are modified). If the flake8 test fails please see the error messages and fix them manually before trying to commit again.
Improvements and fixes are always appreciated.
Before contributing, please read our Code of Conduct.
For more information on diffpy.cmi please visit the project web-page or email Simon Billinge at [email protected].
diffpy.cmi is built and maintained with scikit-package.