Installation

Install using pip

The flory Python package is available on pypi, so you should be able to install it by running

pip install flory

By default, flory package only comes with the dependencies directly referenced by its main functionality. The dependencies for examples, tests and documentations are not included. To install all these dependencies, you can specify a dev option:

pip install 'flory[dev]'

You may also want to select among the optional dependencies for examples, tests or documentations. In this case, you can specify option example, test or doc. For example:

pip install 'flory[example]'

Install using conda

As an alternative, the flory Python package is also available through conda using the [conda-forge](https://conda-forge.org/) channel:

conda install -c conda-forge flory

If you are using conda, we recommend that you install the optional dependencies directly:

conda install -c conda-forge --file https://raw.githubusercontent.com/qiangyicheng/flory/main/examples/requirements.txt
conda install -c conda-forge --file https://raw.githubusercontent.com/qiangyicheng/flory/main/tests/requirements.txt
conda install -c conda-forge --file https://raw.githubusercontent.com/qiangyicheng/flory/main/docs/requirements.txt

Test installation

If the optional dependencies for tests are installed, you can run tests in root directory of the package with pytest. By default, some slow tests are skipped. You can run them with the --runslow option:

pytest --runslow