Skip to content

Commit

Permalink
Update python instructions in README
Browse files Browse the repository at this point in the history
  • Loading branch information
tobiashienzsch committed Aug 30, 2024
1 parent a02c25d commit ef29a64
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 23 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

[![Build](https://github.com/tobanteAudio/pffdtd/actions/workflows/build.yml/badge.svg)](https://github.com/tobanteAudio/pffdtd/actions/workflows/build.yml)

> [!WARNING]
> Forked from github.com/bsxfun/pffdtd and updated to C++ & CMake (CPU only currently).
![PFFDTD Screenshot](./doc/screenshot.png)

PFFDTD is an implementation of finite-difference time-domain (FDTD) simulation for 3D room acoustics, which includes an accompanying set of tools for simulation setup and processing of input/output signals. This software is intended for research use with powerful workstations or single-node remote servers with one or more Nvidia GPUs (using CUDA). PFFDTD was designed be "pretty fast" when run on GPUs – at least for FDTD simulations (the name is mostly intended as a pun).

> [!NOTE]
> Forked from github.com/bsxfun/pffdtd and updated to C++ & CMake (CPU only currently).
## Features

- Multi-GPU-accelerated execution (with CUDA-enabled Nvidia GPUs)
Expand All @@ -28,8 +28,12 @@ PFFDTD is designed to run on Linux & macOS systems.

### Installation (Python)

PFFDTD requires at least Python 3.9 to run, with additional required packages in pip_requirements.txt (for pip) or
conda_pffdtd.yml (for conda). Conda (or miniconda) is recommended to get started with a PFFDTD-specific conda environment (see .yml file).
PFFDTD requires at least Python 3.11 to run, with additional required packages in `pyproject.toml`

```shell
pip install --verbose -e .[dev]
pip install --verbose -e .[test]
```

### Installation (C/CUDA)

Expand Down
18 changes: 0 additions & 18 deletions requirements.txt

This file was deleted.

0 comments on commit ef29a64

Please sign in to comment.