Skip to content

Commit

Permalink
Add minor doc updates (#96)
Browse files Browse the repository at this point in the history
- Add CDAT logo
- Update text and titles
- Add assumption of working knowledge of xarray
- Remove outdated history entry
  • Loading branch information
tomvothecoder authored Aug 23, 2021
1 parent bcb3e0c commit c9d0529
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 8 deletions.
4 changes: 1 addition & 3 deletions HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,5 @@
History
=======

0.1.0 (2021-04-02)
0.1.0 (2021-09-30)
------------------

* First release on Anaconda.
Binary file added docs/_static/cdat_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
Getting Started
===============

This package assumes you have a working knowledge of xarray.

Installation
------------
Expand All @@ -19,11 +20,10 @@ To install xCDAT using Conda, run:
This is the preferred method to install xCDAT, as it will always install the most recent stable release.

If you don't have Conda installed, this `Miniconda installation guide`_ can walk you through the process.
If you don't have Conda installed, follow the `Miniconda installation guide`_.

.. _Miniconda installation guide: https://docs.conda.io/en/latest/miniconda.html


From sources
============

Expand Down
11 changes: 8 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
xCDAT: xarray Extended with Climate Data Analysis Tools
xCDAT: Xarray Extended with Climate Data Analysis Tools
=======================================================

**xCDAT** is an open source Python package built on `xarray <https://xarray.pydata.org/en/stable/>`_ and serves as the successor to `CDAT <https://github.com/CDAT/cdat>`_.
**xCDAT** is an open-source Python package built on `xarray <https://xarray.pydata.org/en/stable/>`_ for climate data analysis. It serves as the spiritual successor to `CDAT <https://github.com/CDAT/cdat>`_.

.. image:: _static/xarray_logo.png
:target: https://xarray.pydata.org/en/stable
:width: 400
:width: 200
:alt: xarray

.. image:: _static/cdat_logo.png
:target: https://cdat.llnl.gov/
:width: 200
:alt: CDAT

.. toctree::
:maxdepth: 2
:hidden:
Expand Down

0 comments on commit c9d0529

Please sign in to comment.