-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add contribution and installation guides
- Loading branch information
Showing
4 changed files
with
71 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
Getting Started | ||
======================================================================================== | ||
|
||
These pages will help you install and learn the basics of using nested-pandas. If you encounter any issues | ||
we encourage you to open an issue on the | ||
`nested-pandas github repository <https://github.com/lincc-frameworks/nested-pandas/issues>`_. | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
Installing nested-pandas <gettingstarted/installation> | ||
Contribution Guide <gettingstarted/contributing> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
Contribution Guide | ||
================== | ||
|
||
Dev Guide - Getting Started | ||
--------------------------- | ||
|
||
Download code and install dependencies in a conda environment. Run unit tests at the end as a verification that the packages are properly installed. | ||
|
||
.. code-block:: bash | ||
conda create -n nested_pandas_env python=3.11 | ||
conda activate nested_pandas_env | ||
git clone https://github.com/lincc-frameworks/nested-pandas.git | ||
cd nested-pandas/ | ||
pip install . | ||
pip install .[dev] # it may be necessary to use `pip install .'[dev]'` (with single quotes) depending on your machine. | ||
pip install pytest | ||
pytest |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
Installation | ||
============ | ||
|
||
nested-pandas is available to install with pip, using the "nested-pandas" package name: | ||
|
||
.. code-block:: bash | ||
pip install nested-pandas | ||
This will grab the latest release version of nested-pandas from pip. | ||
|
||
Advanced Installation | ||
--------------------- | ||
|
||
In some cases, installation via pip may not be sufficient. In particular, if you're looking to grab the latest | ||
development version of nested-pandas, you should instead build 'nested-pandas' from source. The following process downloads the | ||
'nested-pandas' source code and installs it and any needed dependencies in a fresh conda environment. | ||
|
||
.. code-block:: bash | ||
conda create -n nested_pandas_env python=3.11 | ||
conda activate nested_pandas_env | ||
git clone https://github.com/lincc-frameworks/nested-pandas.git | ||
cd nested-pandas | ||
pip install . | ||
pip install .[dev] # it may be necessary to use `pip install .'[dev]'` (with single quotes) depending on your machine. | ||
The ``pip install .[dev]`` command is optional, and installs dependencies needed to run the unit tests and build | ||
the documentation. The latest source version of nested-pandas may be less stable than a release, and so we recommend | ||
running the unit test suite to verify that your local install is performing as expected. | ||
|
||
.. code-block:: bash | ||
pip install pytest | ||
pytest |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters