Update the documentation

[John-Ragland]

One thing that would be really nice to have are better documented tutorials.

We could do this in markdown in the docs, or by creating jupyter notebooks. I'm open to either.

If we create tutorials with jupyter, it would be really nice to do binder integration!

[John-Ragland]

It would also be nice to have a section in the docs for setting up a development environment.

[John-Ragland]

It would also be nice to have a section in the docs for setting up a development environment.

For setting up the development environment, we could create a setup_dev.py script that does everything we need to setup of the development environment. If I understand correctly, this would be

• create the _ooipy_version module that is created in the setup.py file
• install all of the dependancies (we could do this with pip)

@anishdixit-uw could you play around with creating this script, along with writing a section in the docs about how to set up the environment? I think this would fit well in the installation documentation

[anishdixit-uw]

Hey @John-Ragland , sounds like a good plan. I am thinking we can also have it be a shell script, like setup_dev.sh?

Then we can just put in commands to:

1. conda install dependencies
2. Run setup.py to create the _ooipy_version module
3. Run the conda develop ooipy step
4. Test the installation

Prior to these, we can put in instructions to setup a conda environment in the documentation as well.

Let me know what you think of this!

[John-Ragland]

Seems like a good plan to me

[John-Ragland]

#139

[John-Ragland]

I'm going to close this issue and create a new issue for the feature request of adding binder for something to do in the future.