Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
albangossard committed Jan 23, 2025
1 parent a539180 commit 3132628
Showing 1 changed file with 2 additions and 11 deletions.
13 changes: 2 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,6 @@

Sleipnir.jl is the core package of [ODINN.jl](https://github.com/ODINN-SciML/ODINN.jl), containing all the basic data structures to manage glacier and climate data, as well as multiple types of numerical simulations and parameters.

## Important information
## Data preprocessing

- Sleipnir CI and installation currenlty works just in MacOS machines. We are working in having a version that also works in Ubuntu.

## Installation and SSL compatibility

Sleipnir.jl (and all the libraries in ODINN.jl) use Python dependencies that are handled by CondaPkg.
In order to these dependencies to work in harmony with the Julia package dependencies, we need to set the SSL version inside the Julia session.
This is done internally using `PreferenceTools`, where we manually set `openssl_version=3.4.0` inside CondaPkg.
This configuration is likely to change (and potentially fail) in the future as new releases of dependencies force
to bump the SSL version.
The first time you compile Sleipir, this will install the new conda package in `.CondaPkg/`.
As of version 0.7.1, OGGM data are now preprocessed with [Gungnir](https://github.com/ODINN-SciML/Gungnir). These preprocessed data are saved on a server and Sleipnir downloads them during the first execution on a machine. They are then stored locally in `~/.ODINN/ODINN_prepro/` for the subsequent executions.

0 comments on commit 3132628

Please sign in to comment.