You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
-42Lines changed: 0 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,13 +7,6 @@
7
7
8
8
*Massive Black-Hole Binary Population Synthesis for Gravitational Wave Calculations ≋●≋●≋*
9
9
10
-
<<<<<<< HEAD
11
-
This package, which is actively under development, is aimed at providing a comprehensive framework for MBH binary population synthesis. The framework includes modules to perform pop synth using a variety of methodologies to get a handle on both statistical and systematic uncertainties. Currently, binary populations can be synthesis based on: cosmological hydrodynamic simulations (Illustris), semi-analytic/semi-empirical models (SAMs), and observational catalogs of local galaxies and/or quasars.
12
-
13
-
## Installation
14
-
15
-
The `holodeck` framework is currently under substantial, active development. It will not be available on `pypi` (`pip`) or via `conda` install until it has stabilized. Currently `holodeck` requires `python >= 3.8`, and tests are run on versions `3.8`, `3.9`, `3.10`.
This package provides a comprehensive framework for MBH binary population synthesis. The framework includes modules to perform population synthesis using a variety of methodologies from semi-analytic models, to cosmological hydrodynamic simulations, and even observationally-derived galaxy merger catalogs.
@@ -28,7 +21,6 @@ This package provides a comprehensive framework for MBH binary population synthe
28
21
## Installation
29
22
30
23
The `holodeck` framework is currently under substantial, active development. Stable versions are now available with `pip install holodeck-gw` (see [holodeck on pypi](https://pypi.org/project/holodeck-gw)). However, recent versions and many development tools will not generally be available with ``pip`` or ``conda`` install.
31
-
>>>>>>> dev
32
24
33
25
`holodeck` requires ``python >= 3.9`` (with support for: ``3.9, 3.10, 3.11``). The recommended installation is:
34
26
@@ -92,46 +84,12 @@ For some scripts (particularly for generating libraries), an MPI implementation
92
84
93
85
## Documentation
94
86
95
-
<<<<<<< HEAD
96
-
The primary sources of documentation for `holodeck` are this `README.md` file, the notebooks included in the `notebooks/` directory, and docstrings included in the source code directly. [`readthedocs` documentation](https://readthedocs.org/projects/holodeck-gw) are being written and improved, and a methods paper is in preparation.
97
-
98
-
## Contributing
99
-
100
-
This project is being led by the [NANOGrav](http://nanograv.org/) Astrophysics Working Group.
101
-
102
-
Details on contributions and the mandatory code of conduct can be found in the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
103
-
104
-
To-do items and changes to the API should be included in the [CHANGELOG.md](./CHANGELOG.md) file.
105
-
106
-
Contributions are not only welcome but encouraged, anywhere from new modules/customizations to bug-fixes to improved documentation and usage examples. The git workflow is based around a `main` branch which is intended to be (relatively) stable and operational, and an actively developed `dev` branch. New development should be performed in "feature" branches (made off of the `dev` branch), and then incorporated via pull-request (back into the `dev` branch).
107
-
108
-
### Testing:
109
-
110
-
(Unit)tests should be developed in two ways: for basic functions/behaviors, standard unit-tests can be placed in the `holodeck/tests/` directory. More complex functionality should be tested in notebooks (in `notebooks/`) where they can also be used as demonstrations/tutorials for that behavior. The python script `scripts/convert_notebook_tests.py` converts target notebooks into python scripts in the `holodeck/tests/` directory, which can then be run by `pytest`. The script `scripts/tester.sh` will run the conversion script and then run `pytest`.
111
-
112
-
113
-
### Formatting:
114
-
115
-
New code should generally abide by PEP8 formatting, with [`numpy` style docstrings](https://numpydoc.readthedocs.io/en/latest/format.html). Exceptions are:
116
-
117
-
* lines may be broken at either 100 or 120 columns
118
-
119
-
### Notebooks:
120
-
121
-
Please strip all notebook outputs before commiting notebook changes. The [`nbstripout`](https://github.com/kynan/nbstripout) package is an excellent option to automatically strip all notebook output only in git commits (i.e. it doesn't change your notebooks in-place). You can also use `nbconvert` to strip output in place: `jupyter nbconvert --clear-output --inplace <NOTEBOOK-NAME>.ipynb`.
* (2) enable: `nbstripout --install --attributes .gitattributes` (run this in the top-level `holodeck/` directory)
127
-
=======
128
87
Full package documentation for `holodeck` is available on [readthedocs](https://holodeck-gw.readthedocs.io/en/main/).
129
88
130
89
131
90
## Contributing & Development
132
91
133
92
Contributions are not only welcome but encouraged, anywhere from new modules/customizations to bug-fixes to improved documentation and usage examples. Please see [Development & Contributions](https://holodeck-gw.readthedocs.io/en/main/development.html).
0 commit comments