Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

visualacuity

License

This software is available under the GNU General Public License v3.0. See the LICENSE file for more info.

How it works

Much of the behavior for visualacuity is documented in the following spreadsheets, (which are also used for testing the software):

Installation

pip install visualacuity

Example Scripts

Prerequisites

For the example scripts, we'll need to install a few more Python packages: pip install pandas tqdm

Data

Prepare a CSV file with your data. Each row is a "visit," and each column is a field from your EHR. Plus columns will be automatically merged. Example data: (document - no pinhole)

Correction: * Corrected / CC - ... * Uncorrected / SC - ...

Example:

Distance Corrected Left Eye Distance Corrected Left Eye +/- Distance Corrected Right Eye Distance Corrected Right Eye +/-
20/20 +1 20/40 -2
CF HM

Data Quality Report [source: data_quality.py]

python -m visualacuity.cli.examples.data_quality "mydata.csv" "reports/data_quality.csv"

Near / Total Loss Report [source: near_total_loss.py]

python -m visualacuity.cli.examples.near_total_loss "mydata.csv" "reports/near_total_loss.csv"

Plus / Minus Values Report [source: plus_minus.py]

python -m visualacuity.cli.examples.plus_minus "mydata.csv" "reports/plus_minus.csv"

Unexpected Patterns Report [source: unexpected_patterns.py]

python -m visualacuity.cli.examples.unexpected_patterns "mydata.csv" "reports/unexpected_patterns.csv"

Visit Stats Report [source: visit_stats.py]

python -m visualacuity.cli.examples.visit_stats "mydata.csv" "reports/visit_stats.csv"

VA Distribution Report [source: va_distribution.py]

python -m visualacuity.cli.examples.va_distribution "mydata.csv" "reports/va_distribution.csv" --plot-file "reports/va_distribution.pdf"

Example Usage

import visualacuity
from visualacuity import *

#############
# Basic usage
parsed = visualacuity.parse_visit({
    "Left Eye Distance SC": "20/30 -1",
    "Right Eye Near CC": "J5",
})

assert parsed == {
    "Left Eye Distance SC": VisitNote(
        text="20/30 -1",
        extracted_value="20/30",
        plus_letters=[-1],
        laterality=OS,
        distance_of_measurement=DISTANCE,
        correction=SC,
        va_format=SNELLEN,
        snellen_equivalent=(20, 30),
        log_mar_base=0.17609125905568127,
        log_mar_base_plus_letters=0.20107900637734125
    ),
    "Right Eye Near CC": VisitNote(
        text="J5",
        extracted_value="J5",
        laterality=OD,
        distance_of_measurement=NEAR,
        correction=CC,
        va_format=JAEGER,
        snellen_equivalent=(20, 40),
        log_mar_base=0.3010299956639812,
        log_mar_base_plus_letters=0.3010299956639812,
    ),
}

###########################
# "Plus" columns are merged

visit_data = {
    "Both Eyes Near CC": "20/20",
    "Both Eyes Near CC Plus": "+2"
}

parsed = visualacuity.parse_visit(visit_data)

assert parsed == {
    "Both Eyes Near CC": VisitNote(
        text="20/20",
        text_plus="+2",
        laterality=OU,
        distance_of_measurement=NEAR,
        correction=CC,
        va_format=SNELLEN,
        plus_letters=[+2],
        extracted_value="20/20",
        snellen_equivalent=(20, 20),
        log_mar_base=0.0,
        log_mar_base_plus_letters=-0.041646245536099975
    )
}

Contributing

