MitchellAcoustics/Soundscapy

Add from-scratch setup instructions for python novices

Open

#158 opened on May 15, 2026

View on GitHub
 (1 comment) (0 reactions) (1 assignee)Python (12 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (58 stars)
PR merge metrics
 (PR metrics pending)

Description

What would you like to see?

Lots of our users are not familiar with setting up python or virtual environments, causing some particular issues for dealing with the R and python mixed environment issues.

We should add a page to the docs with from-scratch recommended python setup instructions. e.g.

  1. Install a conda environment manager (mamba)
  2. Install an IDE such as vs code
  3. Create a project folder
  4. Create a new conda environment for soundscapy, using mamba
  5. How to open a Jupyter notebook, etc. in the IDE and connect to the conda environment
  6. etc.

Why would this help?

No response

Extra details (optional)

No response

Contributor guide

Research direction
Review the existing documentation and identify the appropriate location for a new section on Python setup. Then write clear, step by step instructions for installing Python via Conda/Mamba, setting up an IDE, creating a virtual environment, and running a Jupyter notebook. Include troubleshooting tips for common issues.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95