@@ -2,65 +2,82 @@ Installation
22============
33
44Requirements
5- -----------
5+ ------------
66
7- dominosee requires:
7+ DOMINO-SEE requires Python 3.9 or later and the following core dependencies :
88
9- * Python (>=3.9)
10- * xarray
11- * dask
12- * SciPy
13- * numba
14- * netCDF4
9+ * **xarray ** (>=0.20.0) - Multi-dimensional labeled arrays
10+ * **dask ** - Parallel computing
11+ * **numpy ** (>=1.20.0) - Numerical computing
12+ * **scipy ** - Scientific computing
13+ * **numba ** (>=0.55.0) - JIT compilation for performance
14+ * **netCDF4 ** - NetCDF file I/O
15+ * **pandas ** - Data structures
16+ * **cf-xarray ** - CF conventions support
17+ * **bottleneck ** - Fast array operations
18+ * **tqdm ** - Progress bars
1519
20+ All dependencies are automatically installed when you install DOMINO-SEE.
1621
17- Installation
18- -----------
22+ Installation from Source
23+ -------------------------
1924
20- Since dominosee is currently in development, the recommended way to install it is directly from source :
25+ DOMINO-SEE is currently in active development. Install directly from the GitHub repository :
2126
2227.. code-block :: bash
2328
2429 # Clone the repository
25- git clone https://github.com/Hem-W/dominosee-dev .git
26- cd dominosee-dev
30+ git clone https://github.com/PREP-NexT/DOMINO-SEE .git
31+ cd DOMINO-SEE
2732
2833 # Create and activate a conda environment (recommended)
2934 conda env create -f environment.yml
3035 conda activate dominosee
3136
32- # Install the package from source
37+ # Install the package in editable mode
3338 pip install -e .
3439
40+ The conda environment includes Python 3.11 and all required dependencies.
41+
42+ Optional Dependencies
43+ ---------------------
3544
36- Development Installation
37- ~~~~~~~~~~~~~~~~~~~~~~~
45+ Development Tools
46+ ~~~~~~~~~~~~~~~~~
3847
39- For development, install with additional development dependencies:
48+ For contributing to DOMINO-SEE, install development dependencies:
4049
4150.. code-block :: bash
4251
4352 pip install -e " .[dev]"
4453
4554 Documentation
46- ~~~~~~~~~~~~
55+ ~~~~~~~~~~~~~
4756
48- To build the documentation:
57+ To build the documentation locally :
4958
5059.. code-block :: bash
5160
5261 pip install -e " .[docs]"
5362 cd docs
5463 make html
5564
65+ The built documentation will be available in ``docs/build/html/ ``.
66+
5667Verify Installation
57- ------------------
68+ -------------------
5869
59- To verify that dominosee is installed correctly, you can run :
70+ Verify your installation by importing the package :
6071
6172.. code-block :: python
6273
6374 import dominosee
64- print (dominosee.__version__ ) # Should print the version number
75+ print (dominosee.__version__ ) # Should print: 0.0.1
76+
77+ You can also run the test suite to ensure everything works correctly:
78+
79+ .. code-block :: bash
80+
81+ pytest tests/
6582
66- If you don't see any error messages , you're ready to start using dominosee !
83+ If all tests pass , you're ready to use DOMINO-SEE !
0 commit comments