Update installation notes, increment version number to 0.0.2

README.md

@@ -17,7 +17,7 @@ The [Start Here - Twin Paradox
 tutorial](https://kurtamohler.github.io/spacetimelib/notebooks/Twin%20Paradox.html)
 page is a good starting point to see what SpacetimeLib can do.
 
-## Install
+## Installation
 
 ### Pip
 
@@ -47,3 +47,14 @@ Then install SpacetimeLib.
 ```bash
 pip install -e .
 ```
+
+## How to import SpacetimeLib
+
+To access SpacetimeLib, import it into your Python code:
+
+```python
+>>> import spacetimelib as st
+```
+
+Shorten the imported name to `st` for better code readability, but you can just
+use the unshortened name if you want.

doc/source/conf.py

@@ -7,7 +7,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'SpacetimeLib'
-copyright = '2022, Kurt Mohler'
+copyright = '2022-2023, Kurt Mohler'
 author = 'Kurt Mohler'
 release = '0.0.0'
 

doc/source/installation.md

@@ -1,22 +1,29 @@
 # Installation
 
-## Install from source
+## Pip
 
-Install Miniconda: [instructions](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html)
+```bash
+pip install spacetimelib
+```
+
+## From source
+
+Install Miniconda:
+[instructions](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html)
 
-Clone the repository.
+Clone SpacetimeLib the repository.
 
 ```bash
-git clone https://github.com/kurtamohler/spacetimelib.git && cd spacetimelib
+https://github.com/kurtamohler/spacetimelib.git && cd spacetimelib
 ```
 
-Create conda environment.
+Run the following to create and activate an environment with all dependencies.
 
 ```bash
 conda env create -f environment.yaml -n spacetimelib && conda activate spacetimelib
 ```
 
-Install SpacetimeLib.
+Then install SpacetimeLib.
 
 ```bash
 pip install -e .

pyproject.toml

@@ -10,7 +10,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "spacetimelib"
-version = "0.0.1"
+version = "0.0.2"
 authors = [
   { name="Kurt Mohler", email="kurtamohler@gmail.com" },
 ]

setup.py

@@ -12,7 +12,7 @@
 
 name = 'spacetimelib'
 version = '0.0'
-release = '0.0.1'
+release = '0.0.2'
 
 setup(
     name=name,
@@ -22,7 +22,7 @@
     author='Kurt Mohler',
     author_email='kurtamohler@gmail.com',
     url='https://github.com/kurtamohler/spacetimelib',
-    # license=license,
+    license=license,
     packages=['spacetimelib'],
     cmdclass=cmdclass,
     # these are optional and override conf.py settings