Skip to content

Commit 574a827

Browse files
a few more cleanup things
1 parent 5ec7858 commit 574a827

4 files changed

Lines changed: 19 additions & 136 deletions

File tree

.gitattributes

Lines changed: 0 additions & 120 deletions
This file was deleted.

INSTALL

Lines changed: 0 additions & 3 deletions
This file was deleted.

INSTALL.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
See the installation guide in the documentation for the most up-to-date instructions on
2+
how to install EXP:
3+
https://exp-docs.readthedocs.io/en/latest/intro/install.html
4+
15
# Configuring and building EXP
26

37
EXP uses CMake for building a configuration.

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,28 @@
44
[![Documentation](https://readthedocs.org/projects/exp-docs/badge/?version=latest)](https://exp-docs.readthedocs.io/)
55
[![DOI](https://joss.theoj.org/papers/10.21105/joss.07302/status.svg)](https://doi.org/10.21105/joss.07302)
66

7+
EXP is a Basis Function Expansion C++ library and Python package for running N-body galactic simulations and dynamical discovery.
78

89
## Repo organization
910

10-
| Files | Description |
11+
| Directory | Description |
1112
| --- | --- |
12-
| README | This file |
13-
| TODO | Wish list of features to add, things to fix, big and small |
14-
| include | Include file for all common classes |
15-
| src | Source for nbody code |
13+
| Paper | The JOSS paper for EXP |
14+
| cmake | Helpers for `cmake` installation process |
15+
| doc | The doxygen documentation for EXP |
16+
| expui | Source for standalone classes used by Python wrappers and other standalone utilities |
1617
| exputil | The main EXP function and class library used by both pyEXP and EXP |
17-
| coefs | Source for standalone classes used by Python wrappers and other standalone utilities |
18+
| extern | The directory for external code needed for installation |
19+
| include | Include file for all common classes |
1820
| pyEXP | Source for Python wrappers |
21+
| src | Source for nbody code |
22+
| tests | An assortment of automatic tests for EXP |
1923
| utils | Older but still useful standalone C++ utilities |
2024

2125
## Version reporting
2226

2327
EXP automatically stashes its compile time, git branch, and git commit
24-
hash when `make` is invoked in the src directory. You can see this
28+
hash when `make` is invoked in the src directory (e.g. as part of the `cmake` installation). You can see this info using `pyEXP` using the `pyEXP.util.getVersionInfo()` command. You can also see this
2529
info using the -v flag, i.e. `mpirun -np 1 exp -v` or `exp -v`. Note:
2630
some MPI implementations require the MPI-aware executable to be run
2731
using 'mpirun'. Some recent HPC systems using `slurm` require the use
@@ -30,7 +34,7 @@ resource request.
3034

3135
## Compile hints
3236

33-
See INSTALL.md for a brief synposis.
37+
See INSTALL.md for a brief synposis and pointers to more detailed information.
3438

3539
A few quick additional notes. By default, both the n-body code and the
3640
Python bindings, the pyEXP interface, will be compiled by default.
@@ -54,7 +58,7 @@ We are developing two repositories of examples and tutorials:
5458
| EXP-examples | Each subdirectory contains a full set of body files and configurations to run EXP with with model galaxy |
5559
| pyEXP-examples | Tutorials and example workflows for a variety of envisioned use cases |
5660

57-
Both of these are available from the origin as EXP.
61+
Both of these are available from the [origin as EXP](https://github.com/EXP-code).
5862

5963
## pyEXP
6064

@@ -94,11 +98,9 @@ To provide some context, suppose you want to read some snapshots, make some coef
9498
5. 'newcoefs' and 'disk' can then be passed to the FieldGenerator to provide density, potential, force fields, etc. for the each principal signal
9599

96100
This is only one example of many possible uses. There are many
97-
variants to this work flow, of course, and I expect that you will
101+
variants to this work flow, of course, and we expect that you will
98102
invent some interesting ones.
99103

100104
## Citation
101105

102-
If you use EXP in your research, please cite the following paper:
103-
104-
[![DOI](https://joss.theoj.org/papers/10.21105/joss.07302/status.svg)](https://doi.org/10.21105/joss.07302)
106+
If you use EXP in your research, please cite the [JOSS paper](https://doi.org/10.21105/joss.07302), and consider including other papers from the list in CITATIONS.bib.

0 commit comments

Comments
 (0)