Landscape Analysis

A "landscape analysis" is an informational survey of existing software and other tooling that solve similar problems or use similar technologies. This repository performs landscape analyses for specific projects.

Installation

Please use Python poetry to run and install related content.

# after installing poetry, create the environment
poetry install

Development

Jupyter Lab

Please follow installation steps above and then use a relevant Jupyter environment to open and explore the notebooks under the notebooks directory.

# after creating poetry environment, run jupyter
poetry run jupyter lab

Poe the Poet

We use Poe the Poet to define and run tasks defined within pyproject.toml under the section [tool.poe.tasks*]. This allows for the definition and use of a task workflow when implementing multiple procedures in sequence.

For example, use the following to run the cytomining_ecosystem task:

# run cytomining_ecosystem using poethepoet
poetry run poe cytomining_ecosystem_fall_2023

Reports and GitHub Pages

We use a GitHub Pages URL at https://wayscience.github.io/software-landscape-analysis/ to help share data analysis reports with others. For example, Plotly HTML exports can be added to the relevant location and shared via a link. Contents under the /docs directory is used as a reference for GitHub Actions-based deployments which occur automatically on merge with the main branch.