Overview
Wiki managed by Abhinavcode13
PolyPhy is an unconventional toolkit for reconstructing continuous networks out of sparse 2D or 3D data. Such data can be defined as collections of discrete points, or a continuous sparse scalar field. PolyPhy produces a scalar density field that defines the recovered network structure. With the help of GPU-accelerated simulation and visualization, PolyPhy provides domain experts an interactive way to reconstruct discrete geometric data with an underlying network structure. The reconstruction is driven by the Monte Carlo Physarum Machine algorithm, a metaheuristic inspired by the morphology and dynamics of Physarum polycephalum aka 'slime mold'.
- PolyPhy is a successor of Polyphorm
- Main GitHub page: PolyPhy Hub
- Official website: polyphy.io
- Underlying research: overview and publications
- Email list: Google Groups
- Decent GPU, recommended a mid-range discrete NVIDIA/AMD device
- currently running best on NVIDIA GPUs, other vendors supported as well (subject to the current capabilities of the Taichi API)
- CPU fallback available for debugging purposes
- Corresponding GPU environment and drivers (e.g. Vulkan, Metal)
- Recent Windows, Linux or Mac OS
- Python 3.x, Anaconda recommended
The main repository is located at the following GitHub URL:
https://github.com/PolyPhyHub/PolyPhy.git
The other repositories are linked from the following "org" page:
https://github.com/PolyPhyHub/
Please note the project is currently undergoing refactoring in order to streamline the use of the software in CLI, improve its modularity (making it easier to implement custom pipelines and extend the existing ones), and add new features (such as the recent addition of batch mode).
To install PolyPhy, clone this repository, open a Python console, navigate to the root of the repo, and run
pip install -r requirements.txt
Afterwards, navigate to ./src/polyphy and run
python polyphy.py 2d_discrete -f "data/csv/sample_2D_linW.csv" -t 1440
for the standard 2D pipeline using the provided sample 2D dataset and max trace resolution of 1440 (which will also determine the window resolution), or
python polyphy.py 3d_discrete -f "data/csv/sample_3D_linW.csv -t 512 -x 1280 -y 720"
to invoke the standard 3D discrete pipeline on sample data, with max trace resolution of 512 and window resolution of 1280x720. You can also specify a custom CSV file (see the sample data for the format details, typically the data are tuples with 2 or 3 spatial coorinates followed by weights for each data point). The functionality of these pipelines is described below.
To display help on the available CLI parameters, simply run the respective command without any arguments.
There is also a number of Jupyter notebooks implementing various experiemtal pipelines (some of which are documented below). These are updated to different degrees, and we are in the process of porting them to the refactored class structure. Updates coming soon.
The use-cases currently supported by PolyPhy are divided according to the data workflow they are built around. Each use case has a corresponding (extensible) pipeline specified as a command line parameter under its name. Experimental pipelines not yet implemented in the main build are located in ./experiments/Jupyter. This section reviews them case by case, and the following section provides an extensive tutorial recorded at the recent OSPO Symposium 2022.
- 2D self-patterning is the most basic use-case implemented within the 2d_discrete pipeline. The ability of MCPM to generate a diversity of patterns with network characteristics is achieved by disabling the data marker deposition, leaving only the MCPM agents to generate the marker responsible for maintaining structure.
- 2D procedural pipeline provide an easy environment to experiment with the behavior of PolyPhy in the presence of discrete data with different spatial frequencies. Editing (adding new data points) is also supported. This is invoked by specifying 2d_discrete pipeline without providing any input data file, thus prompting PolyPhy to generate the data procedurally.
- 2D discrete pipeline implements the canonical way of working with custom data defined by a CSV file. The example below demonstrates fitting to a 2D projection of the SDSS galaxy dataset. It is invoked by specifying 2d_discrete pipeline and a custom input data file.
- 2D continuous pipeline demonstrates the workflow with a continuous user-provided dataset. Instead of a discrete set of points as in the previous use-cases, the data is defined by a scalar field, which in 2D amounts to a grayscale image. The example below approximates the US road network using only a sparse population density map as the input. This pipeline is implemented in the ./experiments/Jupyter/PolyPhy_2D_continuous_data notebook, to be ported to the main build.
- 3D discrete pipeline represents an equivalent functionality to the original Polyphorm implementation. The dataset consists of SDSS galaxies defined as a weighted collection of 3D points. The visualization is based on volumetric ray marching simultaneously fetching the deposit and the trace fields. This pipeline is invoked through the 3d_discrete parameter.
Below is a recording of the PolyPhy Workshop given as part of the OSPO Symposium 2022.
This 90-minute workshop covers PolyPhy's research background, all of the 5 above usecases, and extended technical discussion.
GitHub Actions is being used to test on MacOs as well as Linux. It allows for the automation of the building, testing, and deployment pipline.
A service that generates a visual report of how much code has been tested. All configuration settings can be found in the codecov.yml file.
A service that can be used to test Windows. All configuration settings can be found in the appveyor.yml file.