OMUSE stands for Oceanographic MUltipurpose Software Environment. It is a package to conduct numerical experiments in oceanography and other Earth sciences.
What is this repository for?
This repository contains the source tree for OMUSE.
How do I get set up?
Easiest way is to use a pip developer install:
- setup a python environment, e.g. using virtualenv, and activate it.
- optionally (see instructions below) first do a develop install of AMUSE,
- clone the OMUSE repository:
git clone https://github.com/omuse-geoscience/omuse,
- go into the source directory
cd omuseand set the environment variable
- now, do
pip install -e .from the root of the package
python setup.py build_codes --inplaceto build the codes.
- the file
build.logwill report any errors in the build process.
The community codes of OMUSE can be build manually by going into each directory:
and typing: first
make download (for some) and then
OMUSE has been tested on OSX and linux machines, with ifort and gfortran compilers, on desktop machines and on the Carthesius supercomputer.
In addition to the AMUSE dependencies, OMUSE needs/ can use the following packages:
- matplotlib basemap
- netCDF and netCDF for fortran and the python bindings
AMUSE developer install
OMUSE depends on the "amuse-framework" package, and the instructions above will install this automatically from pypi. If you want to also have a developer install (from the repository source) for AMUSE you should take care that you install the amuse-framework package:
- clone the AMUSE repository:
git clone https://github.com/amusecode/amuse
- go into the amuse-framework package directory:
- do the developer install from here:
pip install -e .
Issues can be reported at the OMUSE issue tracker; for framework issues, report them at the AMUSE repository.
Contributions are welcome. Note that most framework development happens at the AMUSE repository A primer for writing code interfaces and other documentation can be found on the amuse website (www.amusecode.org).