diff --git a/docs/index.rst b/docs/index.rst index 6e63989f..dfa68d25 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -85,6 +85,7 @@ Suggested citation: installation/mac_and_linux.md installation/windows.md + installation/from_yml.md installation/jupyter.md installation/google_colab.md installation/contributors.md diff --git a/docs/installation/from_yml.md b/docs/installation/from_yml.md new file mode 100644 index 00000000..9936da9e --- /dev/null +++ b/docs/installation/from_yml.md @@ -0,0 +1,8 @@ +## Create a conda environment from the included yml file +We provide a .yml file that allows a user to re-create a working conda environment for a specific version of OpenSoundscape. This can be useful if you get errors because of changes within dependencies, or if you get package conflicts. + +* download the `opensoundscape.yml` file from GitHub +* Install Anaconda if you don't already have it. + * Download the installer [here](https://www.anaconda.com/products/individual), or + * follow the [installation instructions](https://docs.anaconda.com/anaconda/install/) for your operating system. +* Create the conda environment from the file by running `conda env create -f opensoundscape.yml` in the command line. \ No newline at end of file diff --git a/opensoundscape.yml b/opensoundscape.yml new file mode 100644 index 00000000..7cc5e7a5 --- /dev/null +++ b/opensoundscape.yml @@ -0,0 +1,295 @@ +name: opensoundscape_v0-11-0 +channels: + - defaults +dependencies: + - astroid=2.14.2=py39hca03da5_0 + - ca-certificates=2023.05.30=hca03da5_0 + - colorama=0.4.6=py39hca03da5_0 + - dill=0.3.7=py39hca03da5_0 + - isort=5.9.3=pyhd3eb1b0_0 + - lazy-object-proxy=1.6.0=py39h1a28f6b_0 + - libcxx=14.0.6=h848a8c0_0 + - libffi=3.4.2=hc377ac9_4 + - mccabe=0.7.0=pyhd3eb1b0_0 + - ncurses=6.3=h1a28f6b_3 + - openssl=1.1.1v=h1a28f6b_0 + - pip=22.1.2=py39hca03da5_0 + - pylint=2.16.2=py39hca03da5_0 + - python=3.9.13=hbdb9e5c_1 + - readline=8.1.2=h1a28f6b_1 + - sqlite=3.39.2=h1058600_0 + - tk=8.6.12=hb8d0fd4_0 + - tomli=2.0.1=py39hca03da5_0 + - xz=5.2.5=h1a28f6b_1 + - zlib=1.2.12=h5a0b063_3 + - pip: + - aiohappyeyeballs==2.4.0 + - aiohttp==3.10.5 + - aiosignal==1.3.1 + - alabaster==0.7.16 + - annotated-types==0.7.0 + - anyio==4.4.0 + - appdirs==1.4.4 + - appnope==0.1.4 + - argon2-cffi==23.1.0 + - argon2-cffi-bindings==21.2.0 + - arrow==1.3.0 + - aru-metadata-parser==0.1.0 + - asttokens==2.4.1 + - async-lru==2.0.4 + - async-timeout==4.0.3 + - attrs==24.2.0 + - audioread==3.0.1 + - babel==2.16.0 + - backcall==0.2.0 + - beautifulsoup4==4.12.3 + - birdsong-recognition-dataset==0.3.2.post1 + - black==24.3.0 + - bleach==6.1.0 + - build==1.2.1 + - cachecontrol==0.14.0 + - cachy==0.3.0 + - certifi==2024.7.4 + - cffi==1.17.0 + - cfgv==3.4.0 + - charset-normalizer==3.3.2 + - cleo==2.1.0 + - click==8.1.7 + - comm==0.2.2 + - commonmark==0.9.1 + - configparser==6.0.0 + - contextlib2==21.6.0 + - contourpy==1.2.1 + - crashtest==0.4.1 + - crowsetta==5.0.1 + - cycler==0.12.1 + - debugpy==1.8.5 + - decorator==5.1.1 + - defusedxml==0.7.1 + - deprecated==1.2.14 + - distlib==0.3.8 + - docker-pycreds==0.4.0 + - docopt==0.6.2 + - docutils==0.20.1 + - dulwich==0.21.5 + - entrypoints==0.4 + - evfuncs==0.3.5.post1 + - exceptiongroup==1.2.2 + - executing==2.0.1 + - fastjsonschema==2.20.0 + - filelock==3.15.4 + - fonttools==4.53.1 + - fqdn==1.5.1 + - frozenlist==1.4.1 + - fsspec==2024.6.1 + - gitdb==4.0.11 + - gitpython==3.1.43 + - grad-cam==1.5.3 + - h11==0.14.0 + - html5lib==1.1 + - httpcore==1.0.5 + - httpx==0.27.0 + - huggingface-hub==0.22.2 + - identify==2.6.0 + - idna==3.7 + - imageio==2.35.1 + - imagesize==1.4.1 + - importlib-metadata==8.2.0 + - importlib-resources==6.4.3 + - iniconfig==2.0.0 + - installer==0.7.0 + - ipykernel==6.29.5 + - ipympl==0.9.2 + - ipython==8.18.1 + - ipython-genutils==0.2.0 + - ipywidgets==8.1.3 + - isoduration==20.11.0 + - jaraco-classes==3.2.3 + - jedi==0.19.1 + - jinja2==3.1.4 + - joblib==1.4.2 + - json5==0.9.25 + - jsonpointer==3.0.0 + - jsonschema==4.23.0 + - jsonschema-specifications==2023.12.1 + - jupyter==1.0.0 + - jupyter-client==8.6.2 + - jupyter-console==6.6.3 + - jupyter-core==5.7.2 + - jupyter-events==0.10.0 + - jupyter-lsp==2.2.5 + - jupyter-server==2.14.2 + - jupyter-server-terminals==0.5.3 + - jupyterlab==4.2.4 + - jupyterlab-pygments==0.3.0 + - jupyterlab-server==2.27.3 + - jupyterlab-widgets==3.0.11 + - keyring==24.3.1 + - kiwisolver==1.4.5 + - kymatio==0.4.0.dev0 + - lazy-loader==0.4 + - librosa==0.10.2.post1 + - lightning==2.4.0 + - lightning-utilities==0.11.6 + - line-profiler==4.1.2 + - llvmlite==0.43.0 + - lockfile==0.12.2 + - lxml==4.9.3 + - m2r==0.2.1 + - markupsafe==2.1.5 + - matplotlib==3.9.2 + - matplotlib-inline==0.1.7 + - mistune==3.0.2 + - more-itertools==9.0.0 + - mplcursors==0.5.2 + - mpmath==1.3.0 + - msgpack==1.0.8 + - multidict==6.0.5 + - multimethod==1.10 + - mypy-extensions==1.0.0 + - nbclassic==1.0.0 + - nbclient==0.10.0 + - nbconvert==7.16.4 + - nbformat==5.10.4 + - nbsphinx==0.9.5 + - nest-asyncio==1.6.0 + - networkx==3.2.1 + - nodeenv==1.9.1 + - noisereduce==3.0.2 + - notebook==6.5.4 + - notebook-shim==0.2.4 + - numba==0.60.0 + - numpy==1.26.4 + - onnx==1.16.2 + - onnxscript==0.1.0.dev20240823 + - opencv-python==4.10.0.84 + - opensoundscape==0.10.2 + - overrides==7.7.0 + - packaging==24.1 + - pandas==2.2.2 + - pandera==0.19.3 + - pandocfilters==1.5.1 + - parso==0.8.4 + - pathspec==0.12.1 + - pathtools==0.1.2 + - pexpect==4.9.0 + - pickleshare==0.7.5 + - pillow==10.4.0 + - pkginfo==1.10.0 + - platformdirs==4.2.2 + - plotly==5.10.0 + - pluggy==1.5.0 + - poetry==1.8.3 + - poetry-core==1.9.0 + - poetry-plugin-export==1.8.0 + - pooch==1.8.2 + - pre-commit==3.8.0 + - prometheus-client==0.20.0 + - promise==2.3 + - prompt-toolkit==3.0.47 + - protobuf==4.25.4 + - psutil==6.0.0 + - ptyprocess==0.7.0 + - pure-eval==0.2.3 + - py==1.11.0 + - pycparser==2.22 + - pydantic==2.8.2 + - pydantic-core==2.20.1 + - pygments==2.18.0 + - pylev==1.4.0 + - pyparsing==3.1.2 + - pyproject-hooks==1.0.0 + - pyrsistent==0.19.3 + - pytest==8.3.2 + - python-dateutil==2.9.0.post0 + - python-json-logger==2.0.7 + - pytorch-lightning==2.4.0 + - pytz==2024.1 + - pywavelets==1.6.0 + - pyyaml==6.0.2 + - pyzmq==26.1.1 + - qtconsole==5.4.4 + - qtpy==2.4.0 + - rapidfuzz==3.9.1 + - ray==2.2.0 + - recommonmark==0.7.1 + - referencing==0.35.1 + - requests==2.32.3 + - requests-toolbelt==1.0.0 + - resampy==0.4.2 + - rfc3339-validator==0.1.4 + - rfc3986-validator==0.1.1 + - rpds-py==0.20.0 + - safetensors==0.4.3 + - schema==0.7.7 + - scikit-image==0.24.0 + - scikit-learn==1.5.1 + - scipy==1.13.1 + - send2trash==1.8.3 + - sentry-sdk==2.13.0 + - setproctitle==1.3.3 + - setuptools==72.2.0 + - setuptools-scm==8.0.4 + - shellingham==1.5.0 + - shortuuid==1.0.11 + - simplekml==1.3.6 + - six==1.16.0 + - smmap==5.0.1 + - sniffio==1.3.1 + - snowballstemmer==2.2.0 + - soundfile==0.12.1 + - soupsieve==2.6 + - soxr==0.4.0 + - sphinx==7.4.7 + - sphinx-copybutton==0.5.2 + - sphinx-rtd-theme==2.0.0 + - sphinxcontrib-applehelp==2.0.0 + - sphinxcontrib-devhelp==2.0.0 + - sphinxcontrib-htmlhelp==2.1.0 + - sphinxcontrib-jquery==4.1 + - sphinxcontrib-jsmath==1.0.1 + - sphinxcontrib-qthelp==2.0.0 + - sphinxcontrib-serializinghtml==2.0.0 + - stack-data==0.6.3 + - suntime==1.2.5 + - sympy==1.13.2 + - tenacity==8.1.0 + - tensorflow-macos==2.13.0 + - terminado==0.18.1 + - testpath==0.6.0 + - threadpoolctl==3.5.0 + - tifffile==2024.8.10 + - timm==0.9.16 + - tinycss2==1.3.0 + - tinytag==1.8.1 + - toml==0.10.2 + - tomlkit==0.11.5 + - torch==2.4.0 + - torchaudio==2.3.1 + - torchmetrics==1.4.1 + - torchvision==0.19.0 + - tornado==6.4.1 + - tqdm==4.66.5 + - traitlets==5.14.3 + - trove-classifiers==2023.5.24 + - ttach==0.0.3 + - typeguard==4.3.0 + - types-python-dateutil==2.9.0.20240316 + - typing-extensions==4.12.2 + - typing-inspect==0.9.0 + - tzdata==2024.1 + - uri-template==1.3.0 + - urllib3==2.2.2 + - virtualenv==20.26.3 + - wandb==0.17.7 + - waveform-analysis==0.1 + - wcwidth==0.2.13 + - webcolors==24.8.0 + - webencodings==0.5.1 + - websocket-client==1.8.0 + - werkzeug==3.0.3 + - widgetsnbextension==4.0.11 + - wrapt==1.16.0 + - xattr==1.1.0 + - yarl==1.9.4 + - zipp==3.20.0 \ No newline at end of file