Full API documentation

[gjoseph92]

Ah, one day. And it will include example data outputs for handy reference. Maybe even be built with pweave or stitch to make including the outputs of data-based code examples easier.

[dbetchkal]

@gjoseph92 after trying to help a few people get set up to use soundDB, it's apparent that the section "Installing Necessary Packages" in PREREQUISITES.md will not guide most Windows users through to a successful install.

In fact, I tried it on my personal machine this morning and the line conda install pandas=0.18.1 numpy scipy matplotlib jupyter numexpr bottleneck produces the same Unsatisfiable Error that other folks have been getting.

I do have a workaround, but it feels a bit kludgy. I'd be curious about your opinion.

conda update conda
conda install pandas numpy scipy matplotlib jupyter numexpr bottleneck

conda create -n soundDB numpy=1.10 pandas=0.18.1
activate soundDB

pip install --extra-index-url https://gjoseph92.github.io/soundDB/packages/ --extra-index-url https://nationalparkservice.github.io/iyore/packages/ soundDB

pip install ipykernel
python -m ipykernel install --user --name soundDB --display-name "soundDB"

conda list -n soundDB

jupyter notebook

Then within Jupyter I make a notebook using the environment called soundDB. I've been able to import soundDB and Iyore successfully in this way.

[dbetchkal]

Of course for DOI machines we'd have to use:

pip install --cert="%USERPROFILE%\DOIRootCA.cer" --extra-index-url https://gjoseph92.github.io/soundDB/packages/ --extra-index-url https://nationalparkservice.github.io/iyore/packages/ soundDB

pip install --cert="%USERPROFILE%\DOIRootCA.cer" ipykernel

We've successfully got Shan up and running with the above code modified in this way.