GithubHelp home page GithubHelp logo

bnubald / icenet Goto Github PK

View Code? Open in Web Editor NEW

This project forked from icenet-ai/icenet

0.0 0.0 0.0 1.74 MB

The icenet library is a pip installable python package containing the commands and code you need to produce forecasts

License: MIT License

Python 99.46% Makefile 0.54%

icenet's Introduction

icenet

GitHub issues GitHub closed issues GitHub GitHub forks GitHub forks

This is the core python library for the IceNet sea-ice forecasting system.

This README will be worked on more, but there's plenty of information around in the icenet-ai organisations repositories, which demonstrate usage of this library.

Table of contents

Installation

We're still working on clear dependency management using pip, Tensorflow is best through pip but obviously you need NVIDIA dependencies for GPU based training. If you're having trouble with system dependencies some advice about environment setup is given by the examples under the pipeline repository.

Please note that icenet has an optional dependency on eccodes which requires a system library and a python wrapper. The system library can be installed via conda.

By default, Tensorflow will be built for CPU only when icenet is installed via pip. So, optionally, Tensorflow can be installed with CUDA support (recommended).

conda install -c conda-forge eccodes

pip install icenet

# To install newer versions of tensorflow (tensorflow>=2.14) with CUDA deps directly via pip:
pip install "tensorflow[and-cuda]<2.16"

Please consult the tensorflow docs for up-to-date info.

Development installation

Please refer to the contribution guidelines for more information.

Implementation

When installed, the library will provide a series of CLI commands. Please use the --help switch for more initial information, or the documentation.

Documentation

The docs/ directory has a Makefile that builds sphinx docs easily enough, once the requirements in that directory are installed.

Usage Pipeline / Examples

Please refer to the icenet-pipeline repository or the icenet-notebook repository for examples of how to use this library.

Contributing to IceNet

Please refer to the contribution guidelines for more information.

Credits

License

This is licensed using the MIT License

icenet's People

Contributors

bnubald avatar jimcircadian avatar ots22 avatar rchan26 avatar tom-andersson avatar

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.