Skip to content

Commit 1c340af

Browse files
committed
update build docs
1 parent 186d41c commit 1c340af

File tree

4 files changed

+54
-34
lines changed

4 files changed

+54
-34
lines changed

source/user/guides/compile.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,39 @@
11
Compile
22
=======
3+
4+
To compile Xara from source, follow these steps:
5+
6+
1. Download the source repository to your computer by running:
7+
8+
.. code-block:: bash
9+
10+
git clone https://github.com/peer-open-source/xara
11+
cd xara
12+
13+
2. Create an `Anaconda environment <https://www.anaconda.com/>`__ and install the following packages:
14+
15+
.. tabs::
16+
.. tab:: MacOS / Linux
17+
18+
.. code-block:: bash
19+
20+
conda install -c conda-forge fortran-compiler cxx-compiler c-compiler openblas openmpi
21+
22+
.. tab:: Windows
23+
24+
.. code-block:: bash
25+
26+
conda install -c conda-forge cmake ninja ifx_win-64 mkl-devel conda-forge/label/mkl_rc::blas
27+
28+
.. note::
29+
30+
On Windows, make sure to install Visual Studio with the *"Desktop development with C++"* workload.
31+
32+
33+
3. Finally, with this environment activated, install the package with ``pip`` from inside the *xara/* directory created in step 1:
34+
35+
.. code-block:: bash
36+
37+
python -m pip install -e .
38+
39+

source/user/guides/develop.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Develop
2+
=======
3+
4+
1. Set up a development environment by following the instructions in :ref:`compile <user/guides/compile>`.
5+
2. Install build dependencies by running:
6+
7+
.. code-block:: bash
8+
9+
python -m pip install amoeba-build
10+

source/user/guides/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ For a great guide to Tcl programming, see `this <https://antirez.com/articoli/tc
99

1010
install
1111
compile
12+
develop
1213
conventions
1314
signatures
1415
references

source/user/guides/install.rst

Lines changed: 6 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -12,39 +12,11 @@ To install *xara* on Linux and new Macs, run the following command from your she
1212
1313
python -m pip install xara
1414
15+
Installing with ``pip`` is supported on the following platforms:
1516

16-
On Windows and Macs with Intel processors, it is best to install from source. This takes only two additional steps:
17-
18-
1. Download the source repository to your computer by running:
19-
20-
.. code-block:: bash
21-
22-
git clone https://github.com/peer-open-source/xara
23-
cd xara
24-
25-
2. Create an `Anaconda environment <https://www.anaconda.com/>`__ and install the following packages:
26-
27-
.. tabs::
28-
.. tab:: MacOS / Linux
29-
30-
.. code-block:: bash
31-
32-
conda install -c conda-forge fortran-compiler cxx-compiler c-compiler openblas openmpi
33-
34-
.. tab:: Windows
35-
36-
.. code-block:: bash
37-
38-
conda install -c conda-forge cmake ninja ifx_win-64 mkl-devel conda-forge/label/mkl_rc::blas
39-
40-
.. note::
41-
42-
On Windows, make sure to install Visual Studio with the *"Desktop development with C++"* workload.
43-
44-
45-
3. Finally, with this environment activated, install the package with ``pip`` from inside the *xara/* directory created in step 1:
46-
47-
.. code-block:: bash
48-
49-
python -m pip install -e .
17+
- Linux
18+
- MacOS with Apple Silicon (M1, M2, etc.)
19+
- Windows
5020

21+
On older Macs with Intel processors, it is best to install from source.
22+
Please refer to the :ref:`compile <user/guides/compile>` guide for detailed instructions.

0 commit comments

Comments
 (0)