How to publish to PyPi

  1. Bump version in src/visualacuity-python/Cargo.toml
  2. Commit that file and all other changes to main or staging
  3. Push main or staging branch to github
  4. Check status on GitHub Actions
  5. If the build is successful, tag the repo with the new version, e.g.: git tag "python-0.1.0a5"
    • Prepend test- to publish to TestPyPi (e.g. test-python-0.1.0a5).
  6. Push with --tags, e.g.: git push --tags
  7. Check status on GitHub Actions
  8. Test new install. (Note: sometimes it doesn't work on the first try — caching or something)
    • TestPyPi: pip install --index-url https://test.pypi.org/legacy/ visualacuity==0.1.0a5
    • PyPi: pip install visualacuity==0.1.0a5

Metadata

Release files for visualacuity 0.1.0a9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for visualacuity 0.1.0a9
File Size Uploaded Provenance Actions
visualacuity-0.1.0a9.tar.gz 50.4 kB Without provenance Details for visualacuity-0.1.0a9.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for visualacuity 0.1.0a9
File Actions
visualacuity-0.1.0a9-cp37-abi3-win_amd64.whl CPython 3.7 abi3 Windows x86-64 Details for visualacuity-0.1.0a9-cp37-abi3-win_amd64.whl
visualacuity-0.1.0a9-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.7 abi3 Linux glibc 2.17+ x86-64 Details for visualacuity-0.1.0a9-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
visualacuity-0.1.0a9-cp37-abi3-macosx_11_0_arm64.whl CPython 3.7 abi3 macOS 11.0+ ARM64 Details for visualacuity-0.1.0a9-cp37-abi3-macosx_11_0_arm64.whl
visualacuity-0.1.0a9-cp37-abi3-macosx_10_12_x86_64.whl CPython 3.7 abi3 macOS 10.12+ x86-64 Details for visualacuity-0.1.0a9-cp37-abi3-macosx_10_12_x86_64.whl

Total release size: 4.5 MB

Release files / visualacuity-0.1.0a9.tar.gz

Download URL visualacuity-0.1.0a9.tar.gz
Size 50.4 kB
Tags Source
SHA-256 checksum
How to use checksums
9c8b119a7302e600f34b038740fdc5dc781ae1e846658c233dbb2733314866c9
BLAKE2b-256 checksum
How to use checksums
0916a79effd473026b635996e2053e14a1f0106e5749d61e8f9a0ef563bf36c4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.5

Release files / visualacuity-0.1.0a9-cp37-abi3-win_amd64.whl

Download URL visualacuity-0.1.0a9-cp37-abi3-win_amd64.whl
Size 970.2 kB
Tags CPython 3.7 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
e13a6019eb0e380825246e2684795ff93a2b4ca4bed59c6d04cad9c51cbd129f
BLAKE2b-256 checksum
How to use checksums
ef58fe1c87ea5572106e2a29dfadae11b6cc7edb047fd0acb17a2c2f5ffd64c6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.5

Release files / visualacuity-0.1.0a9-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL visualacuity-0.1.0a9-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 1.3 MB
Tags CPython 3.7 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
8910a39925166614e66ff1d1c3b114abd0ba73da9e05a68efc3adf09640af177
BLAKE2b-256 checksum
How to use checksums
7585d491abaf81783f999150c49d1d29398540ae224dc3077d81c4ecc733572c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.5

Release files / visualacuity-0.1.0a9-cp37-abi3-macosx_11_0_arm64.whl

Download URL visualacuity-0.1.0a9-cp37-abi3-macosx_11_0_arm64.whl
Size 1.1 MB
Tags CPython 3.7 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
7c278b4c8397fc498e344a9efaab265d5ff29c769d876b46067010088c39d676
BLAKE2b-256 checksum
How to use checksums
b05194000a3579179ec6e7210d4c57260a6670e82dcd4b99b148355b448e6be2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.5

Release files / visualacuity-0.1.0a9-cp37-abi3-macosx_10_12_x86_64.whl

Download URL visualacuity-0.1.0a9-cp37-abi3-macosx_10_12_x86_64.whl
Size 1.1 MB
Tags CPython 3.7 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
09839148e7be577864f1cb7309b5e1874e32c38d76a1a773ebcd1e94ce087ad1
BLAKE2b-256 checksum
How to use checksums
a8122926a7e02e126722608fd7670c523db4f7ebc356b5acbc8630c14bd9cb65
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.5

Security for visualacuity 0.1.0a9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page