Pydre is a Python package, which means it can be installed using a Python package manager. If you are familiar with pip, you can use it to install Pydre as well. However, we recommend using rye for a more robust and isolated environment.
Set up a new Pydre project directory with rye
1. Install Rye
Follow the instructions at rye's official website to install it on your system. You will probably need to restart your terminal after installation.
2. Set up your project directory
Create a new project directory and navigate to it:
mkdir my_pydre_project
cd my_pydre_project
Initialize a Rye project:
rye init
Add Pydre as a dependency:
rye add pydre
3. Install Dependencies
Rye will install pydre and all dependencies in a virtual environment specific to your project. To sync the dependencies, run:
rye sync
4. Verify Installation
Check that Pydre was installed correctly:
python -m pydre.run --help
The first run of python after installing and syncing may take several seconds while the python system prepares the dependencies. You should see the help output showing available command line options.
6. Start Using Pydre
Now you can run Pydre with your project files :
python -m pydre.run -p your_project_file.toml -o results.csv
If you want to try an example project file, follow along with the getting started tutorial.
Troubleshooting
If you encounter any issues:
- Check any error messages in the terminal.
- Verify that your project file is properly formatted.
- If you are still having problems, please open an issue on GitHub.
Setting up pydre with pip
1. Install Python
Ensure you have Python installed on your system. You can download it from python.org.
2. Set up your project directory
Create a new project directory and navigate to it:
mkdir my_pydre_project
cd my_pydre_project
3. Create a virtual environment
Set up a virtual environment to isolate your project dependencies:
python -m venv venv
Activate the virtual environment:
- On Windows:
venv\Scripts\activate - On macOS/Linux:
source venv/bin/activate
4. Install Pydre
Use pip to install Pydre:
pip install pydre
5. Verify Installation
Check that Pydre was installed correctly:
Using rye (or uv)
rye run pydre --help
Using pip
pydre --help
You should see the help output showing available command line options.
Setting up a development environment
If you want to contribute to Pydre or modify its source code, you can set up a development environment. You will need to clone the Pydre repository:
git clone https://github.com/OSUDSL/pydre.git
cd pydre
rye sync
rye test