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
COMMANDwhichsphinx-build&&sphinx-build-bhtml${CMAKE_SOURCE_DIR}/doc${CMAKE_BINARY_DIR}/docs||echo"Error: sphinx-build not found. Could not generate HTML docs."
Copy file name to clipboardExpand all lines: README.rst
+8-35Lines changed: 8 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,32 +24,31 @@ The main documentation for the software is in the docs folder. After building th
24
24
Dependencies
25
25
------------
26
26
27
-
This depends on Boost and cmake, as well as the usual Python packages. Some additional packages (NetCDF, in particular) will activate optional components of the code if installed. You also need a C++11 compiler. This software is designed to run and work on a variety of operating systems (all Linuxes, Mac OS X, and FreeBSD) and architectures (at least 64-bit x86 and POWER).
27
+
This depends on pybind11 and cmake, as well as the usual Python packages. Some additional packages (NetCDF, in particular) will activate optional components of the code if installed. You also need a C++11 compiler. This software is designed to run and work on a variety of operating systems (all Linuxes, Mac OS X, and FreeBSD) and architectures (at least 64-bit x86 and POWER).
28
28
29
29
Minimum versions:
30
30
31
31
- GCC >= 5.0 or clang >= 3.4
32
-
- Boost >= 1.63
32
+
- pybind11 >= 2.13
33
33
- cmake >= 3.12
34
-
- Python >= 2.7 (although pre-Python-3 support is best-effort)
34
+
- Python >= 3.7 (although pre-Python-3.8 support is best-effort)
35
35
36
36
On Ubuntu/Debian, you can install the non-Python dependencies, including the optional ones, by doing:
If your system defaults to Python 2, but you wish to use Python 3, please do the following:
49
49
50
50
1. Install Python 3 *from the system package manager*
51
-
2. Make sure the python-3 version of the Boost library is installed (on Ubuntu, this is part of the standard boost-python package referenced above)
52
-
3. When you run cmake below, pass ``-DPython_EXECUTABLE=`which python3```
51
+
2. When you run cmake below, pass ``-DPython_EXECUTABLE=`which python3```
53
52
54
53
On any system, this software requires numpy and scipy (hard requirements), plus astropy and healpy (optional).
55
54
@@ -124,7 +123,7 @@ For pre-built wheels hosted on `PyPI`_, available for most Linux x86_64, macOS x
124
123
125
124
pip install spt3g
126
125
127
-
The hosted wheels will include the necessary libraries (Boost, etc) bundled with the package. Otherwise, ensure that the dependency libraries are installed as explained above, and processed to one of the following steps.
126
+
The hosted wheels will include the necessary libraries (flac, etc) bundled with the package. Otherwise, ensure that the dependency libraries are installed as explained above, and processed to one of the following steps.
128
127
129
128
To install the package from the github repo, run ``pip`` as usual (this may take a while, so consider setting the ``CMAKE_BUILD_PARALLEL_LEVEL`` environment variable):
130
129
@@ -174,10 +173,7 @@ Use the ``git archive`` command or the Python ``build`` package to export the so
174
173
Version Control Hygiene
175
174
-----------------------
176
175
177
-
You can use two mechanisms to access the repository: git and SVN. The following is a brief overview of how to use these in a way that your collaborators will appreciate.
178
-
179
-
Git
180
-
===
176
+
The following is a brief overview of how to use git in a way that your collaborators will appreciate.
181
177
182
178
To initially check out the repository:
183
179
@@ -199,26 +195,3 @@ To send your changes back:
199
195
git commit files_to_commit
200
196
git push
201
197
202
-
203
-
SVN
204
-
===
205
-
206
-
To initially check out the repository:
207
-
208
-
.. code-block:: shell
209
-
210
-
svn co https://user@github.com/CMB-S4/spt3g_software/trunk spt3g_software
0 commit comments