harkness

A python library for generating VR-friendly visualization files from pandas dataframes.

https://github.com/kcollins/harkness

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.9%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

A python library for generating VR-friendly visualization files from pandas dataframes.

Basic Info
  • Host: GitHub
  • Owner: KCollins
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: main
  • Homepage:
  • Size: 2.11 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 2
  • Releases: 6
Created over 2 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License Citation

README.md

PyPI version DOI

harkness

A python library for generating VR-friendly visualization files from pandas dataframes.

Try it in Binder: Binder

Minimum Working Example:

```

Install harkness if needed:

pip install harkness

Import libraries

import pandas as pd from harkness.createply import createply

Generate sample data

data = {'X': [1, 2, 3], 'Y': [4, 5, 6], 'Z': [7, 8, 9], 'C': [10, 20, 30]}

df = pd.DataFrame(data)

Create PLY file

filename = 'example.ply' createply(df, filename, C='C', isverbose=True) ```

How to Use:

  • Identify an appropriate dataframe. You'll want to make sure that your data makes sense in 3D, and select or add a column that makes sense as a colormap. The colormap column can be categorical or numeric.

  • Generate .ply file. Run create_ply() on your dataframe, identifying the columns X, Y, Z, and C (for color).

  • Visualize on desktop. You can use a program like Autodesk MeshMixer or Cloud Compare.

  • Visualize in VR. You can open the resulting file in a VR viewer like VRifier. Any headset that works with SteamVR should work. I use a Valve Index.

Notes and Acknowledgments

Named for Ruth Harkness, who with Quentin Young and Gerald Russell brought the first live giant panda cub to the United States. (For more on this, read her memoir, The Lady and the Panda.) Name chosen because (1) "harkness" did not appear for related topics on a search of pypi, and (2) it's a library for displaying pandas. Some assistance by Google Bard.

If you use this project in your work, please cite it using the Zenodo DOI.

Owner

  • Login: KCollins
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.0.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Collins"
  given-names: "Kristina"
  orcid: "https://orcid.org/0000-0002-3816-1948"
title: "harkness: a Python library for generating .ply files from dataframes"
version: 1.0.0
doi: 10.5281/zenodo.10223765
date-released: 2023-11-29
url: "https://github.com/KCollins/harkness"

GitHub Events

Total
Last Year

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 13 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 3
  • Total maintainers: 1
pypi.org: harkness

A python library for generating VR-friendly visualization files from pandas dataframes.

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 13 Last month
Rankings
Dependent packages count: 10.1%
Average: 38.7%
Dependent repos count: 67.3%
Maintainers (1)
Last synced: 6 months ago

Dependencies

.github/workflows/python-app.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
.github/workflows/python-publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • pypa/gh-action-pypi-publish 27b31702a0e7fc50959f5ad993c78deac1bdfc29 composite
pyproject.toml pypi
  • matplotlib *
  • pandas *
requirements.txt pypi
  • matplotlib *
  • pandas *
  • plotly *