Updated readme and naming artifacts

.gitlab-ci.yml

@@ -8,6 +8,7 @@ build:
   before_script:
     - DEBIAN_FRONTEND=noninteractive apt-get -qq update
     - DEBIAN_FRONTEND=noninteractive apt-get -qq install wget patch make gcc gfortran flex bison texlive autoconf autotools-dev
+    - [ -f ./version ] && export VERSION=$(cat ./version)
   script:
     - aclocal
     - autoconf
@@ -18,5 +19,6 @@ build:
     - make dist
     - make distcheck
   artifacts:
+    name: boxmox-dist-CI_COMMIT_SHORT_SHA
     paths:
       - boxmox-*.tar.gz

README.md

@@ -4,35 +4,48 @@
 
 Documentation, user downloads, online tools and further information can be found [here](https://mbees.med.uni-augsburg.de/boxmodeling/).
 
-This is the development repository. BOXMOX is an extension to KPP, hence it lives as part of KPP. For distribution, a patch against standard KPP is created, KPP is downloaded from the original location, and the code is patched. For testing, each commit creates a [downloadable distribution](https://git.rz.uni-augsburg.de/knotechr/boxmox/-/jobs/artifacts/master/download?job=boxmox_latest) which can used directly for testing.
+This is the development repository.
 
-Feel free to push merge requests and add issues if you should encounter any.
+## 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
 
 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).
 
-## Code structure
+## Where does BOXMOX extend KPP?
 
-`boxmox/`
+`drv/boxmox.f90`/ `drv/boxmox_adjoint.f90`
 
-Main KPP directory, patched and extended for BOXMOX.
+KPP (adjoint) driver for BOXMOX.
 
-`boxmox/boxmox/`
+`drv/wrapper`
 
-Additional data and code for BOXMOX.
+This is where all BOXMOX extension code lives.
 
-`boxmox/boxmox/wrapper`
+`case_studies/`
 
-Main BOXMOX user code file.
+Test cases for BOXMOX usage.
 
-`boxmox/boxmox/boxmox(_adjoint).f90`
+`doc/boxmox_README.tex`
 
-KPP (adjoint) driver for BOXMOX.
+BOXMOX documentation.
 
-`boxmox/boxmox/examples`
+`models/`
 
-Test cases for BOXMOX usage.
+Additional chemistry mechanisms included with BOXMOX.
 
-[Christoph Knote](mailto:christoph.knote@med.uni-augsburg.de), [MBEES, Faculty of Medicine, University of Augsburg](https://mbees.med.uni-augsburg.de), Germany
+`scripts/`
+
+Command-line scripts to drive BOXMOX.
+
+`util/UserRateLaws_BOXMOX.f90`
+
+Rate constant equations for BOXMOX.
 
 ## License statement
 
@@ -49,3 +62,7 @@ GNU General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+## Contact
+
+[Christoph Knote](mailto:christoph.knote@med.uni-augsburg.de), [MBEES, Faculty of Medicine, University of Augsburg](https://mbees.med.uni-augsburg.de), Germany
+