diff --git a/README.md b/README.md index f56379c..3562864 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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) diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 4d89aaa..0000000 --- a/requirements.txt +++ /dev/null @@ -1,18 +0,0 @@ -h5py >= 3.2.1 -matplotlib >= 3.4.1 -mayavi >= 4.7.2 -memory_profiler >= 0.58.0 -numba >= 0.53.0 -numpy >= 1.20.1 -opencv-python >= 4.10.0 -optuna >= 3.6.1 -pandas >= 2.2.2 -plotly >= 5.22.0 -polyscope >= 0.1.6 -psutil >= 5.8.0 -pytest >= 8.2.2 -pytest-cov >= 5.0.0 -resampy >= 0.2.2 -scipy >= 1.7.0 -tqdm >= 4.58.0 -vtk >= 9.0.1