JSON to Ciw (json2ciw)

A simple tool for converting JSON files into functional Ciw simulation models.

Citation

If you reuse any of the code, or this project supports your work, please provide a citation. The recommended citation detailed are maintained in CITATION.cff.

Development installation instructions

All dependencies are listed in pyproject.toml. To run the code locally, we recommend installing miniforge;

Miniforge is Free and Open Source Software (FOSS) alternative to Anaconda and miniconda that uses conda-forge as the default channel for packages. It installs both conda and mamba (a drop in replacement for conda) package managers. We recommend mamba for faster resolving of dependencies and installation of packages.

Navigate to the repository directory in your terminal (or command prompt), then create the environment:

mamba create -n json2ciw python=3.12
mamba activate json2ciw
pip install -e .
pip install --group dev

Alternatively, a fixed environment is provided in binder/environment.yml:

mamba env create -f binder/environment.yml
mamba activate json2ciw

Licence

The materials have been made available under an MIT license. The materials are as-is with no liability for the author. Please provide credit if you reuse the code in your own work.

Key files

• binder/environment.yml - Conda environment for local set-up.
• CHANGELOG.md - Record of notable changes between versions.
• CITATION.cff - Citation metadata for the repository.
• LICENSE - Terms of the MIT licence.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Tom Monks 💻 🎨 📖 💡 🤔 🚇 🚧 ⚠️ ✅

Amy Heather 💻 🎨 📖 💡 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!