Skip to content

Commit

Permalink
revise intro
Browse files Browse the repository at this point in the history
  • Loading branch information
dougbrn committed May 13, 2024
1 parent b3b4d99 commit 935cdce
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 35 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# nested-pandas
Efficient pandas representation for nested associated datasets.
An extension of pandas for efficient representation of nested
associated datasets.

Nested-Pandas extends the [pandas](https://pandas.pydata.org/) package with
tooling and support for nested dataframes packed into values of top-level
dataframe columns. [Pyarrow](https://arrow.apache.org/docs/python/index.html)
is used intrinsically to aid in scalability and performance.
is used internally to aid in scalability and performance.

![image](./nestedframe.png)

Expand Down
51 changes: 20 additions & 31 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,45 +2,34 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to nested-pandas's documentation!
========================================================================================
Nested-Pandas
=============

Dev Guide - Getting Started
---------------------------
An extension of pandas for efficient representation of nested
associated datasets.

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.
Nested-Pandas extends the [pandas](https://pandas.pydata.org/) package with
tooling and support for nested dataframes packed into values of top-level
dataframe columns. [Pyarrow](https://arrow.apache.org/docs/python/index.html)
is used internally to aid in scalability and performance.

.. code-block:: console
![image](../nestedframe.png)

>> conda create env -n <env_name> python=3.10
>> conda activate <env_name>
How to Use This Guide
=====================

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

Once you have created a new environment, you can install this project for local
development using the following commands:
The :doc:`Tutorials <tutorials>`_
section showcases the fundamental features of nested-pandas.

.. 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
4 changes: 2 additions & 2 deletions docs/notebooks.rst → docs/tutorials.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Notebooks
Tutorials
========================================================================================

.. toctree::

Lower-level interfaces <notebooks/low_level.ipynb>
Lower-level interfaces <tutorials/low_level.ipynb>
File renamed without changes.
File renamed without changes.

0 comments on commit 935cdce

Please sign in to comment.