Skip to content

TimoDiepers/optimex

optimex logo

Read the Docs PyPI - Version Conda Version Conda - License

This is a python package for time-explicit Life Cylce Optimization that helps you identify transition pathways of systems with minimal environmental impacts.

Warning

This is an early access version of the package developed during @JanTautorus' master thesis. While it's functional, it’s not fully configured to handle all use cases yet.

Installation

You can install optimex via [pip] from [PyPI]:

$ pip install optimex

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the BSD 3 Clause license, optimex is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Building the Documentation

You can build the documentation locally by installing the documentation Conda environment:

conda env create -f docs/environment.yml

activating the environment

conda activate sphinx_optimex

and running the build command:

sphinx-build docs _build/html --builder=html --jobs=auto --write-all; open _build/html/index.html

Acknowledgments

We’d like to thank the authors and contributors of the following key packages that optimex is based on:

Additionally, we want to give a shoutout to the pioneering ideas and contributions from the following works:

Support

If you have any questions or need help, do not hesitate to contact us: