From dc0e9ff9e196cdcf3b729fb59b7c8c36e975be38 Mon Sep 17 00:00:00 2001 From: Christoph Knote <christoph.knote@med.uni-augsburg.de> Date: Mon, 14 Mar 2022 12:51:06 +0100 Subject: [PATCH] Prepping for release --- CHANGES.md | 17 ----------------- INSTALL.md | 14 -------------- LICENSE.txt => LICENSE | 0 README.md | 42 ++++++++++++++++++++++++++++++++++++------ pyproject.toml | 4 ++-- setup.cfg | 38 -------------------------------------- 6 files changed, 38 insertions(+), 77 deletions(-) delete mode 100644 CHANGES.md delete mode 100644 INSTALL.md rename LICENSE.txt => LICENSE (100%) delete mode 100644 setup.cfg diff --git a/CHANGES.md b/CHANGES.md deleted file mode 100644 index c491c49..0000000 --- a/CHANGES.md +++ /dev/null @@ -1,17 +0,0 @@ -# Changelog - -## 1.2.0 (2022-03-08) - -- Updates to be compatible with BOXMOX 1.8 - -## 1.1.0 (2020-09-16) - -- Python 3 compatible - -## 1.0.0 (2017-12-19) - -- Peer-reviewed version to be published in Knote et al., GMD - -## 0.1.0 (2017-08-12) - -- Initial release diff --git a/INSTALL.md b/INSTALL.md deleted file mode 100644 index cf7c065..0000000 --- a/INSTALL.md +++ /dev/null @@ -1,14 +0,0 @@ -``` -pip install boxmox -``` - -The BOXMOX chemical box model needs to be installed and usable, -and the KPP_HOME environment variable has to be set. - -Set the BOXMOX environmental variable in ~/.bashrc or similar for your shell: - -``` -export BOXMOX_WORK_PATH=/where/you/want/boxmox/to/write/stuff/to/ -``` - -Remember to close the shell and log in again for these changes to take effect. diff --git a/LICENSE.txt b/LICENSE similarity index 100% rename from LICENSE.txt rename to LICENSE diff --git a/README.md b/README.md index d67c25c..ccd74bf 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,43 @@ # BOXMOX ``boxmox`` is the Python wrapper for the chemical box model BOXMOX (a standalone -C/Fortran executable) +C/Fortran executable). -## Documentation +## Installation notes -maintained at http://mbees.med.uni-augsburg.de/boxmodeling/ +### BOXMOX model needs to be installed -## Installation +The BOXMOX chemical box model needs to be installed and usable, +and the KPP_HOME environment variable has to be set. -The chemical box model BOXMOX is required. See the documentation for -detailed instructions on how to install it. \ No newline at end of file +You can download it from our website at https://mbees.med.uni-augsburg.de/boxmodeling. + +### Environment variable needs to be set + +Additionally, boxmox needs a path to write temporary model results +to. This directory needs to be accessible and writeable by the +user. Set it in your environment, e.g., through: + +``` +export BOXMOX_WORK_PATH=/where/you/want/boxmox/to/write/stuff/to/ +``` + +Remember to close the shell and log in again for these changes to take effect. + +# Changelog + +## 1.2.0 (2022-03-08) + +- Updates to be compatible with BOXMOX 1.8 + +## 1.1.0 (2020-09-16) + +- Python 3 compatible + +## 1.0.0 (2017-12-19) + +- Peer-reviewed version to be published in Knote et al., GMD + +## 0.1.0 (2017-08-12) + +- Initial release diff --git a/pyproject.toml b/pyproject.toml index f066dbb..b56277b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "boxmox" -version = "1.2.0" +version = "1.2.1" description = "BOXMOX python interface" license = "GPL-3.0-or-later" authors = ["Christoph Knote <christoph.knote@med.uni-augsburg.de>"] @@ -31,7 +31,7 @@ issues = "http://mbees.med.uni-augsburg.de/gitlab/mbees/boxmox_pypackage/issues" [tool.poetry.dependencies] -python = "^3.10" +python = "^3" numpy = ">= 1.2" f90nml = ">= 1.3" pyparsing = ">= 3" diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index dd7e8cd..0000000 --- a/setup.cfg +++ /dev/null @@ -1,38 +0,0 @@ -[metadata] -name = boxmox -version = 1.2.0 -author = Christoph Knote -author_email = christoph.knote@med.uni-augsburg.de -description = BOXMOX python interface -long_description = file: README.md, INSTALL.md, CHANGES.md -long_description_content_type = text/markdown -url = https://mbees.med.uni-augsburg.de -project_urls = - Bug Tracker = http://mbees.med.uni-augsburg.de/gitlab/mbees/boxmox_pypackage/issues -classifiers = - Programming Language :: Python :: 3 - Development Status :: 5 - Production/Stable - Environment :: Console - Intended Audience :: Developers - Intended Audience :: Education - Intended Audience :: End Users/Desktop - Intended Audience :: Science/Research - License :: OSI Approved :: GNU General Public License v3 (GPLv3) - Operating System :: POSIX - Topic :: Education - Topic :: Scientific/Engineering - Topic :: Utilities - -[options] -package_dir = - = src -packages = find: -python_requires = >=3.0 -include_package_data = True - -[options.packages.find] -where = src - -[options.entry_points] -console_scripts = - plot_BOXMOX_experiment = boxmox._console:plotExperiment -- GitLab