Skip to content

Commit

Permalink
extend documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
marinaevers committed Jul 1, 2024
1 parent e88dc8b commit 542e27f
Show file tree
Hide file tree
Showing 5 changed files with 67 additions and 11 deletions.
7 changes: 6 additions & 1 deletion docs/changelog.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
=========
Changelog
=========

0.1
-----
---
Features in first version:

* Uncertainty-aware Principle Component Analysis
* Uncertainty-aware Multi-dimensional Scaling
* Basic visualizations:
Expand Down
4 changes: 4 additions & 0 deletions docs/examples.rst
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
========
Examples
========

Examples go here
15 changes: 6 additions & 9 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,13 @@ UADAPy - Uncertainty-aware Data Analysis in Python
UADAPy is a Python library to support an easy analysis of uncertain data. Here you find the most important information to get started.

.. toctree::
:maxdepth: 2
:maxdepth: 1

Changelog :doc:`changelog.rst`
Installation :doc:`installation.rst`
Examples :doc:`examples.rst`
changelog.rst
installation.rst
examples.rst

Indices and tables
==================
.. toctree::
:maxdepth: 2

* :ref:`genindex`
* :ref:`modindex`
* :ref:`genindex`
* :ref:`modindex`
4 changes: 3 additions & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@ Installation
============
Installation via pip
--------------------

You can install the library by typing:
.. code-block:: bash

.. code-block:: console
pip install git+https://github.com/UniStuttgart-VISUS/uadapy
Expand Down
48 changes: 48 additions & 0 deletions examples/dimensionalityReduction.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
{
"cells": [
{
"cell_type": "code",
"execution_count": null,
"id": "initial_id",
"metadata": {
"collapsed": true,
"is_executing": true
},
"outputs": [],
"source": [
"import uadapy"
]
},
{
"cell_type": "code",
"execution_count": null,
"outputs": [],
"source": [],
"metadata": {
"collapsed": false
},
"id": "11bfe50ff5bc1eb0"
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 2
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython2",
"version": "2.7.6"
}
},
"nbformat": 4,
"nbformat_minor": 5
}

0 comments on commit 542e27f

Please sign in to comment.