Giter VIP home page Giter VIP logo

fuel-build-up's Introduction

fuel-build-up

License: MIT Code style: black DOI

Analysis of wildfires.

This makes extensive use of the 'wildfires' Python package.

Development

The instructions below assume that you are using Linux and managing Python using pyenv and pyenv-virtualenv.

All essential configuration steps detailed in the section Prerequisites are automatically carried out by dev/bootstrap.py. To view options for this initial setup, run

dev/bootstrap.py --help

Installing JupyterLab extensions

dev/install_jupyter_extensions.py

Prerequisites

Installing Dependencies

This information is mainly for reference and additional documentation of dev/bootstrap.py, or if individual parts (like using pytest) should be carried out independently.

Installing Into an Existing Environment

Installing all packages and configuring all tools:

dev/bootstrap.py existing

Installing Into a New Environment

By default, the new environment will be called 'wildfires'. Installation will fail if an environment with this name is already present, unless the --force flag is supplied, as shown below:

dev/bootstrap.py new --force

Internally dev/bootstrap.py new uses conda env create with support for the --name and --force options.

Creating a new Conda Environment Manually

Creating a new environment called 'wildfires':

conda env create --file requirements.yaml --name wildfires

Overwriting an existing environment called 'wildfires':

conda env create --file requirements.yaml --name wildfires --force

Using a New Environment

Making a new environment the local default environment for the repository using pyenv (assuming --name wildfires was used):

pyenv activate wildfires
pyenv local $PYENV_VERSION

Hooks and Tests

To set up pre-commit hooks, run

pre-commit install

This needs to be done every time the repository is cloned (as is done by dev/bootstrap.py)!

Manual pre-commit Testing

pre-commit run --verbose --all-files

Pytest

Run pytest in the root directory of the repository, so that all tests will be discovered. If DeprecationWarning warnings are desired, run pytest -Wd instead.

Note that pytest is also run as part of the pre-commit hooks set up by pre-commit.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.