Data

Tools

Indexes

Applications

Experiments

Open Source Science

vrgs-python

Python usage in VRGS

https://github.com/vrgeoscience-limited/vrgs-python

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 1 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 (13.2%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Python usage in VRGS

Basic Info
  • Host: GitHub
  • Owner: VRGeoscience-Limited
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 138 KB
Statistics
  • Stars: 2
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created over 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

VRGS Python Integration

Python + VRGS

DOI

This repository contains python code and scripts that can be integrated directly within Virtual Reality Geological Studio. The aim is to leverage the extensive and expanding ecosystem of earth science specific python packages. The goal is to facilitate advanced 3D outcrop analysis by incorporating python into and complementing current VRGS workflows.

This repository will be periodically updated with code and scripts.

Installation

  • Install python on your machine --version >= 3.10

    • Recommended to install from the main python build.
    • VRGS will only work with a main python install, it currently does not work with virtual environment installs (e.g. anaconda)

  • Connect and point the Python Path in the VRGS Projet Properties menu to the python directory. This will ensure that the python code is correctly executed.

    • e.g. C:\python\python_xxx
    • Save the VRGS project to implement the directory addition/change.
      • You may also need to restart VRGS.
    • If runtime errors are encountered, please install necessary dependencies.
      • e.g. pip install xxx

Basic Usage

The following steps set up the python script development environment in VRGS. 1. Navigate to the Collections menu.

  1. Right + Click on the Python option

    • Click "New" to create a new python script.
    • The built-in python interpreter will open.

  2. Import necessary packages and write the awesome python script.

  3. Click :floppy_disk: Save script to write python file to project directory.

  4. To run the script, click the :arrow_forward: Run command.

    • :exclamation: Top Tip - open a Python Output console window to view any data output from the print() method, or any errors that may occur.

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use the code, please cite it as below."
authors:
- family-names: "Burnham"
  given-names: "Brian S."
  orcid: "https://orcid.org/0000-0003-0472-0016"
- family-names: "Hodgetts"
  given-names: "David"
  orcid: "https://orcid.org/0000-0002-7437-7930"
title: "VRGS-Python"
version: 0.1.0
doi: 10.5281/zenodo.12168786
date-released: 2024-06-19
url: "https://doi.org/10.5281/zenodo.12168786"

GitHub Events

Total
Last Year