Skip to content

Commit

Permalink
Merge pull request #14 from lincc-frameworks/update_intro
Browse files Browse the repository at this point in the history
Update Intro
  • Loading branch information
dougbrn authored May 23, 2024
2 parents 916562d + e2ed168 commit 78efcd6
Showing 1 changed file with 13 additions and 32 deletions.
45 changes: 13 additions & 32 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,43 +13,24 @@ of nested associated datasets. This package wraps the majority of the
Nested-Pandas API with Dask, which enables easy parallelization and capacity
for work at scale.

How to Use This Guide
=====================

Dev Guide - Getting Started
---------------------------
Begin with the :doc:`Getting Started <gettingstarted/installation>`
guide to learn the basics of installation and walkthrough a simple example of
using nested-dask.

Before installing any dependencies or writing code, it's a great idea to create a
virtual environment. LINCC-Frameworks engineers primarily use `conda` to manage virtual
environments. If you have conda installed locally, you can run the following to
create and activate a new environment.
The :doc:`Tutorials <tutorials>`
section showcases the fundamental features of nested-pandas.

.. code-block:: console
The :doc:`Best Practices <gettingstarted/best_practices>` guide provides a few
suggestions to avoid common pitfalls with Nested-Dask (and Dask in general).

>> conda create env -n <env_name> python=3.10
>> conda activate <env_name>
Once you have created a new environment, you can install this project for local
development using the following commands:

.. code-block:: console
>> pip install -e .'[dev]'
>> pre-commit install
>> conda install pandoc
Notes:

1) The single quotes around ``'[dev]'`` may not be required for your operating system.
2) ``pre-commit install`` will initialize pre-commit for this local repository, so
that a set of tests will be run prior to completing a local commit. For more
information, see the Python Project Template documentation on
`pre-commit <https://lincc-ppt.readthedocs.io/en/latest/practices/precommit.html>`_.
3) Installing ``pandoc`` allows you to verify that automatic rendering of Jupyter notebooks
into documentation for ReadTheDocs works as expected. For more information, see
the Python Project Template documentation on
`Sphinx and Python Notebooks <https://lincc-ppt.readthedocs.io/en/latest/practices/sphinx.html#python-notebooks>`_.
API-level information about nested-pandas is viewable in the
:doc:`API Reference <autoapi/index>`
section.

Learn more about contributing to this repository in our :doc:`Contribution Guide <gettingstarted/contributing>`.

.. toctree::
:hidden:
Expand Down

0 comments on commit 78efcd6

Please sign in to comment.