Skip to content

Commit 5431a80

Browse files
committed
Update README to point to the new installation instructions
1 parent 279a069 commit 5431a80

1 file changed

Lines changed: 12 additions & 128 deletions

File tree

README.md

Lines changed: 12 additions & 128 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# AMUSE: The Astrophysical Multipurpose Software Environment
22
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1435860.svg)](https://doi.org/10.5281/zenodo.1435860)
3-
[![PyPI version](https://badge.fury.io/py/amuse.svg)](https://badge.fury.io/py/amuse)
3+
[![Docs](https://readthedocs.org/projects/amuse/badge)](https://amuse.readthedocs.io)
44

55
This repository contains the AMUSE software. With AMUSE you can write
66
scripts to simulate astrophysical problems in different domains.
@@ -16,133 +16,17 @@ and the documentation can be found at:
1616
Getting Started
1717
===============
1818

19-
In short, most probably
19+
AMUSE runs on Linux and macOS, and on Windows using Windows Subsystem for Linux (WSL).
2020

21-
```bash
22-
pip install amuse
23-
```
24-
should get you going if you have a linux or Mac were you compile
25-
codes on (HDF5 and an MPI libraries must be installed).
21+
We're working on getting AMUSE into conda-forge, but in the mean time it needs to be
22+
installed from source. See
23+
[the AMUSE installation
24+
instructions](https://amuse.readthedocs.io/en/latest/install/installing.html) for how to
25+
do that, or if you're reading this locally see the `doc/install/` directory.
2626

27-
Below are some hints for a quick install, if these fail please
28-
look for options at the detailed descriptions of the installation
29-
procedure in the documents in the 'doc/install' directory.
27+
After that, have a look at the [AMUSE
28+
tutorial](https://amuse.readthedocs.io/en/latest/tutorial/index.html) to get started, or
29+
if you prefer notebooks, give the [interactive
30+
tutorial](https://amuse.readthedocs.io/en/latest/interactive_tutorial/index.html) a
31+
try. Those too can be found locally in `doc/`.
3032

31-
Compilers
32-
=========
33-
34-
To build AMUSE from source you need to have a working build
35-
environment. The AMUSE build system needs C/C++ and fortan 90
36-
compilers, we recommend a recent version of GCC.
37-
38-
In Ubuntu you can setup the environment with (as root):
39-
40-
```bash
41-
apt-get install build-essential curl g++ gfortran gettext zlib1g-dev
42-
```
43-
44-
Other distributions have similar package or package groups available.
45-
46-
In macOS you can use the homebrew or macports package manager (both
47-
require the Apple Developer Tools and Xcode to be installed).
48-
49-
For a Windows 10 machine, AMUSE can be installed in the Windows Subsystem
50-
for linux (WSL), and installing e.g. Ubuntu from the Microsoft store.
51-
Its recommended to use WSL 2. For further installation instructions, see the
52-
Linux install instructions.
53-
54-
Python
55-
======
56-
57-
AMUSE needs Python 3 version >=3.7 installed preferably with pip and
58-
virtualenv. It may be necessary to update pip to a recent version.
59-
If you cannot use Python 3, legacy support for Python 2 is available in the
60-
AMUSE 12 release and the python2 branch.
61-
62-
Installing Prerequisites
63-
========================
64-
65-
The following libraries need to be installed:
66-
67-
* HDF (version 1.6.5 - 1.12.x)
68-
* MPI (OpenMPI or MPICH)
69-
70-
The following are needed for some codes:
71-
* FFTW (version >= 3.0)
72-
* GSL
73-
* CMake (version >= 2.4)
74-
* GMP (version >= 4.2.1)
75-
* MPFR (version >= 2.3.1)
76-
77-
Installing+building AMUSE
78-
=========================
79-
80-
AMUSE can be installed through pip:
81-
82-
```bash
83-
pip install [--user] amuse
84-
```
85-
86-
This will build and install AMUSE with an extensive set of codes.
87-
If necessary this will also install some required Python packages:
88-
89-
* Numpy (version >= 1.3.0)
90-
* h5py (version >= 1.2.2)
91-
* mpi4py (version >= 1.1.0)
92-
* pytest (version >= 5.0)
93-
* docutils (version >= 0.6)
94-
95-
If you are not using pip these must be installed by hand.
96-
97-
It is possible to install the minimal framework by:
98-
99-
```bash
100-
pip install [--user] amuse-framework
101-
```
102-
103-
This does not include any codes. These can be added
104-
```bash
105-
pip install [--user] amuse-<code name>
106-
```
107-
108-
AMUSE Development
109-
=================
110-
111-
An AMUSE development install can also be handled through pip by executing (in the root of a clone of the
112-
repository)
113-
114-
```bash
115-
pip install -e .
116-
```
117-
118-
after this the codes need to be build:
119-
120-
```bash
121-
python setup.py develop_build
122-
```
123-
124-
Running the tests
125-
=================
126-
AMUSE comes with a large set of tests, most can be run automatically.
127-
To run these tests start the py.test command from the main
128-
amuse directory (directory this README file lives in).
129-
130-
To run these tests do:
131-
132-
1. install the tests
133-
134-
```bash
135-
pip install [--user] amuse-tests
136-
```
137-
(this will install all tests whether or not you have installed the full amuse package)
138-
139-
2. Run the automatic tests
140-
141-
```bash
142-
pytest --pyargs -v amuse.test.suite
143-
```
144-
you can also just run the tests for the specific packages you have installed e.g.
145-
```bash
146-
pytest --pyargs amuse.test.suite.codes_tests.test_huayno
147-
```
148-
you may have to prefix ```mpiexec -n 1 --oversubscribe``` to the pytest command.

0 commit comments

Comments
 (0)