Skip to content

Latest commit

 

History

History
99 lines (72 loc) · 2.98 KB

README.md

File metadata and controls

99 lines (72 loc) · 2.98 KB
Raw

test

Project Organization

├── LICENSE                       <- The LICENSE using this project.
├── README.md                     <- The top-level README for developers using this project.
├── CHANGELOG.md                  <- The top-level CHANGELOG for developers using this project.
├── env.default                   <- Environment vars definition
├── Makefile                      <- Makefile with commands
├──.pre-commit-config             <- Helps setup github basic precommit hooks
├── docker-compose.yml            <- Docker configs environment definition
├── .gitignore                    <- files don't want to copy in githubs
├── data
│   ├── processed                 <- The final, canonical data sets.
│   └── raw                       <- The original data.
|
└── notebooks                     <- Naming convention is a number (for ordering),
    │                                the creator's initials, and a short `-` delimited e.g.
    │                                `1.0-jqp-initial-data-exploration`.
    ├──.env
    ├──.dockerignore
    ├──environment.conda-lock.yaml<- Notebook env.lock that will be used to quick install dependencies
    ├──package.yaml               <- Notebooks requirements base on conda env
    ├──Dockerfile                 <- Sets up Jupyter notebooks environment
    ├──jupyter_server_config.py   <- Configure Jupyter notebooks
    ├──template_notebooks         <- where the notebooks template will live.
    │
    └──Lab                        <- Notebooks for reports/ designers /
                                     developers etc.

Steps for use

First, setup one of your environments

make up

And if you want to get into the main container:

make inside
  • Install requirements on your machine:
make requirements
  • Set up a new environment in your machine
make create_environment && make requirements

Second, Init git and initialize the github pre-hooks

make init-prehooks

By default this will treat your project remote branch as [email protected]:Vizzuality/test if you need to change it don't forget to modify the Makefile before running this command. Take into account that this will create a new repository under the vizzuality organization once you git push -u origin master

Happy coding and science

You can run your tests:

make test

You can lint and reformat your code:

make lint

or up and serve the documentation:

make serve-doc

Project based on the cookiecutter data science project template. #cookiecutterdatascience