Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CliMA/ClimaAtmos.jl
ClimaAtmos.jl is a library for building atmospheric circulation models that is designed from the outset to leverage data assimilation and machine learning tools. We welcome contributions!
https://github.com/CliMA/ClimaAtmos.jl
climate data-assimilation fluid-dynamics julia machine-learning optimization
Last synced: 9 days ago
JSON representation
ClimaAtmos.jl is a library for building atmospheric circulation models that is designed from the outset to leverage data assimilation and machine learning tools. We welcome contributions!
- Host: GitHub
- URL: https://github.com/CliMA/ClimaAtmos.jl
- Owner: CliMA
- License: apache-2.0
- Created: 2021-06-17T17:25:24.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T15:58:15.000Z (10 days ago)
- Last Synced: 2024-10-29T16:05:45.982Z (10 days ago)
- Topics: climate, data-assimilation, fluid-dynamics, julia, machine-learning, optimization
- Language: Julia
- Homepage:
- Size: 68.4 MB
- Stars: 82
- Watchers: 8
- Forks: 16
- Open Issues: 163
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- open-sustainable-technology - ClimaAtmos.jl - A library for building atmospheric circulation models that is designed from the outset to leverage data assimilation and machine learning tools. (Atmosphere / Atmospheric Composition and Dynamics)
README
ClimaAtmos.jl
Atmosphere components of the CliMA software stack.
[![docsbuild][docs-bld-img]][docs-bld-url]
[![dev][docs-dev-img]][docs-dev-url]
[![ghaci][gha-ci-img]][gha-ci-url]
[![buildkite][bk-ci-img]][bk-ci-url]
[![codecov][codecov-img]][codecov-url]
[![discussions][discussions-img]][discussions-url]
[![col-prac][col-prac-img]][col-prac-url]
[docs-bld-img]: https://github.com/CliMA/ClimaAtmos.jl/workflows/Documentation/badge.svg
[docs-bld-url]: https://github.com/CliMA/ClimaAtmos.jl/actions?query=workflow%3ADocumentation
[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
[docs-dev-url]: https://CliMA.github.io/ClimaAtmos.jl/dev/
[gha-ci-img]: https://github.com/CliMA/ClimaAtmos.jl/actions/workflows/ci.yml/badge.svg
[gha-ci-url]: https://github.com/CliMA/ClimaAtmos.jl/actions/workflows/ci.yml
[bk-ci-img]: https://badge.buildkite.com/2a31b42d67409c27660a0dcce65b49294cd9c6b9f14c12f21e.svg
[bk-ci-url]: https://buildkite.com/clima/climaatmos-ci
[codecov-img]: https://codecov.io/gh/CliMA/ClimaAtmos.jl/branch/main/graph/badge.svg
[codecov-url]: https://codecov.io/gh/CliMA/ClimaAtmos.jl
[col-prac-img]: https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet?style=flat-square
[col-prac-url]: https://github.com/SciML/ColPrac
[discussions-img]: https://img.shields.io/badge/Ask%20us-anything-1abc9c.svg?style=flat-square
[discussions-url]: https://github.com/CliMA/ClimaAtmos.jl/discussions
ClimaAtmos.jl is the atmosphere components of the CliMA software stack. We strive for a user interface that makes ClimaAtmos.jl as friendly and intuitive to use as possible, allowing users to focus on the science.
## Installation instructions
Recommended Julia: Stable release v1.10.0
ClimaAtmos.jl is a [registered Julia package](https://julialang.org/packages/). To install
```julia
julia> using Pkg
julia> Pkg.add("ClimaAtmos")
```
Alternatively, download the `ClimaAtmos`
[source](https://github.com/CliMA/ClimaAtmos.jl) with:
```
$ git clone https://github.com/CliMA/ClimaAtmos.jl.git
```
Now change into the `ClimaAtmos.jl` directory with
```
$ cd ClimaAtmos.jl
```
To use ClimaAtmos, you need to instantiate all dependencies with:
```
$ julia --project
julia> ]
(ClimaAtmos) pkg> instantiate
```
## Running instructions
Currently, the simulations are stored in the `test` folder. Run all the test cases with the following commands.
First, we instantiate the test environment, by launching (from `ClimaAtmos.jl/`) Julia with the `test/` environment active:
```
$ julia --project=test
```
Then, once in the Julia REPL, we switch to the package manager by pressing `]`:
```julia
julia> ]
```
Once in the package manager, we `develop` the `ClimaAtmos.jl/` directory:
```pkg
test> dev .
```
Now, we can switch back to the Julia REPL by escaping and run the test suite interactively:
```julia
julia> include(joinpath("test", "runtests.jl"))
```
Or escape the Julia REPL and run from the command line:
```
$ julia --project=test test/runtests.jl
```
If you run into issues when running the test suite this way, please open an issue.
## Contributing
If you're interested in contributing to the development of ClimaAtmos we want your help no matter how big or small a contribution you make! It's always great to have new people look at the code with fresh eyes: you will see errors that other developers have missed.
Let us know by [opening an issue](https://github.com/CliMA/ClimaAtmos.jl/issues/new) if you'd like to work on a new feature.
Here is the rule of thumb [coding style](https://clima.github.io/ClimateMachine.jl/latest/DevDocs/CodeStyle/) and [unicode usage restrictions](https://clima.github.io/ClimateMachine.jl/latest/DevDocs/AcceptableUnicode/).
For more information, check out our [contributor's guide](https://clima.github.io/ClimaAtmos.jl/dev/contributor_guide/).