CERC/cerc_persistence_doc
19
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update index.rst to reflect persistence repo

Browse Source
This commit is contained in:
Ruben Sanchez 2023-11-29 13:04:46 -05:00
parent 2eb416e05f
commit 8d0de50655
2 changed files with 74 additions and 641 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -24,8 +24,6 @@ all: %
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@echo 'Create the trees for the files'
@tree -I '__pycache__' ../cerc_persistence/cerc_persistence/models/ | convert -size 404x310 label:@- ./source/models.png
@tree -I '__pycache__' ../cerc_persistence/cerc_persistence/repositories/ | convert -size 496x394 -quality 100 label:@- ./source/repositories.png
@tree -I '__pycache__' ../cerc_persistence/cerc_persistence/ | convert -size 496x394 -quality 100 label:@- ./source/cerc_persistence.png
@echo 'Create the uml'

713
source/index.rst
View File

@ -40,683 +40,118 @@ About the PERSISTENCE
*************************
This document contains the essential documentation for the CERC PERSISTENCE, a set of classes, factories, and helpers that simplifies the research at urban scale in multiples domains; these components are designed around three central axes, **extensibility**, **code clarity** and **consistency** as we intend to allow domain experts to perform urban scale simulations with multiple programs and enrich the city from several data sources.
PERSISTENCE is composed of four main components: **city model structure**, **factories**, **catalogs** and, **helpers**.
- **City model structure** is the set of classes designed to be familiar to the domain experts; this familiarity will be possible thanks to using a *standard-based* approach in order to flatten the learning curve. These classes compose the CERC *data model* that provides a simple way to study cities at an urban scale after the enriching process.
- **Factories** are pieces of code in charge of import and export information in and out of the **data model** they will perform the needed conversions to read or write different formats such as epw weather files, insel files or citygml. these factories are mean to be extended, allowing the HUB ecosystem to expand with new formats.
- **Catalogs** are datasets used in the enrichment of the city that can also be used by third party consumers like researchers or simulations software.
- **Helpers** are sets of general tools used by any of the other parts and does not fit in any of the previous categories.
City model structure
=====================================
The **city model structure** contains the common data model intended to represent a city digital twin, CERC team and contributors, will further extend these classes to include other domains, in the following sections, researchers and developers could find information about the methods and properties exposed by the city model structure classes.
.. important::
Please take a look to HUB tutorial to see how to use HUB for your own research
[`how to use the hub`_]
City model structure UML
************************
.. image:: dot.png
:width: 575
.. raw:: latex
\clearpage
PERSISTENCE is composed of four main components: **repositories** and **models**.
Folder structure
******************
city_model_structure
^^^^^^^^^^^^^^^^^^^^^^
Main city objects.
.. image:: ./city_model_structure.png
.. image:: ./cerc_persistence.png
:width: 200
attributes
Model Classes
****************************
Application
^^^^^^^^^^^^^^^^^^^^^^
Geometrical and non physical components of the city.
.. autocercclass:: cerc_persistence.models.application.Application
:members:
:private-members:
.. image:: ./attributes.png
:width: 200
building_demand
City
^^^^^^^^^^^^^^^^^^^^^^
Main classes to model building energy demand.
.. autocercclass:: cerc_persistence.models.city.City
:members:
:private-members:
.. image:: ./building_demand.png
:width: 300
energy_systems
CityObject
^^^^^^^^^^^^^^^^^^^^^^
Main classes to model energy systems.
.. autocercclass:: cerc_persistence.models.city_object.CityObject
:members:
:private-members:
.. image:: ./energy_systems.png
:width: 300
iot
SimulationResults
^^^^^^^^^^^^^^^^^^^^^^
Classes to model IoT devices.
.. autocercclass:: cerc_persistence.models.simulation_results.SimulationResults
:members:
:private-members:
.. image:: ./iot.png
:width: 250
.. raw:: latex
\clearpage
full schema
User
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.models.user.User
:members:
:private-members:
.. image:: ./city_model_structure_complete.png
:width: 300
UserRoles
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.models.user.UserRoles
:members:
:private-members:
Repository Classes
****************************
Application
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.models.application.Application
:members:
:private-members:
City
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.models.city.City
:members:
:private-members:
CityObject
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.models.city_object.CityObject
:members:
:private-members:
SimulationResults
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.models.simulation_results.SimulationResults
:members:
:private-members:
User
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.models.user.User
:members:
:private-members:
Classes
****************************
City
Configuration
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.city.City
:members:
CityObject
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.city_object.CityObject
:members:
City Objects Cluster
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.city_objects_cluster.CityObjectsCluster
:members:
Building
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.building.Building
:members:
Parts Consisting Building
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.parts_consisting_building.PartsConsistingBuilding
:members:
Buildings Cluster
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.buildings_cluster.BuildingsCluster
:members:
Network
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.network.Network
:members:
Level of detail
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.level_of_detail.LevelOfDetail
:members:
Edge
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.attributes.edge.Edge
:members:
Node
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.attributes.node.Node
:members:
Plane
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.attributes.plane.Plane
:members:
Point
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.attributes.point.Point
:members:
Polygon
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.attributes.polygon.Polygon
:members:
Polyhedron
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.attributes.polyhedron.Polyhedron
:members:
Record
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.attributes.record.Record
:members:
Schedule
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.attributes.schedule.Schedule
:members:
Time Series
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.attributes.time_series.TimeSeries
:members:
Appliances
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.building_demand.appliances.Appliances
:members:
Household
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.building_demand.household.Household
:members:
Internal Gain
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.building_demand.internal_gain.InternalGain
:members:
Internal Zone
^^^^^^^^^^^^^^^^^^^^^^
.. note:: The internal zone class represents each of the internal zones described in the geometry when imported.
This imported geometry can be later on divided in different thermal zones in a workflow (e.g. if the building with no interiors defined (LoD up to 3), it will produce one interior zone. Later on, this can be divided by storey and create one thermal zone per each).
Also, several usages can be associated with that internal zone. This usages are described in the Usage class, which has not only the parameters that describe each usage, but also the percentage of the internal zone volume that is affected by that specific use.
.. autocercclass:: hub.city_model_structure.building_demand.internal_zone.InternalZone
:members:
Layer
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.building_demand.layer.Layer
:members:
Lighting
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.building_demand.lighting.Lighting
:members:
Occupancy
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.building_demand.occupancy.Occupancy
:members:
Storey
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.building_demand.storey.Storey
:members:
Surface
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.building_demand.surface.Surface
:members:
Thermal Boundary
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.building_demand.thermal_boundary.ThermalBoundary
:members:
Thermal Control
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.building_demand.thermal_control.ThermalControl
:members:
Thermal Opening
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.building_demand.thermal_opening.ThermalOpening
:members:
Thermal Zone
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.building_demand.thermal_zone.ThermalZone
:members:
Usage
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.building_demand.usage.Usage
:members:
Plant
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.greenery.plant.Plant
:members:
Soil
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.greenery.soil.Soil
:members:
Vegetation
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.greenery.vegetation.Vegetation
:members:
Sensor
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.iot.sensor.Sensor
:members:
Sensor Measure
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.iot.sensor_measure.SensorMeasure
:members:
Sensor Type
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.iot.sensor_type.SensorType
:members:
Station
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.city_model_structure.iot.station.Station
:members:
Factories
=====================================
Factories are divided into Imports and Exports, depending on if they are used to enrich (Import) the *city model structure* or to deliver third party defined formats (Export) such as **INSEL** or **IDF** file, the factories could be extended to include new imports and outputs providing an additional level of abstraction to researchers.
|alert| Please, note that the private methods, the ones starting with an underscore character (_), documented in the factories are mean to be called by using the **handler** parameter; this parameter must contain the method name without the _ character.
.. note::
For instance, to use _citygml handler in the Geometry factory, the handler parameter value needs to be 'citygml'
|alert| **This documentation includes only the base factories classes as these are the intended entry points for the Import/Export functionality.**
.. important::
Please refer to the development manual if you want to create your own factories.
[`development manual`_]
.. raw:: latex
\clearpage
Folder structure
******************
Imports
^^^^^^^^^^^^^^^^^^^^^^
.. image:: ./imports.png
:width: 250
Exports
^^^^^^^^^^^^^^^^^^^^^^
.. image:: ./exports.png
:width: 250
.. raw:: latex
\clearpage
Imports Classes
***************
Construction Factory
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.imports.construction_factory.ConstructionFactory
.. autocercclass:: cerc_persistence.configuration.Configuration
:members:
:private-members:
Geometry Factory
DB Control
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.imports.geometry_factory.GeometryFactory
.. autocercclass:: cerc_persistence.db_control.DBControl
:members:
:private-members:
Usage Factory
DB Setup
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.imports.usage_factory.UsageFactory
.. autocercclass:: cerc_persistence.db_setup.DBSetup
:members:
:private-members:
Weather Factory
Repository
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.imports.weather_factory.WeatherFactory
.. autocercclass:: cerc_persistence.repository.Repository
:members:
:private-members:
.. raw:: latex
\clearpage
Exports
*******
Export Factory
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.exports.exports_factory.ExportsFactory
:members:
:private-members:
Catalogs
=====================================
In its simplest form, a catalogue is a file or group of files that provide technical and/or commercial information regarding components that form a system within any domain. The components are listed with relevant details and associated data is tabulated. Also listed are the dominant/standard configurations in which the components may be used to satisfy use-cases/output requirements (as supplied by component manufacturer/standard organisations).
.. note::
Examples, Heat Pump catalogue should consist of the heat pump models produced, heat pump type, manufacturer name, output temperatures, nominal capacities, typical configurations for the heat pumps (e.g., configurations when used for space heating only, Domestic Hot Water/DHW purposes only, both space heating and DHW, combinations with solar thermal/PV), storage tank data, circulation pump data, compressor type and associated technical data, valve types etc.
.. important::
Please refer to the catalogs manual if you want to create or extend your own catalogs.
[`catalogs manual`_]
Folder structure
******************
Catalogs
^^^^^^^^^^^^^^^^^^^^^^
.. image:: ./catalogs.png
:width: 240
Catalog Base Class
*******************
Catalog
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.catalog.Catalog
:members:
.. raw:: latex
\clearpage
Greenery
***************
Greenery Catalog Factory
^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.greenery_catalog_factory.GreeneryCatalogFactory
:members:
:private-members:
Greenery Content Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.greenery.content.Content
:members:
Greenery Plant Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.greenery.plant.Plant
:members:
Greenery Plant Percentage Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.greenery.plant_percentage.PlantPercentage
:members:
Greenery Plant Soil Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.greenery.soil.Soil
:members:
Greenery Vegetation Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.greenery.vegetation.Vegetation
:members:
.. raw:: latex
\clearpage
Construction
***************
Construction Catalog Factory
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.construction_catalog_factory.ConstructionCatalogFactory
:members:
:private-members:
Construction Content Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.construction.content.Content
:members:
Construction Archetype Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.construction.archetype.Archetype
:members:
Construction Construction Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.construction.construction.Construction
:members:
Construction Layer Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.construction.layer.Layer
:members:
Construction Material Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.construction.material.Material
:members:
Construction Window Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.construction.window.Window
:members:
.. raw:: latex
\clearpage
Costs
***************
Costs Catalog Factory
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.costs_catalog_factory.CostsCatalogFactory
:members:
:private-members:
Costs Content Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.cost.content.Content
:members:
Costs Archetype Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.cost.archetype.Archetype
:members:
Costs Capital Cost Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.cost.capital_cost.CapitalCost
:members:
Costs Chapter Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.cost.chapter.Chapter
:members:
Costs Fuel Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.cost.fuel.Fuel
:members:
Costs Income Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.cost.income.Income
:members:
Costs Item Description Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.cost.item_description.ItemDescription
:members:
Costs Operational Cost Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.cost.operational_cost.OperationalCost
:members:
.. raw:: latex
\clearpage
Energy Systems
***************
Energy Systems Catalog Factory
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.energy_systems_catalog_factory.EnergySystemsCatalogFactory
:members:
:private-members:
Energy Systems Content Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.energy_systems.content.Content
:members:
Energy Systems Archetype Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.energy_systems.archetype.Archetype
:members:
Energy Systems Distribution System Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.energy_systems.distribution_system.DistributionSystem
:members:
Energy Systems Emission System Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.energy_systems.emission_system.EmissionSystem
:members:
Energy Systems Generation System Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.energy_systems.generation_system.GenerationSystem
:members:
Energy Systems Energy Systems Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.energy_systems.system.System
:members:
.. raw:: latex
\clearpage
Usage
************
Usage Catalog Factory
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.usage_catalog_factory.UsageCatalogFactory
:members:
:private-members:
Usage Content Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.usages.content.Content
:members:
Usage Appliances Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.usages.appliances.Appliances
:members:
Usage Content Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.usages.content.Content
:members:
Usage Domestic Hot Water Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.usages.domestic_hot_water.DomesticHotWater
:members:
Usage Internal Gain Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.usages.internal_gain.InternalGain
:members:
Usage Lighting Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.usages.lighting.Lighting
:members:
Usage Occupancy Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.usages.occupancy.Occupancy
:members:
Usage Schedule Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.usages.schedule.Schedule
:members:
Usage Thermal Control Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.usages.thermal_control.ThermalControl
:members:
Usage Usage Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: hub.catalog_factories.data_models.usages.usage.Usage
:members:
.. raw:: latex
\clearpage
Helpers
=======
CERC hub provides a set of *helpers* that will simplify certain operations; these helpers are mean to be freely used at any point and therefore could be consumed from several places.
Folder structure
******************
.. image:: ./helpers.png
:width: 300
.. raw:: latex
\clearpage
Configuration Helper
********************
.. autocercclass:: hub.helpers.configuration_helper.ConfigurationHelper
:members:
.. raw:: latex
\clearpage
Constants
********************
.. include:: constants.rst
Geometry Helper
********************
.. autocercclass:: hub.helpers.geometry_helper.GeometryHelper
:members:
Location
********************
.. autocercclass:: hub.helpers.location.Location
:members:
Dictionaries
********************
.. autocercclass:: hub.helpers.dictionaries.Dictionaries
:members:
Additional Files
====================