Paths to directories and files providing data for unit and integration tests.

opencsp.common.lib.opencsp_path.data_path_for_test.sandia_nsttf_test_facet_centroidsfile()

Returns the path to the facet centroids file for the Sandia NSTTF tests.

This file contains data regarding the centroids of facets at the Sandia National Solar Thermal Test Facility.

Returns:

The path to the facet centroids file.

Return type:

str

opencsp.common.lib.opencsp_path.data_path_for_test.sandia_nsttf_test_heliostats_origin_file()

Returns the path to the heliostats origin file for the Sandia NSTTF tests.

This file contains data regarding the origin positions of heliostats at the Sandia National Solar Thermal Test Facility.

Returns:

The path to the heliostats origin file.

Return type:

str

Paths to OpenCSP root directories.

opencsp.common.lib.opencsp_path.opencsp_root_path.opencsp_cache_dir()

The directory to save cache files to.

opencsp.common.lib.opencsp_path.opencsp_root_path.opencsp_code_dir()

The directory containing the opencsp code.

For development with the full git project, this is the directory “[…]/[cloned git folder]/opencsp”. This means it will contain the “app” and “common” folders.

opencsp.common.lib.opencsp_path.opencsp_root_path.opencsp_data_test_dir()

This method deprecated. For most tests you can find the data in the neighboring “data” directory, inside the “test” directory.

opencsp.common.lib.opencsp_path.opencsp_root_path.opencsp_doc_dir()

The directory containing the opencsp documentation.

opencsp.common.lib.opencsp_path.opencsp_root_path.opencsp_example_dir()

The directory containing the opencsp example data, for examples that have small data inputs.

opencsp.common.lib.opencsp_path.opencsp_root_path.opencsp_large_data_example_dir()

The directory containing the opencsp example data, for examples that have very large data inputs.

opencsp.common.lib.opencsp_path.opencsp_root_path.opencsp_scratch_dir(project_dir=None) → str

The scratch directory to read/write from.

This directory holds a large amount of data, most of which should be treated as temporary. For running parallel execution programs on a cluster, it is recommended that this directory be used for all input and output, as it is designed for parallel access. When running on a cluster, this directory is a shared directory between multiple computers (aka network file system).

opencsp.common.lib.opencsp_path.opencsp_root_path.opencsp_temporary_dir()

A directory that should be safe to save temporary files to.

opencsp.common.lib.opencsp_path.opencsp_root_path.relative_opencsp_data_test_dir()

This method deprecated. For most tests you can find the data in the neighboring “data” directory, inside the “test” directory.

Paths to directories and files associated with CSP optical analysis.

The directory structure schema is described in OpenCSP/doc/optical_analysis_data_schema.md.