Skip to content
Snippets Groups Projects
Commit cd937b53 authored by Eric Casellas's avatar Eric Casellas
Browse files

publishing info

parent 314a9272
Branches main
No related tags found
No related merge requests found
Pipeline #83396 passed
**/buildvle
**~
stages:
- test
- docs
variables:
DOCKER_HOST: tcp://docker:2376
DOCKER_TLS_CERTDIR: "/certs"
DOCKER_DRIVER: overlay2
GIT_DEPTH: 1
vle_test:
image: ${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/docker:20.10.20
stage: test
services:
- docker:20.10.20-dind
script:
- docker run
--rm
-v "$(pwd):/work"
registry.forgemia.inra.fr/record/record@sha256:93cb949a4228b4da336490900b523483503a07ab07eb8a3b438b66c7e75919e5
vle -P GroundWaterNitrogen clean rclean configure build empty.vpz
pages:
image: ${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/docker:20.10.20
stage: docs
services:
- docker:20.10.20-dind
script:
- mkdir -p public
- docker run -v "$(pwd):/tmp" rocker/tidyverse:4.2
R -e "rmarkdown::render(input='/tmp/GroundWaterNitrogen/doc/GroundWaterNitrogen_pkg_doc.md', output_file='/tmp/public/index.html')"
artifacts:
paths:
- public
rules:
- changes:
- .gitlab-ci.yml
- GroundWaterNitrogen/doc/GroundWaterNitrogen_pkg_doc.md
# GroundWaterNitrogen
> A simple model simulating the nitrogen content in groundwater following passive water flow and assuming perfect mixing.
This model has been developped during the [Atcha project](https://www6.inrae.fr/atcha/).
The documentation of the model is available at https://record-open-archives.pages.mia.inra.fr/groundwaternitrogen/
## Requirements
* [VLE-2.0.2](https://github.com/vle-forge/vle/releases/tag/v2.0.2) ([requirements](https://github.com/vle-forge/vle/tree/master2.0#requirements))
* VLE packages
* [vle.discrete-time](https://github.com/vle-forge/packages/tree/82ee9dfbae1fb24cdbdb39ea9ff7eee19eb062fe/vle.discrete-time)
## Build/installation instructions
### Local build
Once the above requirements are met install the GroundWaterNitrogen VLE package by running the following command from the root directory of this project
```shell
vle -P GroundWaterNitrogen clean rclean configure build
```
### Using docker
Alternativly a [docker](https://www.docker.com/get-started/) image satisfying all the above requirements is available in a public docker registry at registry.forgemia.inra.fr/record/record@sha256:93cb949a4228b4da336490900b523483503a07ab07eb8a3b438b66c7e75919e5.
Once docker is installed, run an interactive container with the following command from the root directory of this project
```shell
docker run \
--rm \
-it \
--user root \
-v "$(pwd):/work" \
registry.forgemia.inra.fr/record/record@sha256:93cb949a4228b4da336490900b523483503a07ab07eb8a3b438b66c7e75919e5 \
bash
```
Then from inside the container run the commands
```shell
vle -P GroundWaterNitrogen clean rclean configure build
```
## Licence
GPLv3 or later. See the file GroundWaterNitrogen/Licence.txt. Some files are under a different license. Check the headers for the copyright info.
\ No newline at end of file
{
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
"@type": "SoftwareSourceCode",
"license": "https://spdx.org/licenses/GPL-3.0-or-later",
"codeRepository": "git+https://forgemia.inra.fr/record-open-archives/groundwaternitrogen.git",
"dateCreated": "2019-02-19",
"datePublished": "2023-01-30",
"issueTracker": "https://forgemia.inra.fr/record-open-archives/groundwaternitrogen/-/issues",
"name": "GroundWaterNitrogen",
"description": "A simple model simulating the nitrogen content in groundwater following passive water flow and assuming perfect mixing.",
"funding": "ANR-16-CE03-0006",
"developmentStatus": "inactive",
"isPartOf": "http://www.vle-project.org",
"funder": {
"@type": "Organization",
"name": "ANR,CEFIPRA"
},
"programmingLanguage": [
"C++"
],
"operatingSystem": [
"Linux",
"Windows"
],
"softwareRequirements": [
"vle 2.0",
"http://www.vle-project.org",
"",
"boost 1.49",
"http://www.boost.org",
"",
"cmake 2.8",
"http://www.cmake.org"
],
"author": [
{
"@type": "Person",
"@id": "https://orcid.org/ 0000-0002-8492-0511",
"givenName": "Eric",
"familyName": "Casellas",
"email": "eric.casellas@inrae.fr",
"affiliation": {
"@type": "Organization",
"name": "MIAT,INRAE"
}
}
]
}
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment