Skip to content
README.md 2.1 KiB
Newer Older
Christoph.Knote's avatar
Christoph.Knote committed
# BOXMOX

**Box modeling extensions to KPP**

Christoph Knote's avatar
Christoph Knote committed
Documentation, user downloads, online tools and further information can be found [here](https://mbees.med.uni-augsburg.de/boxmodeling/).
Christoph.Knote's avatar
Christoph.Knote committed

This is the development repository.
Christoph Knote's avatar
Christoph Knote committed

## Contributing

We are looking forward to receiving your [new issue report](https://mbees.med.uni-augsburg.de/gitlab/mbees/icartt_pypackage/-/issues/new).

If you'd like to contribute source code directly, please [create a fork](https://mbees.med.uni-augsburg.de/gitlab/mbees/icartt_pypackage),
make your changes and then [submit a merge request](https://mbees.med.uni-augsburg.de/gitlab/mbees/icartt_pypackage/-/merge_requests/new) to the original project.

## Citation
Christoph Knote's avatar
Christoph Knote committed

Please cite our work when BOXMOX use constituted a relevant contribution to your scientific work. The citation for BOXMOX is [Knote et al., Atm. Env., 2015](http://dx.doi.org/10.1016/j.atmosenv.2014.11.066).
Christoph.Knote's avatar
Christoph.Knote committed

## Where does BOXMOX extend KPP?
Christoph.Knote's avatar
Christoph.Knote committed

`drv/boxmox.f90`/ `drv/boxmox_adjoint.f90`
Christoph.Knote's avatar
Christoph.Knote committed

KPP (adjoint) driver for BOXMOX.
Christoph.Knote's avatar
Christoph.Knote committed

`drv/wrapper`
Christoph.Knote's avatar
Christoph.Knote committed

This is where all BOXMOX extension code lives.
Christoph.Knote's avatar
Christoph.Knote committed

`case_studies/`
Christoph.Knote's avatar
Christoph.Knote committed

Test cases for BOXMOX usage.
Christoph.Knote's avatar
Christoph.Knote committed

`doc/boxmox_README.tex`
Christoph.Knote's avatar
Christoph.Knote committed

BOXMOX documentation.
Christoph.Knote's avatar
Christoph.Knote committed

Christoph.Knote's avatar
Christoph.Knote committed

Additional chemistry mechanisms included with BOXMOX.
Christoph.Knote's avatar
Christoph.Knote committed

`scripts/`

Command-line scripts to drive BOXMOX.

`util/UserRateLaws_BOXMOX.f90`

Rate constant equations for BOXMOX.
Christoph Knote's avatar
Christoph Knote committed

## License statement

BOXMOX is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

BOXMOX is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
Christoph.Knote's avatar
Christoph.Knote committed

Christoph Knote's avatar
Christoph Knote committed
You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
Christoph.Knote's avatar
Christoph.Knote committed

## Contact

[Christoph Knote](mailto:christoph.knote@med.uni-augsburg.de), [MBEES, Faculty of Medicine, University of Augsburg](https://mbees.med.uni-augsburg.de), Germany