A Pointing Tool OSVE wrapper
Project description
Pointing Tool Wrapper
A JUICE SOC Pointing Tool wrapper (PTwrapper) for LINUX and MACOSX for use in a local computer.
Allows to simulate a Pointing Timeline Request (PTR) and to generate the corresponding SPICE CK, resolved PTR, available Power, and quaternions dump file.
PTwrapper is based on OSVE and mainly provides a shortcut to use the required functionalities and setup limited
to simulate PTRs. You can find more information on OSVE here.
Documentation
Documentation is available at the JUICE SOC Toolkit Help.
Installation
pip install ptwrapper
Development and testing
- Clone this repository
- Requirements:
- Poetry
- Python 3.7+
- Create a virtual environment and install the dependencies
Install the package and its dependencies:
poetry install
Then, after your edits, check that flake8 is happy:
poetry run flake8
and all the tests passed:
poetry run pytest -s
You can also run the tests with in the tests directory with:
python3 -m unittest
Using the library
After installing the library can be used with the Python Shell or with its CLI.
Python Shell
A basic test of the library for a PTR processing is provided. The sample creates in the working directory a structure folder to invoke the execution and dumps inside the OUTPUT folder the expected products (SPICE CK, resolved PTR, available Power, and quaternions CSV)
import os
from ptwrapper import execute
from ptwrapper import create_structure
ptr_content = """<prm>
<body>
<segment>
<data>
<timeline frame="SC">
<block ref="OBS">
<startTime>2030-10-15T03:40:00</startTime>
<endTime>2030-10-15T04:15:00</endTime>
<attitude ref="track">
<boresight ref="SC_Zaxis"/>
<target ref="Jupiter"/>
<phaseAngle ref="powerOptimised">
<yDir>false</yDir>
</phaseAngle>
</attitude>
<metadata>
<comment>Track Power Optimised C3.0</comment>
</metadata>
</block>
</timeline>
</data>
</segment>
</body>
</prm>
"""
mk_path = 'metakernel.tm'
session_file_path = create_structure('.', mk_path, ptr_content)
execute(os.path.dirname(session_file_path), session_file_path)
Command line interface
The package has a CLI entry point:
ptwrapper -h
usage: ptwrapper [-h] [-s SESSION_FILE] [-m META_KERNEL] [-p PTR] [-w WORKING_DIR] [-o OUTPUT_DIR] [-t TIME_STEP] [-n] [-q] [-v]
Pointing Tool Wrapper (PTWrapper) simulates a PTR and generates the corresponding SPICE CK, resolved PTR, available Power, and quaternions dump file. PTWrapper uses OSVE to simulate the PTR.
optional arguments:
-h, --help show this help message and exit
-s SESSION_FILE, --session-file SESSION_FILE
Path to the session file to run the simulation. If provided the other arguments are ignored.
-m META_KERNEL, --meta-kernel META_KERNEL
Path to the meta-kernel file.
-p PTR, --ptr PTR Path to the PTR/PTX file input file.
-w WORKING_DIR, --working-dir WORKING_DIR
Path to the working directory. Default is the current directory.
-o OUTPUT_DIR, --output-dir OUTPUT_DIR
Path to the output directory. Overwrites default output file names. Default is the structure of the built-in session file.
-t TIME_STEP, --time-step TIME_STEP
Output CK file time step in seconds. Default is 5s.
-n, --no-power Indicate not to calculate available power. Default is that the Available Power will be computed.
-q, --quaternions Indicate to calculate quaternions. Default is that the quaternions will not be computed.
-v, --version OSVE, AGM, and EPS libraries version.
You can either run the CLI using an OSVE configuration file (SESSION_FILE) or by specifying a
number of inputs and assume the rest of parameters as provided by the default configuration file
included in the package.
In addition, if you do not specify an output directory (OUTPUT_DIR), the package will replicate
the canonical output directory and file structure and will also generate a SESSION_FILE that can
be reused. Contrarily, if you specify an OUTPUT_DIR the output will be simplified and provided in
that directory; additionally the output files will inherit the name of the input PTR file.
WARNING: Remember that the input
META_KERNELneeds to have an adequate relative or absolute path for itsPATH_VALUESvariable value.
A couple of examples are provided hereunder. First specifying the output directory:
ptwrapper -m kernels/juice_mini_local.tm -p ptr_simphony.xml -o .
ptwrapper session execution
AGM version: 9.3.0.p1
OSVE version: 1.6.0
[INFO] <AGE> Attitude Generation Module initialization started
[INFO] <AGE> AGE module setup started
[INFO] <AGE> AGE module setup successfully completed
[INFO] <AGE> Attitude Generation Module initialization completed
[INFO] <AGE> Loading Attitude Timeline
[INFO] <AGE> Checking Attitude Timeline
[INFO] <AGE> Initializing Attitude Timeline
[INFO] <AGE> TOTAL ENERGY for POINTING block from 2030-10-15T03:40:00Z to 2030-10-15T04:15:00Z
[INFO] <AGE> Attitude from actual PTR: 812.096753 Wh (812.096753 Wh)
[INFO] <AGE> Attitude from loaded CK: 812.096096 Wh (812.096096 Wh)
[INFO] <PIF> XML PTR file: "ptr_resolved.ptx" generated
[INFO] <PIF> Generating CK file with the following USER DEFINED parameters:
[INFO] <PIF> CK frame ID: -28001
[INFO] <PIF> CK time step: 5 s
[INFO] <AGE> Writing Attitude Spice CK File: juice_sc_ptr.bc
[INFO] <PIF> CK file: "juice_sc_ptr.bc" generated
[INFO] <AGE> Writing Attitude Text File
[INFO] <PIF> POWER CSV file: "power.csv" generated
Renaming quaternions.csv to ptr_simphony_quaternions.csv
Renaming power.csv to ptr_simphony_power.csv
Renaming ptr_resolved.ptx to ptr_simphony_resolved.ptx
Renaming juice_sc_ptr.bc to ptr_simphony.bc
Cleaning up OSVE execution files and directories
This will generate the following output files.
.
|-- ptr_simphony.bc
|-- ptr_simphony.csv
|-- ptr_simphony.xml
|-- ptr_simphony_log.json
`-- ptr_simphony_resolved.ptx
The same run without specifying the OUTPUT_DIRECTORY yields the following directory structure:
.
|-- config
| |-- age
| | |-- AGMConfig.xml
| | |-- CFG_AGM_JUI_MULTIBODY_EVENT_DEFINITIONS.xml
| | |-- CFG_AGM_JUI_MULTIBODY_FIXED_DEFINITIONS.xml
| | `-- CFG_AGM_JUI_MULTIBODY_PREDEFINED_BLOCK.xml
| `-- ise
| |-- BRF_MAL_SGICD_2_1_300101_351005.brf
| |-- RES_C50_SA_CELLS_EFFICIENCY_310101_351003.csv
| |-- eps.cfg
| |-- events.juice.def
| |-- phs_com_res_sa_cells_count.asc
| `-- units.def
|-- kernel
| `-- juice_mini_local.tm
|-- output
| |-- juice_sc_ptr.bc
| |-- power.csv
| |-- ptr_resolved.ptx
| |-- log.json
| `-- quaternions.csv
|-- ptr
| `-- PTR_PT_V1.ptx
`-- session_file.json
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file ptwrapper-2.1.0.tar.gz.
File metadata
- Download URL: ptwrapper-2.1.0.tar.gz
- Upload date:
- Size: 91.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.1 CPython/3.9.13 Darwin/23.1.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d17c18aaf66609eb5bbab46d3ed9cd638dd258a8bbb19afd6f9f8c7e959bd259 |
|
| MD5 | b1b78c7a615752cf42640caad502ab07 |
|
| BLAKE2b-256 | c52a63ac1514217624bb2a9f277055181ea77fe23ec2e668d601e26ce23f9185 |
File details
Details for the file ptwrapper-2.1.0-py3-none-any.whl.
File metadata
- Download URL: ptwrapper-2.1.0-py3-none-any.whl
- Upload date:
- Size: 94.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.1 CPython/3.9.13 Darwin/23.1.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e1a5bb801062fbf86752884a698146509dc211b3c6be731f05b14a986f345ddf |
|
| MD5 | e50bd0db42d8815ab3aeed4f3b62e24b |
|
| BLAKE2b-256 | 72a03f4672c92e357ead0324c8bab657002c00fe58c74277a6a2e81ee53d9df3 |
