Skip to content

AgriculturalModelExchangeInitiative/cookiecutter-crop2ml

Repository files navigation

Cookiecutter Crop2ML

A logical, reasonably standardized, but flexible project structure for sharing crop models components between crops modelling platform.

Requirements to use the cookiecutter template:


  • Python 2.7 or 3.5
  • Cookiecutter Python package >= 1.4.0: This can be installed with pip by or conda depending on how you manage your Python packages:
$ pip install cookiecutter

or

$ conda config --add channels conda-forge
$ conda install cookiecutter

To start a new project, run:


cookiecutter https://github.com/AgriculturalModelExchangeInitiative/cookiecutter-crop2ml

asciicast

The resulting directory structure


The directory structure of your new project looks like this:


    ├── LICENSE.txt        <- License file
    ├── README.md          <- The top-level README for AMEI members using this project.
    ├── data/              <- data used for model simulation
    │
    ├── doc/               <- Package documentation
    │
    ├── test/             <- model tests for each language and platform
    │
    ├── crop2ml/          <- model units and composite in crop2ml format.
    │      ├── xml files
    │      ├── Algo/
    |
    │
    ├── src/                <- Executable source in different language and platform
    │   ├── pyx/
    │   ├── java/
    │   ├── py/
        ├── R/
        ├── cpp/
        ├── cs/
        ├── f90/
        ├── Bioma/
        ├── Simplace/
        ├── OpenAlea/
        ├── Record/
   

Contributing

We welcome contributions! See the docs for guidelines.

About

cookiecutter for sharing crop2ml models package

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published