Merge remote-tracking branch 'origin/master'
This commit is contained in:
pilar
commit
c6d7fff53c
19
docs/Makefile
Normal file
19
docs/Makefile
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
# Minimal makefile for Sphinx documentation
|
||||||
|
#
|
||||||
|
|
||||||
|
# You can set these variables from the command line.
|
||||||
|
SPHINXOPTS =
|
||||||
|
SPHINXBUILD = sphinx-build
|
||||||
|
SOURCEDIR = source
|
||||||
|
BUILDDIR = build
|
||||||
|
|
||||||
|
# Put it first so that "make" without argument is like "make help".
|
||||||
|
help:
|
||||||
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||||
|
|
||||||
|
.PHONY: help Makefile
|
||||||
|
|
||||||
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||||
|
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||||
|
%: Makefile
|
||||||
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||||
BIN
docs/build/doctrees/environment.pickle
vendored
Normal file
BIN
docs/build/doctrees/environment.pickle
vendored
Normal file
Binary file not shown.
BIN
docs/build/doctrees/index.doctree
vendored
Normal file
BIN
docs/build/doctrees/index.doctree
vendored
Normal file
Binary file not shown.
4
docs/build/html/.buildinfo
vendored
Normal file
4
docs/build/html/.buildinfo
vendored
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
# Sphinx build info version 1
|
||||||
|
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||||
|
config: ef1138b4dd75fa215b19d7afe593c52b
|
||||||
|
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||||
0
docs/build/html/.nojekyll
vendored
Normal file
0
docs/build/html/.nojekyll
vendored
Normal file
88
docs/build/html/_downloads/13a3f69333aa9b7801ffb3c647ab96e3/CONTRIBUTING.md
vendored
Normal file
88
docs/build/html/_downloads/13a3f69333aa9b7801ffb3c647ab96e3/CONTRIBUTING.md
vendored
Normal file
|
|
@ -0,0 +1,88 @@
|
||||||
|
# Contributing guidelines
|
||||||
|
|
||||||
|
## Push Request Checklist
|
||||||
|
|
||||||
|
Before sending your pull requests, make sure you followed this list.
|
||||||
|
|
||||||
|
- Read [contributing guidelines](CONTRIBUTING.md).
|
||||||
|
- Read [Code of Conduct](CODE_OF_CONDUCT.md).
|
||||||
|
- Check if my changes are consistent with the [guidelines](CONTRIBUTING.md#user-content-general-guidelines-and-philosophy-for-contribution).
|
||||||
|
- Changes are consistent with the [Coding Style](CONTRIBUTING.md#user-content-coding-style).
|
||||||
|
- Manually test your code and add [Unit Tests](CONTRIBUTING.md#user-content-testing-best-practices).
|
||||||
|
- [Document your work](CONTRIBUTING.md#user-content-documentation).
|
||||||
|
|
||||||
|
## How to become a contributor and submit your own code
|
||||||
|
|
||||||
|
### Contributor License Agreements
|
||||||
|
|
||||||
|
CERC Libs is an [LGPL licensed](LICENSE.md) software, so even if we'd love to accept your patches, Before we can take them, please be sure that you are the intellectual property owner of your code and that do you fully understand and respect our software license.
|
||||||
|
|
||||||
|
***NOTE***: Only source code that you own will go into the main repository.
|
||||||
|
|
||||||
|
### Contributing code
|
||||||
|
|
||||||
|
If you have improvements to CERC Libs or want to extend the functionality, please send us your pull request as seen at [git pull request documentation](https://git-scm.com/docs/git-request-pull)
|
||||||
|
|
||||||
|
Once the pull requests are approved and pass continuous integration checks, a team member will merge your changes on CERC Libs, and your code will become an integral part of Insel4D platform.
|
||||||
|
|
||||||
|
If you prefer to contribute, instead of adding new functionality, you can also take a look at our ticket system and try to fix any of the listed issues.
|
||||||
|
|
||||||
|
### Contribution guidelines and standards
|
||||||
|
|
||||||
|
Before sending your pull request for review, make sure your changes are consistent with the guidelines, and follow the CERC Libs coding style.
|
||||||
|
|
||||||
|
#### General guidelines and philosophy for contribution
|
||||||
|
|
||||||
|
* Include unit tests when you contribute new features, as they help to:
|
||||||
|
* Prove that your code works correctly.
|
||||||
|
* Guard against future breaking changes to lower the maintenance cost.
|
||||||
|
|
||||||
|
|
||||||
|
* Bug fixes also generally require unit tests, because the presence of bugs usually indicates insufficient test coverage.
|
||||||
|
* Keep backward compatibility in mind when you change code in CERC Libs, and if you need to broke the backward compatibility, please ensure that you:
|
||||||
|
* Clearly indicate which features are affected by your changes.
|
||||||
|
* Technical reasons for the changes.
|
||||||
|
|
||||||
|
|
||||||
|
* Tests should follow the
|
||||||
|
[testing best practices](CONTRIBUTING.md#user-content-testing-best-practices)
|
||||||
|
guide.
|
||||||
|
* [Document your contribution](CONTRIBUTING.md#user-content-documentation)
|
||||||
|
|
||||||
|
#### License
|
||||||
|
|
||||||
|
Include a small header with contact information and the code license at the top of any new file like in the following example.
|
||||||
|
|
||||||
|
"""
|
||||||
|
Name module
|
||||||
|
SPDX - License - Identifier: LGPL - 3.0 - or -later
|
||||||
|
Copyright © 2020 Project Author name mail@concordia.ca
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
#### Coding style
|
||||||
|
|
||||||
|
Changes to CERC Libs python code should conform to our coding style [Cerc Python Style Guide](PYGUIDE.md)
|
||||||
|
|
||||||
|
As a general basis, all contributions need to be focused on the concept of code clarity and use pylint to check your Python changes.
|
||||||
|
To install pylint and check your files against Cerc custom style definition:
|
||||||
|
|
||||||
|
To install `pylint` and check a file
|
||||||
|
with `pylint` against Cerc custom style definition:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install pylint
|
||||||
|
pylint --rcfile=pylintrc myfile.py
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Testing best practices
|
||||||
|
|
||||||
|
Before any pull request, the code must been manually and automatically tested to ensure at least some quality minimum. There are a few practices for unit tests that we believe are important, so we encourage you to follow it.
|
||||||
|
|
||||||
|
* The test should be self-contained, which implies that your tests will prepare and clean up everything before and after the test execution.
|
||||||
|
* We encourage you to create if possible functional tests that cover the complete workflow of the implemented functionality.
|
||||||
|
* Maximize your code coverage by ensuring that you are testing as much of your code as possible.
|
||||||
|
|
||||||
|
#### Documentation
|
||||||
|
|
||||||
|
In case of new functionality, a general overview, configuration, installation, and user manuals need to be provided by the developer; this will provide an excellent starting point for all the future users and help you detect any inconsistencies in your design.
|
||||||
129
docs/build/html/_downloads/2e7955674502227d52eac12f33460c6c/CODE_OF_CONDUCT.md
vendored
Normal file
129
docs/build/html/_downloads/2e7955674502227d52eac12f33460c6c/CODE_OF_CONDUCT.md
vendored
Normal file
|
|
@ -0,0 +1,129 @@
|
||||||
|
|
||||||
|
# Contributor Covenant Code of Conduct
|
||||||
|
|
||||||
|
## Our Pledge
|
||||||
|
|
||||||
|
We as members, contributors, and leaders pledge to make participation in our
|
||||||
|
community a harassment-free experience for everyone, regardless of age, body
|
||||||
|
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||||
|
identity and expression, level of experience, education, socio-economic status,
|
||||||
|
nationality, personal appearance, race, religion, or sexual identity
|
||||||
|
and orientation.
|
||||||
|
|
||||||
|
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||||
|
diverse, inclusive, and healthy community.
|
||||||
|
|
||||||
|
## Our Standards
|
||||||
|
|
||||||
|
Examples of behavior that contributes to a positive environment for our
|
||||||
|
community include:
|
||||||
|
|
||||||
|
* Demonstrating empathy and kindness toward other people
|
||||||
|
* Being respectful of differing opinions, viewpoints, and experiences
|
||||||
|
* Giving and gracefully accepting constructive feedback
|
||||||
|
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||||
|
and learning from the experience
|
||||||
|
* Focusing on what is best not just for us as individuals, but for the
|
||||||
|
overall community
|
||||||
|
|
||||||
|
Examples of unacceptable behavior include:
|
||||||
|
|
||||||
|
* The use of sexualized language or imagery, and sexual attention or
|
||||||
|
advances of any kind
|
||||||
|
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||||
|
* Public or private harassment
|
||||||
|
* Publishing others' private information, such as a physical or email
|
||||||
|
address, without their explicit permission
|
||||||
|
* Other conduct which could reasonably be considered inappropriate in a
|
||||||
|
professional setting
|
||||||
|
|
||||||
|
## Enforcement Responsibilities
|
||||||
|
|
||||||
|
Community leaders are responsible for clarifying and enforcing our standards of
|
||||||
|
acceptable behavior and will take appropriate and fair corrective action in
|
||||||
|
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||||
|
or harmful.
|
||||||
|
|
||||||
|
Community leaders have the right and responsibility to remove, edit, or reject
|
||||||
|
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||||
|
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||||
|
decisions when appropriate.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
This Code of Conduct applies within all community spaces, and also applies when
|
||||||
|
an individual is officially representing the community in public spaces.
|
||||||
|
Examples of representing our community include using an official e-mail address,
|
||||||
|
posting via an official social media account, or acting as an appointed
|
||||||
|
representative at an online or offline event.
|
||||||
|
|
||||||
|
## Enforcement
|
||||||
|
|
||||||
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
|
reported to the community leaders responsible for enforcement at
|
||||||
|
guillermo.gutierrezmorote@concordia.ca.
|
||||||
|
All complaints will be reviewed and investigated promptly and fairly.
|
||||||
|
|
||||||
|
All community leaders are obligated to respect the privacy and security of the
|
||||||
|
reporter of any incident.
|
||||||
|
|
||||||
|
## Enforcement Guidelines
|
||||||
|
|
||||||
|
Community leaders will follow these Community Impact Guidelines in determining
|
||||||
|
the consequences for any action they deem in violation of this Code of Conduct:
|
||||||
|
|
||||||
|
### 1. Correction
|
||||||
|
|
||||||
|
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||||
|
unprofessional or unwelcome in the community.
|
||||||
|
|
||||||
|
**Consequence**: A private, written warning from community leaders, providing
|
||||||
|
clarity around the nature of the violation and an explanation of why the
|
||||||
|
behavior was inappropriate. A public apology may be requested.
|
||||||
|
|
||||||
|
### 2. Warning
|
||||||
|
|
||||||
|
**Community Impact**: A violation through a single incident or series
|
||||||
|
of actions.
|
||||||
|
|
||||||
|
**Consequence**: A warning with consequences for continued behavior. No
|
||||||
|
interaction with the people involved, including unsolicited interaction with
|
||||||
|
those enforcing the Code of Conduct, for a specified period of time. This
|
||||||
|
includes avoiding interactions in community spaces as well as external channels
|
||||||
|
like social media. Violating these terms may lead to a temporary or
|
||||||
|
permanent ban.
|
||||||
|
|
||||||
|
### 3. Temporary Ban
|
||||||
|
|
||||||
|
**Community Impact**: A serious violation of community standards, including
|
||||||
|
sustained inappropriate behavior.
|
||||||
|
|
||||||
|
**Consequence**: A temporary ban from any sort of interaction or public
|
||||||
|
communication with the community for a specified period of time. No public or
|
||||||
|
private interaction with the people involved, including unsolicited interaction
|
||||||
|
with those enforcing the Code of Conduct, is allowed during this period.
|
||||||
|
Violating these terms may lead to a permanent ban.
|
||||||
|
|
||||||
|
### 4. Permanent Ban
|
||||||
|
|
||||||
|
**Community Impact**: Demonstrating a pattern of violation of community
|
||||||
|
standards, including sustained inappropriate behavior, harassment of an
|
||||||
|
individual, or aggression toward or disparagement of classes of individuals.
|
||||||
|
|
||||||
|
**Consequence**: A permanent ban from any sort of public interaction within
|
||||||
|
the community.
|
||||||
|
|
||||||
|
## Attribution
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||||
|
version 2.0, available at
|
||||||
|
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
||||||
|
|
||||||
|
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
||||||
|
enforcement ladder](https://github.com/mozilla/diversity).
|
||||||
|
|
||||||
|
[homepage]: https://www.contributor-covenant.org
|
||||||
|
|
||||||
|
For answers to common questions about this code of conduct, see the FAQ at
|
||||||
|
https://www.contributor-covenant.org/faq. Translations are available at
|
||||||
|
https://www.contributor-covenant.org/translations.
|
||||||
163
docs/build/html/_downloads/45c67e110fdd21d2beb01832b61177ec/LICENSE.md
vendored
Normal file
163
docs/build/html/_downloads/45c67e110fdd21d2beb01832b61177ec/LICENSE.md
vendored
Normal file
|
|
@ -0,0 +1,163 @@
|
||||||
|
GNU LESSER GENERAL PUBLIC LICENSE
|
||||||
|
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies of this license
|
||||||
|
document, but changing it is not allowed.
|
||||||
|
|
||||||
|
This version of the GNU Lesser General Public License incorporates the terms
|
||||||
|
and conditions of version 3 of the GNU General Public License, supplemented
|
||||||
|
by the additional permissions listed below.
|
||||||
|
|
||||||
|
0. Additional Definitions.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
As used herein, "this License" refers to version 3 of the GNU Lesser General
|
||||||
|
Public License, and the "GNU GPL" refers to version 3 of the GNU General Public
|
||||||
|
License.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
"The Library" refers to a covered work governed by this License, other than
|
||||||
|
an Application or a Combined Work as defined below.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
An "Application" is any work that makes use of an interface provided by the
|
||||||
|
Library, but which is not otherwise based on the Library. Defining a subclass
|
||||||
|
of a class defined by the Library is deemed a mode of using an interface provided
|
||||||
|
by the Library.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
A "Combined Work" is a work produced by combining or linking an Application
|
||||||
|
with the Library. The particular version of the Library with which the Combined
|
||||||
|
Work was made is also called the "Linked Version".
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
The "Minimal Corresponding Source" for a Combined Work means the Corresponding
|
||||||
|
Source for the Combined Work, excluding any source code for portions of the
|
||||||
|
Combined Work that, considered in isolation, are based on the Application,
|
||||||
|
and not on the Linked Version.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
The "Corresponding Application Code" for a Combined Work means the object
|
||||||
|
code and/or source code for the Application, including any data and utility
|
||||||
|
programs needed for reproducing the Combined Work from the Application, but
|
||||||
|
excluding the System Libraries of the Combined Work.
|
||||||
|
|
||||||
|
1. Exception to Section 3 of the GNU GPL.
|
||||||
|
|
||||||
|
You may convey a covered work under sections 3 and 4 of this License without
|
||||||
|
being bound by section 3 of the GNU GPL.
|
||||||
|
|
||||||
|
2. Conveying Modified Versions.
|
||||||
|
|
||||||
|
If you modify a copy of the Library, and, in your modifications, a facility
|
||||||
|
refers to a function or data to be supplied by an Application that uses the
|
||||||
|
facility (other than as an argument passed when the facility is invoked),
|
||||||
|
then you may convey a copy of the modified version:
|
||||||
|
|
||||||
|
a) under this License, provided that you make a good faith effort to ensure
|
||||||
|
that, in the event an Application does not supply the function or data, the
|
||||||
|
facility still operates, and performs whatever part of its purpose remains
|
||||||
|
meaningful, or
|
||||||
|
|
||||||
|
b) under the GNU GPL, with none of the additional permissions of this License
|
||||||
|
applicable to that copy.
|
||||||
|
|
||||||
|
3. Object Code Incorporating Material from Library Header Files.
|
||||||
|
|
||||||
|
The object code form of an Application may incorporate material from a header
|
||||||
|
file that is part of the Library. You may convey such object code under terms
|
||||||
|
of your choice, provided that, if the incorporated material is not limited
|
||||||
|
to numerical parameters, data structure layouts and accessors, or small macros,
|
||||||
|
inline functions and templates (ten or fewer lines in length), you do both
|
||||||
|
of the following:
|
||||||
|
|
||||||
|
a) Give prominent notice with each copy of the object code that the Library
|
||||||
|
is used in it and that the Library and its use are covered by this License.
|
||||||
|
|
||||||
|
b) Accompany the object code with a copy of the GNU GPL and this license document.
|
||||||
|
|
||||||
|
4. Combined Works.
|
||||||
|
|
||||||
|
You may convey a Combined Work under terms of your choice that, taken together,
|
||||||
|
effectively do not restrict modification of the portions of the Library contained
|
||||||
|
in the Combined Work and reverse engineering for debugging such modifications,
|
||||||
|
if you also do each of the following:
|
||||||
|
|
||||||
|
a) Give prominent notice with each copy of the Combined Work that the Library
|
||||||
|
is used in it and that the Library and its use are covered by this License.
|
||||||
|
|
||||||
|
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
||||||
|
document.
|
||||||
|
|
||||||
|
c) For a Combined Work that displays copyright notices during execution, include
|
||||||
|
the copyright notice for the Library among these notices, as well as a reference
|
||||||
|
directing the user to the copies of the GNU GPL and this license document.
|
||||||
|
|
||||||
|
d) Do one of the following:
|
||||||
|
|
||||||
|
0) Convey the Minimal Corresponding Source under the terms of this License,
|
||||||
|
and the Corresponding Application Code in a form suitable for, and under terms
|
||||||
|
that permit, the user to recombine or relink the Application with a modified
|
||||||
|
version of the Linked Version to produce a modified Combined Work, in the
|
||||||
|
manner specified by section 6 of the GNU GPL for conveying Corresponding Source.
|
||||||
|
|
||||||
|
1) Use a suitable shared library mechanism for linking with the Library. A
|
||||||
|
suitable mechanism is one that (a) uses at run time a copy of the Library
|
||||||
|
already present on the user's computer system, and (b) will operate properly
|
||||||
|
with a modified version of the Library that is interface-compatible with the
|
||||||
|
Linked Version.
|
||||||
|
|
||||||
|
e) Provide Installation Information, but only if you would otherwise be required
|
||||||
|
to provide such information under section 6 of the GNU GPL, and only to the
|
||||||
|
extent that such information is necessary to install and execute a modified
|
||||||
|
version of the Combined Work produced by recombining or relinking the Application
|
||||||
|
with a modified version of the Linked Version. (If you use option 4d0, the
|
||||||
|
Installation Information must accompany the Minimal Corresponding Source and
|
||||||
|
Corresponding Application Code. If you use option 4d1, you must provide the
|
||||||
|
Installation Information in the manner specified by section 6 of the GNU GPL
|
||||||
|
for conveying Corresponding Source.)
|
||||||
|
|
||||||
|
5. Combined Libraries.
|
||||||
|
|
||||||
|
You may place library facilities that are a work based on the Library side
|
||||||
|
by side in a single library together with other library facilities that are
|
||||||
|
not Applications and are not covered by this License, and convey such a combined
|
||||||
|
library under terms of your choice, if you do both of the following:
|
||||||
|
|
||||||
|
a) Accompany the combined library with a copy of the same work based on the
|
||||||
|
Library, uncombined with any other library facilities, conveyed under the
|
||||||
|
terms of this License.
|
||||||
|
|
||||||
|
b) Give prominent notice with the combined library that part of it is a work
|
||||||
|
based on the Library, and explaining where to find the accompanying uncombined
|
||||||
|
form of the same work.
|
||||||
|
|
||||||
|
6. Revised Versions of the GNU Lesser General Public License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of the
|
||||||
|
GNU Lesser General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to address
|
||||||
|
new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the Library as you
|
||||||
|
received it specifies that a certain numbered version of the GNU Lesser General
|
||||||
|
Public License "or any later version" applies to it, you have the option of
|
||||||
|
following the terms and conditions either of that published version or of
|
||||||
|
any later version published by the Free Software Foundation. If the Library
|
||||||
|
as you received it does not specify a version number of the GNU Lesser General
|
||||||
|
Public License, you may choose any version of the GNU Lesser General Public
|
||||||
|
License ever published by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Library as you received it specifies that a proxy can decide whether
|
||||||
|
future versions of the GNU Lesser General Public License shall apply, that
|
||||||
|
proxy's public statement of acceptance of any version is permanent authorization
|
||||||
|
for you to choose that version for the Library.
|
||||||
151
docs/build/html/_downloads/a6997596463e84fde618c07830426201/PYGUIDE.md
vendored
Normal file
151
docs/build/html/_downloads/a6997596463e84fde618c07830426201/PYGUIDE.md
vendored
Normal file
|
|
@ -0,0 +1,151 @@
|
||||||
|
# Cerc Python Style Guide
|
||||||
|
## What's coding style and why it matters.
|
||||||
|
|
||||||
|
Coding style is just how the code looks, it's incredibly personal, and everyone has their style.
|
||||||
|
|
||||||
|
Your preferred architectures, variable and function naming style all of then impacts in your code style and how the others read and understand it, so it could become a significant burden if everyone is coding on his own.
|
||||||
|
|
||||||
|
At CERC, we are following the [PEP8](https://www.python.org/dev/peps/pep-0008/) with two spaces indentation instead of four.
|
||||||
|
|
||||||
|
## Tools.
|
||||||
|
|
||||||
|
We use [PyCharm](https://www.jetbrains.com/pycharm/) as an integrated development environment and follow the tool's overall advice but the space indentation, which we set to two spaces instead of default four spaces.
|
||||||
|
|
||||||
|
For code analysis, we enforce the usage of [pylint](https://www.pylint.org/) with our own [custom style definition](pylintrc).
|
||||||
|
|
||||||
|
## Naming convention.
|
||||||
|
|
||||||
|
* Name your folders and files in lowercase.
|
||||||
|
* Your class names must start in capital letters and follow the python CapWords pattern.
|
||||||
|
* Methods and properties that return lists must end in "s".
|
||||||
|
* Methods and variables should be lowercase and use _ (underscore) as a word separator.
|
||||||
|
* Constant names must be all capitals.
|
||||||
|
* Avoid the usage of "get_" and "set_" methods whenever possible, by using @property and @variable.setter decorators instead.
|
||||||
|
* "Private" methods, variables and properties start with _ (underscore)
|
||||||
|
|
||||||
|
## Imports.
|
||||||
|
Place your imports at the top of the file, after the license and contact information
|
||||||
|
comment.
|
||||||
|
|
||||||
|
```python
|
||||||
|
"""
|
||||||
|
MyClass module
|
||||||
|
SPDX - License - Identifier: LGPL - 3.0 - or -later
|
||||||
|
Copyright © 2020 Project Author name name@concordia.ca
|
||||||
|
"""
|
||||||
|
|
||||||
|
import sys
|
||||||
|
```
|
||||||
|
|
||||||
|
Ensure that your imports are used and remove any unused.
|
||||||
|
|
||||||
|
|
||||||
|
## Object attributes and methods.
|
||||||
|
|
||||||
|
Use properties whenever possible and encapsulate the access to all the calculated object attributes into properties, as shown in the following example.
|
||||||
|
|
||||||
|
```python
|
||||||
|
|
||||||
|
@property
|
||||||
|
def object_attribute(self):
|
||||||
|
if self._object_attribute is None:
|
||||||
|
self._object_attribute = ...
|
||||||
|
...
|
||||||
|
return self._object_attribute
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
And like in the following example for read and write properties.
|
||||||
|
|
||||||
|
```python
|
||||||
|
|
||||||
|
@property
|
||||||
|
def object_changeable_attribute(self):
|
||||||
|
return self._object_changeable_attribute
|
||||||
|
|
||||||
|
@object_changeable_attribute.setter
|
||||||
|
def object_changeable_attribute(self, value):
|
||||||
|
self._object_changeable_attribute = value
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
If your method or attribute returns a complex object use type hints as in this example.
|
||||||
|
|
||||||
|
```python
|
||||||
|
|
||||||
|
@property
|
||||||
|
def complex_object(self) -> ComplexObject:
|
||||||
|
return self._object_changeable_attribute
|
||||||
|
|
||||||
|
def new_complex_object(self, first_param, second_param) -> ComplexObject:
|
||||||
|
return ComplexObject(first_param, second_param, self.property)
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
Always access your variable through the method and avoid to access directly.
|
||||||
|
|
||||||
|
```python
|
||||||
|
|
||||||
|
@property
|
||||||
|
def object_attribute(self):
|
||||||
|
return self._object_attribute
|
||||||
|
|
||||||
|
def operation(self, first_param, second_param):
|
||||||
|
return self.object_attribute * 2
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
### Coments.
|
||||||
|
|
||||||
|
#### Code documentation.
|
||||||
|
|
||||||
|
All public classes, properties, and methods must have code comments.
|
||||||
|
|
||||||
|
```python
|
||||||
|
|
||||||
|
class MyClass
|
||||||
|
"""
|
||||||
|
MyClass class perform models class operations
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
|
||||||
|
|
||||||
|
@property
|
||||||
|
def object_attribute(self):
|
||||||
|
"""
|
||||||
|
My class object attribute
|
||||||
|
:return: int
|
||||||
|
"""
|
||||||
|
return self._object_attribute
|
||||||
|
|
||||||
|
def operation(self, first_param, second_param):
|
||||||
|
"""
|
||||||
|
multiplies object_attribute by two
|
||||||
|
:return: int
|
||||||
|
"""
|
||||||
|
return self.object_attribute * 2
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
Attributes with known units should be explicit in method's comment.
|
||||||
|
|
||||||
|
```python
|
||||||
|
|
||||||
|
@property
|
||||||
|
def distance(self):
|
||||||
|
"""
|
||||||
|
My class distance in meters
|
||||||
|
:return: float
|
||||||
|
"""
|
||||||
|
return self._distance
|
||||||
|
```
|
||||||
|
|
||||||
|
#### To do's.
|
||||||
|
|
||||||
|
Pending to implement operations should be indicated with ToDo comments to highlight the missing functionality.
|
||||||
|
|
||||||
|
```python
|
||||||
|
# ToDo: right now extracted at the city level, in the future should be extracted also at building level if exist
|
||||||
|
```
|
||||||
|
|
||||||
19
docs/build/html/_downloads/e1ab89a34fbe66ed8839d64f1e448e11/README.md
vendored
Normal file
19
docs/build/html/_downloads/e1ab89a34fbe66ed8839d64f1e448e11/README.md
vendored
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
# libs
|
||||||
|
|
||||||
|
Libs is part of Insel4D architecture for the urban simulations, created by the CERC group at Concordia University.
|
||||||
|
|
||||||
|
Libs repository contains a set of classes modeling the data for urban environments in the form of:
|
||||||
|
|
||||||
|
* city_model_structure
|
||||||
|
* geometry
|
||||||
|
* physics
|
||||||
|
* usages
|
||||||
|
|
||||||
|
Released under [LGPL license](LICENSE.md), will provide an object-oriented, modular approach to urban simulations.
|
||||||
|
|
||||||
|
Our aims are:
|
||||||
|
|
||||||
|
* involve as many scientists and contributors as possible
|
||||||
|
* provide a complete set of classes that help scientists and students to model urban environments.
|
||||||
|
|
||||||
|
Please check the [contributing information](CONTRIBUTING.md) and [code of conduct](CODE_OF_CONDUCT.md) if you want to contribute, and let us know any new feature you may be of interest for you or your team.
|
||||||
242
docs/build/html/_modules/city_model_structure/city.html
vendored
Normal file
242
docs/build/html/_modules/city_model_structure/city.html
vendored
Normal file
|
|
@ -0,0 +1,242 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
<title>city_model_structure.city</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../../_static/pygments.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/theme.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/sphinx_press_theme.css">
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
||||||
|
|
||||||
|
<!-- sphinx script_files -->
|
||||||
|
<script src="../../_static/jquery.js"></script>
|
||||||
|
<script src="../../_static/underscore.js"></script>
|
||||||
|
<script src="../../_static/doctools.js"></script>
|
||||||
|
<script src="../../_static/language_data.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="../../_static/theme-vendors.js"></script>
|
||||||
|
<script src="../../_static/theme.js" defer></script>
|
||||||
|
|
||||||
|
<link rel="index" title="Index" href="../../genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="../../search.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
|
||||||
|
<router-link to="../../index.html" class="home-link">
|
||||||
|
|
||||||
|
<span class="site-name">CERC libs</span>
|
||||||
|
|
||||||
|
</router-link>
|
||||||
|
|
||||||
|
<div class="links">
|
||||||
|
<navlinks class="can-hide">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks>
|
||||||
|
</div>
|
||||||
|
</navbar>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="sidebar-mask" @click="toggleSidebar(false)">
|
||||||
|
</div>
|
||||||
|
<sidebar @toggle-sidebar="toggleSidebar">
|
||||||
|
|
||||||
|
<navlinks>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks><div id="searchbox" class="searchbox" role="search">
|
||||||
|
<div class="caption"><span class="caption-text">Quick search</span>
|
||||||
|
<div class="searchformwrapper">
|
||||||
|
<form class="search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" />
|
||||||
|
<input type="submit" value="Search" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
<div class="sidebar-group">
|
||||||
|
<p class="caption">
|
||||||
|
<span class="caption-text"><a href="../../index.html#welcome-to-cerc-libs-s-documentation">Contents:</a></span>
|
||||||
|
</p>
|
||||||
|
<ul class="">
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</sidebar>
|
||||||
|
|
||||||
|
<page>
|
||||||
|
<div class="body-header" role="navigation" aria-label="navigation">
|
||||||
|
|
||||||
|
<ul class="breadcrumbs">
|
||||||
|
<li><a href="../../index.html">Docs</a> »</li>
|
||||||
|
|
||||||
|
<li><a href="../index.html">Module code</a> »</li>
|
||||||
|
|
||||||
|
<li>city_model_structure.city</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<ul class="page-nav">
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr>
|
||||||
|
<div class="content" role="main">
|
||||||
|
|
||||||
|
<h1>Source code for city_model_structure.city</h1><div class="highlight"><pre>
|
||||||
|
<span></span><span class="sd">"""</span>
|
||||||
|
<span class="sd">City module</span>
|
||||||
|
<span class="sd">SPDX - License - Identifier: LGPL - 3.0 - or -later</span>
|
||||||
|
<span class="sd">Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="kn">import</span> <span class="nn">sys</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">Union</span>
|
||||||
|
<span class="kn">import</span> <span class="nn">pyproj</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">pyproj</span> <span class="kn">import</span> <span class="n">Transformer</span>
|
||||||
|
<span class="kn">import</span> <span class="nn">reverse_geocoder</span> <span class="k">as</span> <span class="nn">rg</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">city_model_structure.city_object</span> <span class="kn">import</span> <span class="n">CityObject</span>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="City"><a class="viewcode-back" href="../../index.html#city_model_structure.city.City">[docs]</a><span class="k">class</span> <span class="nc">City</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> City class</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
|
||||||
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">lower_corner</span><span class="p">,</span> <span class="n">upper_corner</span><span class="p">,</span> <span class="n">srs_name</span><span class="p">,</span> <span class="n">city_objects</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_city_objects</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_name</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_lower_corner</span> <span class="o">=</span> <span class="n">lower_corner</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_upper_corner</span> <span class="o">=</span> <span class="n">upper_corner</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_city_objects</span> <span class="o">=</span> <span class="n">city_objects</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_srs_name</span> <span class="o">=</span> <span class="n">srs_name</span>
|
||||||
|
<span class="c1"># todo: right now extracted at city level, in the future should be extracted also at building level if exist</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_location</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
|
||||||
|
<span class="k">def</span> <span class="nf">_get_location</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_location</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="n">gps</span> <span class="o">=</span> <span class="n">pyproj</span><span class="o">.</span><span class="n">CRS</span><span class="p">(</span><span class="s1">'EPSG:4326'</span><span class="p">)</span> <span class="c1"># LatLon with WGS84 datum used by GPS units and Google Earth</span>
|
||||||
|
<span class="k">try</span><span class="p">:</span>
|
||||||
|
<span class="n">input_reference</span> <span class="o">=</span> <span class="n">pyproj</span><span class="o">.</span><span class="n">CRS</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">srs_name</span><span class="p">)</span> <span class="c1"># Projected coordinate system from input data</span>
|
||||||
|
<span class="k">except</span> <span class="n">pyproj</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">CRSError</span><span class="p">:</span>
|
||||||
|
<span class="nb">print</span><span class="p">(</span><span class="s1">'Invalid projection reference system, please check the input data. (e.g. in CityGML files: srs_name)'</span><span class="p">)</span>
|
||||||
|
<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">()</span>
|
||||||
|
<span class="n">transformer</span> <span class="o">=</span> <span class="n">Transformer</span><span class="o">.</span><span class="n">from_crs</span><span class="p">(</span><span class="n">input_reference</span><span class="p">,</span> <span class="n">gps</span><span class="p">)</span>
|
||||||
|
<span class="n">coordinates</span> <span class="o">=</span> <span class="n">transformer</span><span class="o">.</span><span class="n">transform</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">lower_corner</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="bp">self</span><span class="o">.</span><span class="n">lower_corner</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_location</span> <span class="o">=</span> <span class="n">rg</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">coordinates</span><span class="p">)</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_location</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">country_code</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> City country code</span>
|
||||||
|
<span class="sd"> :return: str</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_location</span><span class="p">()[</span><span class="mi">0</span><span class="p">][</span><span class="s1">'cc'</span><span class="p">]</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> City name</span>
|
||||||
|
<span class="sd"> :return: str</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_location</span><span class="p">()[</span><span class="mi">0</span><span class="p">][</span><span class="s1">'name'</span><span class="p">]</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_name</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">city_objects</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Union</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="n">CityObject</span><span class="p">],</span> <span class="kc">None</span><span class="p">]:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> CityObjects belonging to the city</span>
|
||||||
|
<span class="sd"> :return: None or a list of CityObjects</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_city_objects</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">lower_corner</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> City lower corner</span>
|
||||||
|
<span class="sd"> :return: [x,y,z]</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lower_corner</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">upper_corner</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> City upper corner</span>
|
||||||
|
<span class="sd"> :return: [x,y,z]</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_upper_corner</span>
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="City.city_object"><a class="viewcode-back" href="../../index.html#city_model_structure.city.City.city_object">[docs]</a> <span class="k">def</span> <span class="nf">city_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> <span class="o">-></span> <span class="n">Union</span><span class="p">[</span><span class="n">CityObject</span><span class="p">,</span> <span class="kc">None</span><span class="p">]:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Retrieve the city CityObject with the given name</span>
|
||||||
|
<span class="sd"> :param name:str</span>
|
||||||
|
<span class="sd"> :return: None or CityObject</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">for</span> <span class="n">city_object</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">city_objects</span><span class="p">:</span>
|
||||||
|
<span class="k">if</span> <span class="n">city_object</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="n">name</span><span class="p">:</span>
|
||||||
|
<span class="k">return</span> <span class="n">city_object</span>
|
||||||
|
<span class="k">return</span> <span class="kc">None</span></div>
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="City.add_city_object"><a class="viewcode-back" href="../../index.html#city_model_structure.city.City.add_city_object">[docs]</a> <span class="k">def</span> <span class="nf">add_city_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">new_city_object</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Add a CityObject to the city</span>
|
||||||
|
<span class="sd"> :param new_city_object:CityObject</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_city_objects</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_city_objects</span> <span class="o">=</span> <span class="p">[]</span>
|
||||||
|
<span class="k">for</span> <span class="n">city_object</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">city_objects</span><span class="p">:</span>
|
||||||
|
<span class="k">for</span> <span class="n">surface</span> <span class="ow">in</span> <span class="n">city_object</span><span class="o">.</span><span class="n">surfaces</span><span class="p">:</span>
|
||||||
|
<span class="k">for</span> <span class="n">surface2</span> <span class="ow">in</span> <span class="n">new_city_object</span><span class="o">.</span><span class="n">surfaces</span><span class="p">:</span>
|
||||||
|
<span class="n">surface</span><span class="o">.</span><span class="n">shared</span><span class="p">(</span><span class="n">surface2</span><span class="p">)</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_city_objects</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">new_city_object</span><span class="p">)</span></div>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">srs_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> srs name</span>
|
||||||
|
<span class="sd"> :return: str</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_srs_name</span>
|
||||||
|
|
||||||
|
<span class="nd">@name</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set the city name</span>
|
||||||
|
<span class="sd"> :param value:str</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_name</span> <span class="o">=</span> <span class="n">value</span></div>
|
||||||
|
</pre></div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="page-nav">
|
||||||
|
<div class="inner"><ul class="page-nav">
|
||||||
|
</ul><div class="footer" role="contentinfo">
|
||||||
|
© Copyright 2020, Guillermo Gutierrez.
|
||||||
|
<br>
|
||||||
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</page>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
436
docs/build/html/_modules/city_model_structure/city_object.html
vendored
Normal file
436
docs/build/html/_modules/city_model_structure/city_object.html
vendored
Normal file
|
|
@ -0,0 +1,436 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
<title>city_model_structure.city_object</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../../_static/pygments.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/theme.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/sphinx_press_theme.css">
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
||||||
|
|
||||||
|
<!-- sphinx script_files -->
|
||||||
|
<script src="../../_static/jquery.js"></script>
|
||||||
|
<script src="../../_static/underscore.js"></script>
|
||||||
|
<script src="../../_static/doctools.js"></script>
|
||||||
|
<script src="../../_static/language_data.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="../../_static/theme-vendors.js"></script>
|
||||||
|
<script src="../../_static/theme.js" defer></script>
|
||||||
|
|
||||||
|
<link rel="index" title="Index" href="../../genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="../../search.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
|
||||||
|
<router-link to="../../index.html" class="home-link">
|
||||||
|
|
||||||
|
<span class="site-name">CERC libs</span>
|
||||||
|
|
||||||
|
</router-link>
|
||||||
|
|
||||||
|
<div class="links">
|
||||||
|
<navlinks class="can-hide">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks>
|
||||||
|
</div>
|
||||||
|
</navbar>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="sidebar-mask" @click="toggleSidebar(false)">
|
||||||
|
</div>
|
||||||
|
<sidebar @toggle-sidebar="toggleSidebar">
|
||||||
|
|
||||||
|
<navlinks>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks><div id="searchbox" class="searchbox" role="search">
|
||||||
|
<div class="caption"><span class="caption-text">Quick search</span>
|
||||||
|
<div class="searchformwrapper">
|
||||||
|
<form class="search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" />
|
||||||
|
<input type="submit" value="Search" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
<div class="sidebar-group">
|
||||||
|
<p class="caption">
|
||||||
|
<span class="caption-text"><a href="../../index.html#welcome-to-cerc-libs-s-documentation">Contents:</a></span>
|
||||||
|
</p>
|
||||||
|
<ul class="">
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</sidebar>
|
||||||
|
|
||||||
|
<page>
|
||||||
|
<div class="body-header" role="navigation" aria-label="navigation">
|
||||||
|
|
||||||
|
<ul class="breadcrumbs">
|
||||||
|
<li><a href="../../index.html">Docs</a> »</li>
|
||||||
|
|
||||||
|
<li><a href="../index.html">Module code</a> »</li>
|
||||||
|
|
||||||
|
<li>city_model_structure.city_object</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<ul class="page-nav">
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr>
|
||||||
|
<div class="content" role="main">
|
||||||
|
|
||||||
|
<h1>Source code for city_model_structure.city_object</h1><div class="highlight"><pre>
|
||||||
|
<span></span><span class="sd">"""</span>
|
||||||
|
<span class="sd">CityObject module</span>
|
||||||
|
<span class="sd">SPDX - License - Identifier: LGPL - 3.0 - or -later</span>
|
||||||
|
<span class="sd">Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Union</span><span class="p">,</span> <span class="n">List</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">Path</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">matplotlib</span> <span class="kn">import</span> <span class="n">pylab</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">city_model_structure.polyhedron</span> <span class="kn">import</span> <span class="n">Polyhedron</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">city_model_structure.thermal_zone</span> <span class="kn">import</span> <span class="n">ThermalZone</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">city_model_structure.thermal_boundary</span> <span class="kn">import</span> <span class="n">ThermalBoundary</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">city_model_structure.surface</span> <span class="kn">import</span> <span class="n">Surface</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">shapely</span> <span class="kn">import</span> <span class="n">ops</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">shapely.geometry</span> <span class="kn">import</span> <span class="n">MultiPolygon</span>
|
||||||
|
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
|
||||||
|
|
||||||
|
<span class="kn">import</span> <span class="nn">matplotlib.patches</span> <span class="k">as</span> <span class="nn">patches</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">helpers.geometry_helper</span> <span class="kn">import</span> <span class="n">GeometryHelper</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">city_model_structure.usage_zone</span> <span class="kn">import</span> <span class="n">UsageZone</span>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="CityObject"><a class="viewcode-back" href="../../index.html#city_model_structure.city_object.CityObject">[docs]</a><span class="k">class</span> <span class="nc">CityObject</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> CityObject class</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">lod</span><span class="p">,</span> <span class="n">surfaces</span><span class="p">,</span> <span class="n">terrains</span><span class="p">,</span> <span class="n">year_of_construction</span><span class="p">,</span> <span class="n">function</span><span class="p">,</span> <span class="n">lower_corner</span><span class="p">,</span> <span class="n">attic_heated</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
|
||||||
|
<span class="n">basement_heated</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_name</span> <span class="o">=</span> <span class="n">name</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_lod</span> <span class="o">=</span> <span class="n">lod</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_surfaces</span> <span class="o">=</span> <span class="n">surfaces</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_polyhedron</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_basement_heated</span> <span class="o">=</span> <span class="n">basement_heated</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_attic_heated</span> <span class="o">=</span> <span class="n">attic_heated</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_terrains</span> <span class="o">=</span> <span class="n">terrains</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_year_of_construction</span> <span class="o">=</span> <span class="n">year_of_construction</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_function</span> <span class="o">=</span> <span class="n">function</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_lower_corner</span> <span class="o">=</span> <span class="n">lower_corner</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_geometry</span> <span class="o">=</span> <span class="n">GeometryHelper</span><span class="p">()</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_average_storey_height</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_storeys_above_ground</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_foot_print</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_usage_zones</span> <span class="o">=</span> <span class="p">[]</span>
|
||||||
|
<span class="c1"># ToDo: this need to be changed when we have other city_objects beside "buildings"</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_type</span> <span class="o">=</span> <span class="s1">'building'</span>
|
||||||
|
|
||||||
|
<span class="c1"># ToDo: Check this for LOD4</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_thermal_zones</span> <span class="o">=</span> <span class="p">[]</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">lod</span> <span class="o"><</span> <span class="mi">8</span><span class="p">:</span>
|
||||||
|
<span class="c1"># for lod under 4 is just one thermal zone</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_thermal_zones</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">ThermalZone</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">surfaces</span><span class="p">))</span>
|
||||||
|
|
||||||
|
<span class="k">for</span> <span class="n">t_zones</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_thermal_zones</span><span class="p">:</span>
|
||||||
|
<span class="n">t_zones</span><span class="o">.</span><span class="n">bounded</span> <span class="o">=</span> <span class="p">[</span><span class="n">ThermalBoundary</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="p">[</span><span class="n">t_zones</span><span class="p">])</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">t_zones</span><span class="o">.</span><span class="n">surfaces</span><span class="p">]</span>
|
||||||
|
<span class="n">surface_id</span> <span class="o">=</span> <span class="mi">0</span>
|
||||||
|
<span class="k">for</span> <span class="n">surface</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_surfaces</span><span class="p">:</span>
|
||||||
|
<span class="n">surface</span><span class="o">.</span><span class="n">lower_corner</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lower_corner</span>
|
||||||
|
<span class="n">surface</span><span class="o">.</span><span class="n">parent</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">surface_id</span><span class="p">)</span>
|
||||||
|
<span class="n">surface_id</span> <span class="o">+=</span> <span class="mi">1</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">usage_zones</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">UsageZone</span><span class="p">]:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get city object usage zones</span>
|
||||||
|
<span class="sd"> :return: [UsageZone]</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_usage_zones</span>
|
||||||
|
|
||||||
|
<span class="nd">@usage_zones</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">usage_zones</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">values</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set city objects usage zones</span>
|
||||||
|
<span class="sd"> :param values: [UsageZones]</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="c1"># ToDo: this is only valid for one usage zone need to be revised for multiple usage zones.</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_usage_zones</span> <span class="o">=</span> <span class="n">values</span>
|
||||||
|
<span class="k">for</span> <span class="n">thermal_zone</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">thermal_zones</span><span class="p">:</span>
|
||||||
|
<span class="n">thermal_zone</span><span class="o">.</span><span class="n">usage_zones</span> <span class="o">=</span> <span class="p">[(</span><span class="mi">100</span><span class="p">,</span> <span class="n">usage_zone</span><span class="p">)</span> <span class="k">for</span> <span class="n">usage_zone</span> <span class="ow">in</span> <span class="n">values</span><span class="p">]</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">terrains</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">Surface</span><span class="p">]:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get city object terrain surfaces</span>
|
||||||
|
<span class="sd"> :return: [Surface]</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_terrains</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">attic_heated</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get if the city object attic is heated</span>
|
||||||
|
<span class="sd"> :return: Boolean</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attic_heated</span>
|
||||||
|
|
||||||
|
<span class="nd">@attic_heated</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">attic_heated</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set if the city object attic is heated</span>
|
||||||
|
<span class="sd"> :param value: Boolean</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_attic_heated</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">basement_heated</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get if the city object basement is heated</span>
|
||||||
|
<span class="sd"> :return: Boolean</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_basement_heated</span>
|
||||||
|
|
||||||
|
<span class="nd">@basement_heated</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">basement_heated</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set if the city object basement is heated</span>
|
||||||
|
<span class="sd"> :param value: Boolean</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_attic_heated</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> City object name</span>
|
||||||
|
<span class="sd"> :return: str</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_name</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">lod</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> City object level of detail 1, 2, 3 or 4</span>
|
||||||
|
<span class="sd"> :return: int</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lod</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">surfaces</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">Surface</span><span class="p">]:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> City object surfaces</span>
|
||||||
|
<span class="sd"> :return: [Surface]</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_surfaces</span>
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="CityObject.surface"><a class="viewcode-back" href="../../index.html#city_model_structure.city_object.CityObject.surface">[docs]</a> <span class="k">def</span> <span class="nf">surface</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> <span class="o">-></span> <span class="n">Union</span><span class="p">[</span><span class="n">Surface</span><span class="p">,</span> <span class="kc">None</span><span class="p">]:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get the city object surface with a given name</span>
|
||||||
|
<span class="sd"> :param name: str</span>
|
||||||
|
<span class="sd"> :return: None or Surface</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">surfaces</span><span class="p">:</span>
|
||||||
|
<span class="k">if</span> <span class="n">s</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="n">name</span><span class="p">:</span>
|
||||||
|
<span class="k">return</span> <span class="n">s</span>
|
||||||
|
<span class="k">return</span> <span class="kc">None</span></div>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">thermal_zones</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">ThermalZone</span><span class="p">]:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> City object thermal zones</span>
|
||||||
|
<span class="sd"> :return: [ThermalZone]</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_thermal_zones</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">volume</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> City object volume in cubic meters</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_polyhedron</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_polyhedron</span> <span class="o">=</span> <span class="n">Polyhedron</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">surfaces</span><span class="p">)</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_polyhedron</span><span class="o">.</span><span class="n">volume</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">heated_volume</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> City object heated volume in cubic meters</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_polyhedron</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_polyhedron</span> <span class="o">=</span> <span class="n">Polyhedron</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">surfaces</span><span class="p">)</span>
|
||||||
|
<span class="c1"># ToDo: this need to be the calculated based on the basement and attic heated values</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_polyhedron</span><span class="o">.</span><span class="n">volume</span>
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="CityObject.stl_export"><a class="viewcode-back" href="../../index.html#city_model_structure.city_object.CityObject.stl_export">[docs]</a> <span class="k">def</span> <span class="nf">stl_export</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Export the city object to stl file (city_object_name.stl) to the given path</span>
|
||||||
|
<span class="sd"> :param path: str</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_polyhedron</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_polyhedron</span> <span class="o">=</span> <span class="n">Polyhedron</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">surfaces</span><span class="p">)</span>
|
||||||
|
<span class="n">full_path</span> <span class="o">=</span> <span class="p">(</span><span class="n">Path</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> <span class="o">/</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_name</span> <span class="o">+</span> <span class="s1">'.stl'</span><span class="p">))</span><span class="o">.</span><span class="n">resolve</span><span class="p">()</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_polyhedron</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">full_path</span><span class="p">)</span></div>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">year_of_construction</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> City object year of construction</span>
|
||||||
|
<span class="sd"> :return: int</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_year_of_construction</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">function</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> City object function</span>
|
||||||
|
<span class="sd"> :return: str</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_function</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">average_storey_height</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get city object average storey height in meters</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_average_storey_height</span>
|
||||||
|
|
||||||
|
<span class="nd">@average_storey_height</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">average_storey_height</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set city object average storey height in meters</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_average_storey_height</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">storeys_above_ground</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get city object storeys number above ground</span>
|
||||||
|
<span class="sd"> :return: int</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_storeys_above_ground</span>
|
||||||
|
|
||||||
|
<span class="nd">@storeys_above_ground</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">storeys_above_ground</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set city object storeys number above ground</span>
|
||||||
|
<span class="sd"> :param value: int</span>
|
||||||
|
<span class="sd"> :return:</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_storeys_above_ground</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@staticmethod</span>
|
||||||
|
<span class="k">def</span> <span class="nf">_tuple_to_point</span><span class="p">(</span><span class="n">xy_tuple</span><span class="p">):</span>
|
||||||
|
<span class="k">return</span> <span class="p">[</span><span class="n">xy_tuple</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">xy_tuple</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="mf">0.0</span><span class="p">]</span>
|
||||||
|
|
||||||
|
<span class="k">def</span> <span class="nf">_plot</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">polygon</span><span class="p">):</span>
|
||||||
|
<span class="n">points</span> <span class="o">=</span> <span class="p">()</span>
|
||||||
|
<span class="k">for</span> <span class="n">point_tuple</span> <span class="ow">in</span> <span class="n">polygon</span><span class="o">.</span><span class="n">exterior</span><span class="o">.</span><span class="n">coords</span><span class="p">:</span>
|
||||||
|
<span class="n">almost_equal</span> <span class="o">=</span> <span class="kc">False</span>
|
||||||
|
<span class="k">for</span> <span class="n">point</span> <span class="ow">in</span> <span class="n">points</span><span class="p">:</span>
|
||||||
|
<span class="n">point_1</span> <span class="o">=</span> <span class="n">CityObject</span><span class="o">.</span><span class="n">_tuple_to_point</span><span class="p">(</span><span class="n">point</span><span class="p">)</span>
|
||||||
|
<span class="n">point_2</span> <span class="o">=</span> <span class="n">CityObject</span><span class="o">.</span><span class="n">_tuple_to_point</span><span class="p">(</span><span class="n">point_tuple</span><span class="p">)</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_geometry</span><span class="o">.</span><span class="n">almost_equal</span><span class="p">(</span><span class="n">point_1</span><span class="p">,</span> <span class="n">point_2</span><span class="p">):</span>
|
||||||
|
<span class="n">almost_equal</span> <span class="o">=</span> <span class="kc">True</span>
|
||||||
|
<span class="k">break</span>
|
||||||
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">almost_equal</span><span class="p">:</span>
|
||||||
|
<span class="n">points</span> <span class="o">=</span> <span class="n">points</span> <span class="o">+</span> <span class="p">(</span><span class="n">point_tuple</span><span class="p">,)</span>
|
||||||
|
<span class="n">points</span> <span class="o">=</span> <span class="n">points</span> <span class="o">+</span> <span class="p">(</span><span class="n">points</span><span class="p">[</span><span class="mi">0</span><span class="p">],)</span>
|
||||||
|
<span class="n">pylab</span><span class="o">.</span><span class="n">scatter</span><span class="p">([</span><span class="n">point</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">point</span> <span class="ow">in</span> <span class="n">points</span><span class="p">],</span> <span class="p">[</span><span class="n">point</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="k">for</span> <span class="n">point</span> <span class="ow">in</span> <span class="n">points</span><span class="p">])</span>
|
||||||
|
<span class="n">pylab</span><span class="o">.</span><span class="n">gca</span><span class="p">()</span><span class="o">.</span><span class="n">add_patch</span><span class="p">(</span><span class="n">patches</span><span class="o">.</span><span class="n">Polygon</span><span class="p">(</span><span class="n">points</span><span class="p">,</span> <span class="n">closed</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">fill</span><span class="o">=</span><span class="kc">True</span><span class="p">))</span>
|
||||||
|
<span class="n">pylab</span><span class="o">.</span><span class="n">grid</span><span class="p">()</span>
|
||||||
|
<span class="n">pylab</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">foot_print</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Surface</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> City object foot print surface</span>
|
||||||
|
<span class="sd"> :return: Surface</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_foot_print</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="n">shapelys</span> <span class="o">=</span> <span class="p">[]</span>
|
||||||
|
<span class="n">union</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="k">for</span> <span class="n">surface</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">surfaces</span><span class="p">:</span>
|
||||||
|
<span class="k">if</span> <span class="n">surface</span><span class="o">.</span><span class="n">shapely</span><span class="o">.</span><span class="n">is_empty</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">surface</span><span class="o">.</span><span class="n">shapely</span><span class="o">.</span><span class="n">is_valid</span><span class="p">:</span>
|
||||||
|
<span class="k">continue</span>
|
||||||
|
<span class="n">shapelys</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">surface</span><span class="o">.</span><span class="n">shapely</span><span class="p">)</span>
|
||||||
|
<span class="n">union</span> <span class="o">=</span> <span class="n">ops</span><span class="o">.</span><span class="n">unary_union</span><span class="p">(</span><span class="n">shapelys</span><span class="p">)</span>
|
||||||
|
<span class="n">shapelys</span> <span class="o">=</span> <span class="p">[</span><span class="n">union</span><span class="p">]</span>
|
||||||
|
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">union</span><span class="p">,</span> <span class="n">MultiPolygon</span><span class="p">):</span>
|
||||||
|
<span class="ne">Exception</span><span class="p">(</span><span class="s1">'foot print returns a multipolygon'</span><span class="p">)</span>
|
||||||
|
<span class="n">points_list</span> <span class="o">=</span> <span class="p">[]</span>
|
||||||
|
<span class="k">for</span> <span class="n">point_tuple</span> <span class="ow">in</span> <span class="n">union</span><span class="o">.</span><span class="n">exterior</span><span class="o">.</span><span class="n">coords</span><span class="p">:</span>
|
||||||
|
<span class="c1"># ToDo: should be Z 0.0 or min Z?</span>
|
||||||
|
<span class="n">point</span> <span class="o">=</span> <span class="n">CityObject</span><span class="o">.</span><span class="n">_tuple_to_point</span><span class="p">(</span><span class="n">point_tuple</span><span class="p">)</span>
|
||||||
|
<span class="n">almost_equal</span> <span class="o">=</span> <span class="kc">False</span>
|
||||||
|
<span class="k">for</span> <span class="n">existing_point</span> <span class="ow">in</span> <span class="n">points_list</span><span class="p">:</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_geometry</span><span class="o">.</span><span class="n">almost_equal</span><span class="p">(</span><span class="n">point</span><span class="p">,</span> <span class="n">existing_point</span><span class="p">):</span>
|
||||||
|
<span class="n">almost_equal</span> <span class="o">=</span> <span class="kc">True</span>
|
||||||
|
<span class="k">break</span>
|
||||||
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">almost_equal</span><span class="p">:</span>
|
||||||
|
<span class="n">points_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">point</span><span class="p">)</span>
|
||||||
|
<span class="n">points_list</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">points_list</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">points_list</span><span class="p">)</span> <span class="o">*</span> <span class="mi">3</span><span class="p">)</span>
|
||||||
|
<span class="n">points</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array_str</span><span class="p">(</span><span class="n">points_list</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'['</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">']'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_foot_print</span> <span class="o">=</span> <span class="n">Surface</span><span class="p">(</span><span class="n">points</span><span class="p">,</span> <span class="n">remove_last</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">is_projected</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_foot_print</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">type</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> City object type</span>
|
||||||
|
<span class="sd"> :return: str</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_type</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">max_height</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> City object maximal height in meters</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_polyhedron</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_polyhedron</span> <span class="o">=</span> <span class="n">Polyhedron</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">surfaces</span><span class="p">)</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_polyhedron</span><span class="o">.</span><span class="n">max_z</span></div>
|
||||||
|
</pre></div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="page-nav">
|
||||||
|
<div class="inner"><ul class="page-nav">
|
||||||
|
</ul><div class="footer" role="contentinfo">
|
||||||
|
© Copyright 2020, Guillermo Gutierrez.
|
||||||
|
<br>
|
||||||
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</page>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
202
docs/build/html/_modules/city_model_structure/internal_gains.html
vendored
Normal file
202
docs/build/html/_modules/city_model_structure/internal_gains.html
vendored
Normal file
|
|
@ -0,0 +1,202 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
<title>city_model_structure.internal_gains</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../../_static/pygments.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/theme.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/sphinx_press_theme.css">
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
||||||
|
|
||||||
|
<!-- sphinx script_files -->
|
||||||
|
<script src="../../_static/jquery.js"></script>
|
||||||
|
<script src="../../_static/underscore.js"></script>
|
||||||
|
<script src="../../_static/doctools.js"></script>
|
||||||
|
<script src="../../_static/language_data.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="../../_static/theme-vendors.js"></script>
|
||||||
|
<script src="../../_static/theme.js" defer></script>
|
||||||
|
|
||||||
|
<link rel="index" title="Index" href="../../genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="../../search.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
|
||||||
|
<router-link to="../../index.html" class="home-link">
|
||||||
|
|
||||||
|
<span class="site-name">CERC libs</span>
|
||||||
|
|
||||||
|
</router-link>
|
||||||
|
|
||||||
|
<div class="links">
|
||||||
|
<navlinks class="can-hide">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks>
|
||||||
|
</div>
|
||||||
|
</navbar>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="sidebar-mask" @click="toggleSidebar(false)">
|
||||||
|
</div>
|
||||||
|
<sidebar @toggle-sidebar="toggleSidebar">
|
||||||
|
|
||||||
|
<navlinks>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks><div id="searchbox" class="searchbox" role="search">
|
||||||
|
<div class="caption"><span class="caption-text">Quick search</span>
|
||||||
|
<div class="searchformwrapper">
|
||||||
|
<form class="search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" />
|
||||||
|
<input type="submit" value="Search" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
<div class="sidebar-group">
|
||||||
|
<p class="caption">
|
||||||
|
<span class="caption-text"><a href="../../index.html#welcome-to-cerc-libs-s-documentation">Contents:</a></span>
|
||||||
|
</p>
|
||||||
|
<ul class="">
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</sidebar>
|
||||||
|
|
||||||
|
<page>
|
||||||
|
<div class="body-header" role="navigation" aria-label="navigation">
|
||||||
|
|
||||||
|
<ul class="breadcrumbs">
|
||||||
|
<li><a href="../../index.html">Docs</a> »</li>
|
||||||
|
|
||||||
|
<li><a href="../index.html">Module code</a> »</li>
|
||||||
|
|
||||||
|
<li>city_model_structure.internal_gains</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<ul class="page-nav">
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr>
|
||||||
|
<div class="content" role="main">
|
||||||
|
|
||||||
|
<h1>Source code for city_model_structure.internal_gains</h1><div class="highlight"><pre>
|
||||||
|
<span></span><span class="sd">"""</span>
|
||||||
|
<span class="sd">InternalGains module</span>
|
||||||
|
<span class="sd">SPDX - License - Identifier: LGPL - 3.0 - or -later</span>
|
||||||
|
<span class="sd">Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="InternalGains"><a class="viewcode-back" href="../../index.html#city_model_structure.internal_gains.InternalGains">[docs]</a><span class="k">class</span> <span class="nc">InternalGains</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> InternalGains class</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_average_internal_gain</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_convective_fraction</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_radiative_fraction</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_latent_fraction</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">average_internal_gain</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get internal gains average internal gain in w/m2</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_average_internal_gain</span>
|
||||||
|
|
||||||
|
<span class="nd">@average_internal_gain</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">average_internal_gain</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set internal gains average internal gain in w/m2</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_average_internal_gain</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">convective_fraction</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get internal gains convective fraction</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_convective_fraction</span>
|
||||||
|
|
||||||
|
<span class="nd">@convective_fraction</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">convective_fraction</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set internal gains convective fraction</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_convective_fraction</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">radiative_fraction</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get internal gains radiative fraction</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_radiative_fraction</span>
|
||||||
|
|
||||||
|
<span class="nd">@radiative_fraction</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">radiative_fraction</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set internal gains convective fraction</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_radiative_fraction</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">latent_fraction</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get internal gains latent fraction</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_latent_fraction</span>
|
||||||
|
|
||||||
|
<span class="nd">@latent_fraction</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">latent_fraction</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set internal gains latent fraction</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_latent_fraction</span> <span class="o">=</span> <span class="n">value</span></div>
|
||||||
|
</pre></div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="page-nav">
|
||||||
|
<div class="inner"><ul class="page-nav">
|
||||||
|
</ul><div class="footer" role="contentinfo">
|
||||||
|
© Copyright 2020, Guillermo Gutierrez.
|
||||||
|
<br>
|
||||||
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</page>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
167
docs/build/html/_modules/city_model_structure/layer.html
vendored
Normal file
167
docs/build/html/_modules/city_model_structure/layer.html
vendored
Normal file
|
|
@ -0,0 +1,167 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
<title>city_model_structure.layer</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../../_static/pygments.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/theme.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/sphinx_press_theme.css">
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
||||||
|
|
||||||
|
<!-- sphinx script_files -->
|
||||||
|
<script src="../../_static/jquery.js"></script>
|
||||||
|
<script src="../../_static/underscore.js"></script>
|
||||||
|
<script src="../../_static/doctools.js"></script>
|
||||||
|
<script src="../../_static/language_data.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="../../_static/theme-vendors.js"></script>
|
||||||
|
<script src="../../_static/theme.js" defer></script>
|
||||||
|
|
||||||
|
<link rel="index" title="Index" href="../../genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="../../search.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
|
||||||
|
<router-link to="../../index.html" class="home-link">
|
||||||
|
|
||||||
|
<span class="site-name">CERC libs</span>
|
||||||
|
|
||||||
|
</router-link>
|
||||||
|
|
||||||
|
<div class="links">
|
||||||
|
<navlinks class="can-hide">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks>
|
||||||
|
</div>
|
||||||
|
</navbar>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="sidebar-mask" @click="toggleSidebar(false)">
|
||||||
|
</div>
|
||||||
|
<sidebar @toggle-sidebar="toggleSidebar">
|
||||||
|
|
||||||
|
<navlinks>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks><div id="searchbox" class="searchbox" role="search">
|
||||||
|
<div class="caption"><span class="caption-text">Quick search</span>
|
||||||
|
<div class="searchformwrapper">
|
||||||
|
<form class="search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" />
|
||||||
|
<input type="submit" value="Search" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
<div class="sidebar-group">
|
||||||
|
<p class="caption">
|
||||||
|
<span class="caption-text"><a href="../../index.html#welcome-to-cerc-libs-s-documentation">Contents:</a></span>
|
||||||
|
</p>
|
||||||
|
<ul class="">
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</sidebar>
|
||||||
|
|
||||||
|
<page>
|
||||||
|
<div class="body-header" role="navigation" aria-label="navigation">
|
||||||
|
|
||||||
|
<ul class="breadcrumbs">
|
||||||
|
<li><a href="../../index.html">Docs</a> »</li>
|
||||||
|
|
||||||
|
<li><a href="../index.html">Module code</a> »</li>
|
||||||
|
|
||||||
|
<li>city_model_structure.layer</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<ul class="page-nav">
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr>
|
||||||
|
<div class="content" role="main">
|
||||||
|
|
||||||
|
<h1>Source code for city_model_structure.layer</h1><div class="highlight"><pre>
|
||||||
|
<span></span><span class="sd">"""</span>
|
||||||
|
<span class="sd">Layers module</span>
|
||||||
|
<span class="sd">SPDX - License - Identifier: LGPL - 3.0 - or -later</span>
|
||||||
|
<span class="sd">Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">city_model_structure.material</span> <span class="kn">import</span> <span class="n">Material</span>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="Layer"><a class="viewcode-back" href="../../index.html#city_model_structure.layer.Layer">[docs]</a><span class="k">class</span> <span class="nc">Layer</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Layer class</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_material</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_thickness</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">material</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Material</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get layer material</span>
|
||||||
|
<span class="sd"> :return: Material</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_material</span>
|
||||||
|
|
||||||
|
<span class="nd">@material</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">material</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set layer material</span>
|
||||||
|
<span class="sd"> :param value: Material</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_material</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">thickness</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get layer thickness in meters</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_thickness</span>
|
||||||
|
|
||||||
|
<span class="nd">@thickness</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">thickness</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get layer thickness in meters</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_thickness</span> <span class="o">=</span> <span class="n">value</span></div>
|
||||||
|
</pre></div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="page-nav">
|
||||||
|
<div class="inner"><ul class="page-nav">
|
||||||
|
</ul><div class="footer" role="contentinfo">
|
||||||
|
© Copyright 2020, Guillermo Gutierrez.
|
||||||
|
<br>
|
||||||
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</page>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
274
docs/build/html/_modules/city_model_structure/material.html
vendored
Normal file
274
docs/build/html/_modules/city_model_structure/material.html
vendored
Normal file
|
|
@ -0,0 +1,274 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
<title>city_model_structure.material</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../../_static/pygments.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/theme.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/sphinx_press_theme.css">
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
||||||
|
|
||||||
|
<!-- sphinx script_files -->
|
||||||
|
<script src="../../_static/jquery.js"></script>
|
||||||
|
<script src="../../_static/underscore.js"></script>
|
||||||
|
<script src="../../_static/doctools.js"></script>
|
||||||
|
<script src="../../_static/language_data.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="../../_static/theme-vendors.js"></script>
|
||||||
|
<script src="../../_static/theme.js" defer></script>
|
||||||
|
|
||||||
|
<link rel="index" title="Index" href="../../genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="../../search.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
|
||||||
|
<router-link to="../../index.html" class="home-link">
|
||||||
|
|
||||||
|
<span class="site-name">CERC libs</span>
|
||||||
|
|
||||||
|
</router-link>
|
||||||
|
|
||||||
|
<div class="links">
|
||||||
|
<navlinks class="can-hide">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks>
|
||||||
|
</div>
|
||||||
|
</navbar>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="sidebar-mask" @click="toggleSidebar(false)">
|
||||||
|
</div>
|
||||||
|
<sidebar @toggle-sidebar="toggleSidebar">
|
||||||
|
|
||||||
|
<navlinks>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks><div id="searchbox" class="searchbox" role="search">
|
||||||
|
<div class="caption"><span class="caption-text">Quick search</span>
|
||||||
|
<div class="searchformwrapper">
|
||||||
|
<form class="search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" />
|
||||||
|
<input type="submit" value="Search" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
<div class="sidebar-group">
|
||||||
|
<p class="caption">
|
||||||
|
<span class="caption-text"><a href="../../index.html#welcome-to-cerc-libs-s-documentation">Contents:</a></span>
|
||||||
|
</p>
|
||||||
|
<ul class="">
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</sidebar>
|
||||||
|
|
||||||
|
<page>
|
||||||
|
<div class="body-header" role="navigation" aria-label="navigation">
|
||||||
|
|
||||||
|
<ul class="breadcrumbs">
|
||||||
|
<li><a href="../../index.html">Docs</a> »</li>
|
||||||
|
|
||||||
|
<li><a href="../index.html">Module code</a> »</li>
|
||||||
|
|
||||||
|
<li>city_model_structure.material</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<ul class="page-nav">
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr>
|
||||||
|
<div class="content" role="main">
|
||||||
|
|
||||||
|
<h1>Source code for city_model_structure.material</h1><div class="highlight"><pre>
|
||||||
|
<span></span><span class="sd">"""</span>
|
||||||
|
<span class="sd">Material module</span>
|
||||||
|
<span class="sd">SPDX - License - Identifier: LGPL - 3.0 - or -later</span>
|
||||||
|
<span class="sd">Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="Material"><a class="viewcode-back" href="../../index.html#city_model_structure.material.Material">[docs]</a><span class="k">class</span> <span class="nc">Material</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Material class</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_conductivity</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_specific_heat</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_density</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_solar_absorptance</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_thermal_absorptance</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_visible_absorptance</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_no_mass</span> <span class="o">=</span> <span class="kc">False</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_thermal_resistance</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">conductivity</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get material conductivity in W/mK</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conductivity</span>
|
||||||
|
|
||||||
|
<span class="nd">@conductivity</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">conductivity</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set material conductivity in W/mK</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_conductivity</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">specific_heat</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get material conductivity in J/kgK</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_specific_heat</span>
|
||||||
|
|
||||||
|
<span class="nd">@specific_heat</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">specific_heat</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get material conductivity in J/kgK</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_specific_heat</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">density</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get material density in kg/m3</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_density</span>
|
||||||
|
|
||||||
|
<span class="nd">@density</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">density</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set material density in kg/m3</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_density</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">solar_absorptance</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get material solar absorptance</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_solar_absorptance</span>
|
||||||
|
|
||||||
|
<span class="nd">@solar_absorptance</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">solar_absorptance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set material solar absorptance</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_solar_absorptance</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">thermal_absorptance</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get material thermal absorptance</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_thermal_absorptance</span>
|
||||||
|
|
||||||
|
<span class="nd">@thermal_absorptance</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">thermal_absorptance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set material thermal absorptance</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_thermal_absorptance</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">visible_absorptance</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get material visible absorptance</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_visible_absorptance</span>
|
||||||
|
|
||||||
|
<span class="nd">@visible_absorptance</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">visible_absorptance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set material visible absorptance</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_visible_absorptance</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">no_mass</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get material no mass flag</span>
|
||||||
|
<span class="sd"> :return: Boolean</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_no_mass</span>
|
||||||
|
|
||||||
|
<span class="nd">@no_mass</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">no_mass</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set material no mass flag</span>
|
||||||
|
<span class="sd"> :param value: Boolean</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_no_mass</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">thermal_resistance</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get material thermal resistance in m2K/W</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_thermal_resistance</span>
|
||||||
|
|
||||||
|
<span class="nd">@thermal_resistance</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">thermal_resistance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set material thermal resistance in m2K/W</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_thermal_resistance</span> <span class="o">=</span> <span class="n">value</span></div>
|
||||||
|
</pre></div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="page-nav">
|
||||||
|
<div class="inner"><ul class="page-nav">
|
||||||
|
</ul><div class="footer" role="contentinfo">
|
||||||
|
© Copyright 2020, Guillermo Gutierrez.
|
||||||
|
<br>
|
||||||
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</page>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
221
docs/build/html/_modules/city_model_structure/polyhedron.html
vendored
Normal file
221
docs/build/html/_modules/city_model_structure/polyhedron.html
vendored
Normal file
|
|
@ -0,0 +1,221 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
<title>city_model_structure.polyhedron</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../../_static/pygments.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/theme.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/sphinx_press_theme.css">
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
||||||
|
|
||||||
|
<!-- sphinx script_files -->
|
||||||
|
<script src="../../_static/jquery.js"></script>
|
||||||
|
<script src="../../_static/underscore.js"></script>
|
||||||
|
<script src="../../_static/doctools.js"></script>
|
||||||
|
<script src="../../_static/language_data.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="../../_static/theme-vendors.js"></script>
|
||||||
|
<script src="../../_static/theme.js" defer></script>
|
||||||
|
|
||||||
|
<link rel="index" title="Index" href="../../genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="../../search.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
|
||||||
|
<router-link to="../../index.html" class="home-link">
|
||||||
|
|
||||||
|
<span class="site-name">CERC libs</span>
|
||||||
|
|
||||||
|
</router-link>
|
||||||
|
|
||||||
|
<div class="links">
|
||||||
|
<navlinks class="can-hide">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks>
|
||||||
|
</div>
|
||||||
|
</navbar>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="sidebar-mask" @click="toggleSidebar(false)">
|
||||||
|
</div>
|
||||||
|
<sidebar @toggle-sidebar="toggleSidebar">
|
||||||
|
|
||||||
|
<navlinks>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks><div id="searchbox" class="searchbox" role="search">
|
||||||
|
<div class="caption"><span class="caption-text">Quick search</span>
|
||||||
|
<div class="searchformwrapper">
|
||||||
|
<form class="search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" />
|
||||||
|
<input type="submit" value="Search" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
<div class="sidebar-group">
|
||||||
|
<p class="caption">
|
||||||
|
<span class="caption-text"><a href="../../index.html#welcome-to-cerc-libs-s-documentation">Contents:</a></span>
|
||||||
|
</p>
|
||||||
|
<ul class="">
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</sidebar>
|
||||||
|
|
||||||
|
<page>
|
||||||
|
<div class="body-header" role="navigation" aria-label="navigation">
|
||||||
|
|
||||||
|
<ul class="breadcrumbs">
|
||||||
|
<li><a href="../../index.html">Docs</a> »</li>
|
||||||
|
|
||||||
|
<li><a href="../index.html">Module code</a> »</li>
|
||||||
|
|
||||||
|
<li>city_model_structure.polyhedron</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<ul class="page-nav">
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr>
|
||||||
|
<div class="content" role="main">
|
||||||
|
|
||||||
|
<h1>Source code for city_model_structure.polyhedron</h1><div class="highlight"><pre>
|
||||||
|
<span></span><span class="sd">"""</span>
|
||||||
|
<span class="sd">Polyhedron module</span>
|
||||||
|
<span class="sd">SPDX - License - Identifier: LGPL - 3.0 - or -later</span>
|
||||||
|
<span class="sd">Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
|
||||||
|
<span class="kn">import</span> <span class="nn">stl</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">helpers.geometry_helper</span> <span class="kn">import</span> <span class="n">GeometryHelper</span>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="Polyhedron"><a class="viewcode-back" href="../../index.html#city_model_structure.polyhedron.Polyhedron">[docs]</a><span class="k">class</span> <span class="nc">Polyhedron</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Polyhedron class</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">surfaces</span><span class="p">):</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_surfaces</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">surfaces</span><span class="p">)</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_polygons</span> <span class="o">=</span> <span class="p">[</span><span class="n">s</span><span class="o">.</span><span class="n">polygon</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">surfaces</span><span class="p">]</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_polyhedron</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_volume</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_faces</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_vertices</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_mesh</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_geometry</span> <span class="o">=</span> <span class="n">GeometryHelper</span><span class="p">()</span>
|
||||||
|
|
||||||
|
<span class="k">def</span> <span class="nf">_position_of</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">point</span><span class="p">):</span>
|
||||||
|
<span class="n">vertices</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">vertices</span>
|
||||||
|
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">vertices</span><span class="p">):</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_geometry</span><span class="o">.</span><span class="n">almost_equal</span><span class="p">(</span><span class="n">vertices</span><span class="p">[</span><span class="n">i</span><span class="p">],</span> <span class="n">point</span><span class="p">):</span>
|
||||||
|
<span class="k">return</span> <span class="n">i</span>
|
||||||
|
<span class="k">return</span> <span class="o">-</span><span class="mi">1</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">vertices</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Polyhedron vertices</span>
|
||||||
|
<span class="sd"> :return: np.ndarray(int)</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_vertices</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="n">vertices</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_vertices</span> <span class="o">=</span> <span class="p">[],</span> <span class="p">[]</span>
|
||||||
|
<span class="n">_</span> <span class="o">=</span> <span class="p">[</span><span class="n">vertices</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">s</span><span class="o">.</span><span class="n">points</span><span class="p">)</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_surfaces</span><span class="p">]</span>
|
||||||
|
<span class="k">for</span> <span class="n">vertex_1</span> <span class="ow">in</span> <span class="n">vertices</span><span class="p">:</span>
|
||||||
|
<span class="n">found</span> <span class="o">=</span> <span class="kc">False</span>
|
||||||
|
<span class="k">for</span> <span class="n">vertex_2</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_vertices</span><span class="p">:</span>
|
||||||
|
<span class="n">found</span> <span class="o">=</span> <span class="kc">False</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_geometry</span><span class="o">.</span><span class="n">almost_equal</span><span class="p">(</span><span class="n">vertex_1</span><span class="p">,</span> <span class="n">vertex_2</span><span class="p">):</span>
|
||||||
|
<span class="n">found</span> <span class="o">=</span> <span class="kc">True</span>
|
||||||
|
<span class="k">break</span>
|
||||||
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">found</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_vertices</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">vertex_1</span><span class="p">)</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_vertices</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_vertices</span><span class="p">)</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_vertices</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">faces</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Polyhedron faces</span>
|
||||||
|
<span class="sd"> :return: np.ndarray([int])</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_faces</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_faces</span> <span class="o">=</span> <span class="p">[]</span>
|
||||||
|
<span class="k">for</span> <span class="n">surface</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_surfaces</span><span class="p">:</span>
|
||||||
|
<span class="n">face</span> <span class="o">=</span> <span class="p">[]</span>
|
||||||
|
<span class="n">points</span> <span class="o">=</span> <span class="n">surface</span><span class="o">.</span><span class="n">points</span>
|
||||||
|
<span class="k">for</span> <span class="n">point</span> <span class="ow">in</span> <span class="n">points</span><span class="p">:</span>
|
||||||
|
<span class="n">face</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_position_of</span><span class="p">(</span><span class="n">point</span><span class="p">))</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_faces</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">face</span><span class="p">)</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_faces</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_faces</span><span class="p">)</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_faces</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">_polyhedron_mesh</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_mesh</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_mesh</span> <span class="o">=</span> <span class="n">stl</span><span class="o">.</span><span class="n">mesh</span><span class="o">.</span><span class="n">Mesh</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">faces</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">dtype</span><span class="o">=</span><span class="n">stl</span><span class="o">.</span><span class="n">mesh</span><span class="o">.</span><span class="n">Mesh</span><span class="o">.</span><span class="n">dtype</span><span class="p">))</span>
|
||||||
|
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">faces</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">faces</span><span class="p">):</span>
|
||||||
|
<span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">3</span><span class="p">):</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_mesh</span><span class="o">.</span><span class="n">vectors</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="n">j</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">vertices</span><span class="p">[</span><span class="n">faces</span><span class="p">[</span><span class="n">j</span><span class="p">],</span> <span class="p">:]</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_mesh</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">volume</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Polyhedron volume in cubic meters</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_volume</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_volume</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_polyhedron_mesh</span><span class="o">.</span><span class="n">get_mass_properties</span><span class="p">()</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_volume</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">max_z</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Polyhedron maximal z value</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_polyhedron_mesh</span><span class="o">.</span><span class="n">z</span><span class="o">.</span><span class="n">max</span><span class="p">()</span>
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="Polyhedron.save"><a class="viewcode-back" href="../../index.html#city_model_structure.polyhedron.Polyhedron.save">[docs]</a> <span class="k">def</span> <span class="nf">save</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">full_path</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Export the polyhedron to stl given file</span>
|
||||||
|
<span class="sd"> :param full_path: str</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_polyhedron_mesh</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">full_path</span><span class="p">)</span></div></div>
|
||||||
|
</pre></div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="page-nav">
|
||||||
|
<div class="inner"><ul class="page-nav">
|
||||||
|
</ul><div class="footer" role="contentinfo">
|
||||||
|
© Copyright 2020, Guillermo Gutierrez.
|
||||||
|
<br>
|
||||||
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</page>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
539
docs/build/html/_modules/city_model_structure/surface.html
vendored
Normal file
539
docs/build/html/_modules/city_model_structure/surface.html
vendored
Normal file
|
|
@ -0,0 +1,539 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
<title>city_model_structure.surface</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../../_static/pygments.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/theme.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/sphinx_press_theme.css">
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
||||||
|
|
||||||
|
<!-- sphinx script_files -->
|
||||||
|
<script src="../../_static/jquery.js"></script>
|
||||||
|
<script src="../../_static/underscore.js"></script>
|
||||||
|
<script src="../../_static/doctools.js"></script>
|
||||||
|
<script src="../../_static/language_data.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="../../_static/theme-vendors.js"></script>
|
||||||
|
<script src="../../_static/theme.js" defer></script>
|
||||||
|
|
||||||
|
<link rel="index" title="Index" href="../../genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="../../search.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
|
||||||
|
<router-link to="../../index.html" class="home-link">
|
||||||
|
|
||||||
|
<span class="site-name">CERC libs</span>
|
||||||
|
|
||||||
|
</router-link>
|
||||||
|
|
||||||
|
<div class="links">
|
||||||
|
<navlinks class="can-hide">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks>
|
||||||
|
</div>
|
||||||
|
</navbar>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="sidebar-mask" @click="toggleSidebar(false)">
|
||||||
|
</div>
|
||||||
|
<sidebar @toggle-sidebar="toggleSidebar">
|
||||||
|
|
||||||
|
<navlinks>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks><div id="searchbox" class="searchbox" role="search">
|
||||||
|
<div class="caption"><span class="caption-text">Quick search</span>
|
||||||
|
<div class="searchformwrapper">
|
||||||
|
<form class="search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" />
|
||||||
|
<input type="submit" value="Search" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
<div class="sidebar-group">
|
||||||
|
<p class="caption">
|
||||||
|
<span class="caption-text"><a href="../../index.html#welcome-to-cerc-libs-s-documentation">Contents:</a></span>
|
||||||
|
</p>
|
||||||
|
<ul class="">
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</sidebar>
|
||||||
|
|
||||||
|
<page>
|
||||||
|
<div class="body-header" role="navigation" aria-label="navigation">
|
||||||
|
|
||||||
|
<ul class="breadcrumbs">
|
||||||
|
<li><a href="../../index.html">Docs</a> »</li>
|
||||||
|
|
||||||
|
<li><a href="../index.html">Module code</a> »</li>
|
||||||
|
|
||||||
|
<li>city_model_structure.surface</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<ul class="page-nav">
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr>
|
||||||
|
<div class="content" role="main">
|
||||||
|
|
||||||
|
<h1>Source code for city_model_structure.surface</h1><div class="highlight"><pre>
|
||||||
|
<span></span><span class="sd">"""</span>
|
||||||
|
<span class="sd">Surface module</span>
|
||||||
|
<span class="sd">SPDX - License - Identifier: LGPL - 3.0 - or -later</span>
|
||||||
|
<span class="sd">Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Union</span>
|
||||||
|
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
|
||||||
|
<span class="kn">import</span> <span class="nn">pyny3d.geoms</span> <span class="k">as</span> <span class="nn">pn</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">helpers.geometry_helper</span> <span class="kn">import</span> <span class="n">GeometryHelper</span>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="Surface"><a class="viewcode-back" href="../../index.html#city_model_structure.surface.Surface">[docs]</a><span class="k">class</span> <span class="nc">Surface</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Surface class</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">coordinates</span><span class="p">,</span> <span class="n">surface_type</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">swr</span><span class="o">=</span><span class="s1">'0.2'</span><span class="p">,</span> <span class="n">remove_last</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">is_projected</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_coordinates</span> <span class="o">=</span> <span class="n">coordinates</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_type</span> <span class="o">=</span> <span class="n">surface_type</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_name</span> <span class="o">=</span> <span class="n">name</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_swr</span> <span class="o">=</span> <span class="n">swr</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_remove_last</span> <span class="o">=</span> <span class="n">remove_last</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_is_projected</span> <span class="o">=</span> <span class="n">is_projected</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_geometry_helper</span> <span class="o">=</span> <span class="n">GeometryHelper</span><span class="p">()</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_polygon</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_ground_polygon</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_area</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_points</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_ground_points</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_points_list</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_normal</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_azimuth</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_inclination</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_area_above_ground</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_area_below_ground</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_parent</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_shapely</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_projected_surface</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_min_x</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_min_y</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_min_z</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_shared_surfaces</span> <span class="o">=</span> <span class="p">[]</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_global_irradiance_hour</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="mi">8760</span><span class="p">)</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_global_irradiance_month</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="mi">12</span><span class="p">)</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_ground_coordinates</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">min_x</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">min_y</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">min_z</span><span class="p">)</span>
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="Surface.parent"><a class="viewcode-back" href="../../index.html#city_model_structure.surface.Surface.parent">[docs]</a> <span class="k">def</span> <span class="nf">parent</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="p">,</span> <span class="n">surface_id</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Assign a city object as surface parent and a surface id</span>
|
||||||
|
<span class="sd"> :param parent: CityObject</span>
|
||||||
|
<span class="sd"> :param surface_id: str</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_parent</span> <span class="o">=</span> <span class="n">parent</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_name</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">surface_id</span><span class="p">)</span></div>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Surface name</span>
|
||||||
|
<span class="sd"> :return: str</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'surface has no name'</span><span class="p">)</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_name</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">swr</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get surface short wave reflectance</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_swr</span>
|
||||||
|
|
||||||
|
<span class="nd">@swr</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">swr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set surface short wave reflectance</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_swr</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">points</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Surface point matrix</span>
|
||||||
|
<span class="sd"> :return: np.ndarray</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_points</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_points</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_coordinates</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">float</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s1">' '</span><span class="p">)</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_points</span> <span class="o">=</span> <span class="n">GeometryHelper</span><span class="o">.</span><span class="n">to_points_matrix</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_points</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_remove_last</span><span class="p">)</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_points</span>
|
||||||
|
|
||||||
|
<span class="k">def</span> <span class="nf">_min_coord</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">axis</span><span class="p">):</span>
|
||||||
|
<span class="k">if</span> <span class="n">axis</span> <span class="o">==</span> <span class="s1">'x'</span><span class="p">:</span>
|
||||||
|
<span class="n">axis</span> <span class="o">=</span> <span class="mi">0</span>
|
||||||
|
<span class="k">elif</span> <span class="n">axis</span> <span class="o">==</span> <span class="s1">'y'</span><span class="p">:</span>
|
||||||
|
<span class="n">axis</span> <span class="o">=</span> <span class="mi">1</span>
|
||||||
|
<span class="k">else</span><span class="p">:</span>
|
||||||
|
<span class="n">axis</span> <span class="o">=</span> <span class="mi">2</span>
|
||||||
|
<span class="n">min_coordinate</span> <span class="o">=</span> <span class="s1">''</span>
|
||||||
|
<span class="k">for</span> <span class="n">point</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">points</span><span class="p">:</span>
|
||||||
|
<span class="k">if</span> <span class="n">min_coordinate</span> <span class="o">==</span> <span class="s1">''</span><span class="p">:</span>
|
||||||
|
<span class="n">min_coordinate</span> <span class="o">=</span> <span class="n">point</span><span class="p">[</span><span class="n">axis</span><span class="p">]</span>
|
||||||
|
<span class="k">elif</span> <span class="n">min_coordinate</span> <span class="o">></span> <span class="n">point</span><span class="p">[</span><span class="n">axis</span><span class="p">]:</span>
|
||||||
|
<span class="n">min_coordinate</span> <span class="o">=</span> <span class="n">point</span><span class="p">[</span><span class="n">axis</span><span class="p">]</span>
|
||||||
|
<span class="k">return</span> <span class="n">min_coordinate</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">min_x</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Surface minimal x value</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_min_x</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_min_x</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_min_coord</span><span class="p">(</span><span class="s1">'x'</span><span class="p">)</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_min_x</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">min_y</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Surface minimal y value</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_min_y</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_min_y</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_min_coord</span><span class="p">(</span><span class="s1">'y'</span><span class="p">)</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_min_y</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">min_z</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Surface minimal z value</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_min_z</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_min_z</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_min_coord</span><span class="p">(</span><span class="s1">'z'</span><span class="p">)</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_min_z</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">ground_points</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Surface grounded points matrix</span>
|
||||||
|
<span class="sd"> :return: np.ndarray</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ground_points</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="n">coordinates</span> <span class="o">=</span> <span class="s1">''</span>
|
||||||
|
<span class="k">for</span> <span class="n">point</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">points</span><span class="p">:</span>
|
||||||
|
<span class="n">x</span> <span class="o">=</span> <span class="n">point</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ground_coordinates</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
|
||||||
|
<span class="n">y</span> <span class="o">=</span> <span class="n">point</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ground_coordinates</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
|
||||||
|
<span class="n">z</span> <span class="o">=</span> <span class="n">point</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ground_coordinates</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
|
||||||
|
<span class="k">if</span> <span class="n">coordinates</span> <span class="o">!=</span> <span class="s1">''</span><span class="p">:</span>
|
||||||
|
<span class="n">coordinates</span> <span class="o">=</span> <span class="n">coordinates</span> <span class="o">+</span> <span class="s1">' '</span>
|
||||||
|
<span class="n">coordinates</span> <span class="o">=</span> <span class="n">coordinates</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">+</span> <span class="s1">' '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">y</span><span class="p">)</span> <span class="o">+</span> <span class="s1">' '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">z</span><span class="p">)</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_ground_points</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">fromstring</span><span class="p">(</span><span class="n">coordinates</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">float</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s1">' '</span><span class="p">)</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_ground_points</span> <span class="o">=</span> <span class="n">GeometryHelper</span><span class="o">.</span><span class="n">to_points_matrix</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_ground_points</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ground_points</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">points_list</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Surface point list</span>
|
||||||
|
<span class="sd"> :return: np.ndarray</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_points_list</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="n">s</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">points</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_points_list</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="o">*</span> <span class="mi">3</span><span class="p">)</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_points_list</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">polygon</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Union</span><span class="p">[</span><span class="n">pn</span><span class="o">.</span><span class="n">Polygon</span><span class="p">,</span> <span class="kc">None</span><span class="p">]:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Surface polygon</span>
|
||||||
|
<span class="sd"> :return: None or pyny3d.Polygon</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_polygon</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="k">try</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_polygon</span> <span class="o">=</span> <span class="n">pn</span><span class="o">.</span><span class="n">Polygon</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">points</span><span class="p">)</span>
|
||||||
|
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||||
|
<span class="c1"># is not really a polygon but a line so just return none</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_polygon</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_polygon</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">ground_polygon</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Union</span><span class="p">[</span><span class="n">pn</span><span class="o">.</span><span class="n">Polygon</span><span class="p">,</span> <span class="kc">None</span><span class="p">]:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Surface grounded polygon</span>
|
||||||
|
<span class="sd"> :return: None or pyny3d.Polygon</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ground_polygon</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="k">try</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_ground_polygon</span> <span class="o">=</span> <span class="n">pn</span><span class="o">.</span><span class="n">Polygon</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ground_points</span><span class="p">)</span>
|
||||||
|
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||||
|
<span class="c1"># is not really a polygon but a line so just return none</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_ground_polygon</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_ground_polygon</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">area</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Surface area in square meters</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_area</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_area</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">polygon</span><span class="o">.</span><span class="n">get_area</span><span class="p">()</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_area</span>
|
||||||
|
|
||||||
|
<span class="k">def</span> <span class="nf">_is_almost_same_terrain</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">terrain_points</span><span class="p">,</span> <span class="n">ground_points</span><span class="p">):</span>
|
||||||
|
<span class="n">equal</span> <span class="o">=</span> <span class="mi">0</span>
|
||||||
|
<span class="k">for</span> <span class="n">terrain_point</span> <span class="ow">in</span> <span class="n">terrain_points</span><span class="p">:</span>
|
||||||
|
<span class="k">for</span> <span class="n">ground_point</span> <span class="ow">in</span> <span class="n">ground_points</span><span class="p">:</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_geometry</span><span class="o">.</span><span class="n">almost_equal</span><span class="p">(</span><span class="n">terrain_point</span><span class="p">,</span> <span class="n">ground_point</span><span class="p">):</span>
|
||||||
|
<span class="n">equal</span> <span class="o">+=</span> <span class="mi">1</span>
|
||||||
|
<span class="k">return</span> <span class="n">equal</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">terrain_points</span><span class="p">)</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">_is_terrain</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="k">for</span> <span class="n">t_points</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_parent</span><span class="o">.</span><span class="n">terrains</span><span class="p">:</span>
|
||||||
|
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">t_points</span><span class="p">)</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">points</span><span class="p">)</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_is_almost_same_terrain</span><span class="p">(</span><span class="n">t_points</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">points</span><span class="p">):</span>
|
||||||
|
<span class="k">return</span> <span class="kc">True</span>
|
||||||
|
<span class="k">return</span> <span class="kc">False</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">area_above_ground</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Surface area above ground in square meters</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_area_above_ground</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_area_above_ground</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">area</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">area_below_ground</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_area_above_ground</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">area_below_ground</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Surface area below ground in square meters</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_area_below_ground</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_area_below_ground</span> <span class="o">=</span> <span class="mf">0.0</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_is_terrain</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_area_below_ground</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">area</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_area_below_ground</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">normal</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Surface normal vector</span>
|
||||||
|
<span class="sd"> :return: np.ndarray</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_normal</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="n">points</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">points</span>
|
||||||
|
<span class="n">cross_product</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">cross</span><span class="p">(</span><span class="n">points</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">points</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">points</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="o">-</span> <span class="n">points</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_normal</span> <span class="o">=</span> <span class="n">cross_product</span> <span class="o">/</span> <span class="n">np</span><span class="o">.</span><span class="n">linalg</span><span class="o">.</span><span class="n">norm</span><span class="p">(</span><span class="n">cross_product</span><span class="p">)</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_normal</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">azimuth</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Surface azimuth in radians</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_azimuth</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="n">normal</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">normal</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_azimuth</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arctan2</span><span class="p">(</span><span class="n">normal</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">normal</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_azimuth</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">inclination</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Surface inclination in radians</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_inclination</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_inclination</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arccos</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">normal</span><span class="p">[</span><span class="mi">2</span><span class="p">])</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_inclination</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">type</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Surface type Ground, Wall or Roof</span>
|
||||||
|
<span class="sd"> :return: str</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_type</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="n">grad</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">rad2deg</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">inclination</span><span class="p">)</span>
|
||||||
|
<span class="k">if</span> <span class="n">grad</span> <span class="o">>=</span> <span class="mi">170</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_type</span> <span class="o">=</span> <span class="s1">'Ground'</span>
|
||||||
|
<span class="k">elif</span> <span class="mi">80</span> <span class="o"><=</span> <span class="n">grad</span> <span class="o"><=</span> <span class="mi">100</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_type</span> <span class="o">=</span> <span class="s1">'Wall'</span>
|
||||||
|
<span class="k">else</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_type</span> <span class="o">=</span> <span class="s1">'Roof'</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_type</span>
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="Surface.add_shared"><a class="viewcode-back" href="../../index.html#city_model_structure.surface.Surface.add_shared">[docs]</a> <span class="k">def</span> <span class="nf">add_shared</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">surface</span><span class="p">,</span> <span class="n">intersection_area</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Add a given surface and shared area in percent to this surface.</span>
|
||||||
|
<span class="sd"> :param surface:</span>
|
||||||
|
<span class="sd"> :param intersection_area:</span>
|
||||||
|
<span class="sd"> :return:</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="n">percent</span> <span class="o">=</span> <span class="n">intersection_area</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">area</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_shared_surfaces</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">percent</span><span class="p">,</span> <span class="n">surface</span><span class="p">))</span></div>
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="Surface.shared"><a class="viewcode-back" href="../../index.html#city_model_structure.surface.Surface.shared">[docs]</a> <span class="k">def</span> <span class="nf">shared</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">surface</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Check if given surface share some area with this surface</span>
|
||||||
|
<span class="sd"> :param surface: Surface</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">type</span> <span class="o">!=</span> <span class="s1">'Wall'</span> <span class="ow">or</span> <span class="n">surface</span><span class="o">.</span><span class="n">type</span> <span class="o">!=</span> <span class="s1">'Wall'</span><span class="p">:</span>
|
||||||
|
<span class="k">return</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_geometry_helper</span><span class="o">.</span><span class="n">is_almost_same_surface</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">surface</span><span class="p">):</span>
|
||||||
|
<span class="n">intersection_area</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">intersect</span><span class="p">(</span><span class="n">surface</span><span class="p">)</span><span class="o">.</span><span class="n">area</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">add_shared</span><span class="p">(</span><span class="n">surface</span><span class="p">,</span> <span class="n">intersection_area</span><span class="p">)</span>
|
||||||
|
<span class="n">surface</span><span class="o">.</span><span class="n">add_shared</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">intersection_area</span><span class="p">)</span></div>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">global_irradiance_hour</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get surface global irradiance hour in Wh/m2</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_global_irradiance_hour</span>
|
||||||
|
|
||||||
|
<span class="nd">@global_irradiance_hour</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">global_irradiance_hour</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set surface global irradiance per hour in Wh/m2</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_global_irradiance_hour</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">global_irradiance_month</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get surface global irradiance per month in Wh/m2</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_global_irradiance_month</span>
|
||||||
|
|
||||||
|
<span class="nd">@global_irradiance_month</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">global_irradiance_month</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set surface global irradiance per month in Wh/m2</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_global_irradiance_month</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">shapely</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Union</span><span class="p">[</span><span class="kc">None</span><span class="p">,</span> <span class="n">pn</span><span class="o">.</span><span class="n">Polygon</span><span class="p">]:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Surface shapely (Z projection)</span>
|
||||||
|
<span class="sd"> :return: None or pyny3d.Polygon</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">polygon</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="k">return</span> <span class="kc">None</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_shapely</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_shapely</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">polygon</span><span class="o">.</span><span class="n">get_shapely</span><span class="p">()</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_shapely</span>
|
||||||
|
|
||||||
|
<span class="nd">@staticmethod</span>
|
||||||
|
<span class="k">def</span> <span class="nf">_polygon_to_surface</span><span class="p">(</span><span class="n">polygon</span><span class="p">)</span> <span class="o">-></span> <span class="n">Surface</span><span class="p">:</span>
|
||||||
|
<span class="n">coordinates</span> <span class="o">=</span> <span class="s1">''</span>
|
||||||
|
<span class="k">for</span> <span class="n">coordinate</span> <span class="ow">in</span> <span class="n">polygon</span><span class="o">.</span><span class="n">exterior</span><span class="o">.</span><span class="n">coords</span><span class="p">:</span>
|
||||||
|
<span class="k">if</span> <span class="n">coordinates</span> <span class="o">!=</span> <span class="s1">''</span><span class="p">:</span>
|
||||||
|
<span class="n">coordinates</span> <span class="o">=</span> <span class="n">coordinates</span> <span class="o">+</span> <span class="s1">' '</span>
|
||||||
|
<span class="n">coordinates</span> <span class="o">=</span> <span class="n">coordinates</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">coordinate</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">+</span> <span class="s1">' '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">coordinate</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="o">+</span> <span class="s1">' 0.0'</span>
|
||||||
|
<span class="k">return</span> <span class="n">Surface</span><span class="p">(</span><span class="n">coordinates</span><span class="p">,</span> <span class="n">remove_last</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">projection</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Surface</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Projected surface (Z projection)</span>
|
||||||
|
<span class="sd"> :return: Surface</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_is_projected</span><span class="p">:</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_projected_surface</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_projected_surface</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_polygon_to_surface</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">shapely</span><span class="p">)</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_projected_surface</span>
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="Surface.intersect"><a class="viewcode-back" href="../../index.html#city_model_structure.surface.Surface.intersect">[docs]</a> <span class="k">def</span> <span class="nf">intersect</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">surface</span><span class="p">)</span> <span class="o">-></span> <span class="n">Union</span><span class="p">[</span><span class="n">Surface</span><span class="p">,</span> <span class="kc">None</span><span class="p">]:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get the intersection surface, if any, between the given surface and this surface</span>
|
||||||
|
<span class="sd"> :param surface: Surface</span>
|
||||||
|
<span class="sd"> :return: None or Surface</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="n">min_x</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">min_x</span><span class="p">,</span> <span class="n">surface</span><span class="o">.</span><span class="n">min_x</span><span class="p">)</span>
|
||||||
|
<span class="n">min_y</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">min_y</span><span class="p">,</span> <span class="n">surface</span><span class="o">.</span><span class="n">min_y</span><span class="p">)</span>
|
||||||
|
<span class="n">min_z</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">min_z</span><span class="p">,</span> <span class="n">surface</span><span class="o">.</span><span class="n">min_z</span><span class="p">)</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_ground_coordinates</span> <span class="o">=</span> <span class="p">(</span><span class="n">min_x</span><span class="p">,</span> <span class="n">min_y</span><span class="p">,</span> <span class="n">min_z</span><span class="p">)</span>
|
||||||
|
<span class="n">surface</span><span class="o">.</span><span class="n">_ground_coordinates</span> <span class="o">=</span> <span class="p">(</span><span class="n">min_x</span><span class="p">,</span> <span class="n">min_y</span><span class="p">,</span> <span class="n">min_z</span><span class="p">)</span>
|
||||||
|
<span class="n">origin</span> <span class="o">=</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
|
||||||
|
<span class="n">azimuth</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">azimuth</span> <span class="o">-</span> <span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span> <span class="o">/</span> <span class="mi">2</span><span class="p">)</span>
|
||||||
|
<span class="k">while</span> <span class="n">azimuth</span> <span class="o"><</span> <span class="mi">0</span><span class="p">:</span>
|
||||||
|
<span class="n">azimuth</span> <span class="o">+=</span> <span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span> <span class="o">/</span> <span class="mi">2</span><span class="p">)</span>
|
||||||
|
<span class="n">inclination</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">inclination</span> <span class="o">-</span> <span class="n">np</span><span class="o">.</span><span class="n">pi</span>
|
||||||
|
<span class="k">while</span> <span class="n">inclination</span> <span class="o"><</span> <span class="mi">0</span><span class="p">:</span>
|
||||||
|
<span class="n">inclination</span> <span class="o">+=</span> <span class="n">np</span><span class="o">.</span><span class="n">pi</span>
|
||||||
|
<span class="n">polygon1</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ground_polygon</span><span class="o">.</span><span class="n">rotate</span><span class="p">(</span><span class="n">azimuth</span><span class="p">,</span> <span class="s1">'z'</span><span class="p">,</span> <span class="n">origin</span><span class="p">)</span><span class="o">.</span><span class="n">rotate</span><span class="p">(</span><span class="n">inclination</span><span class="p">,</span> <span class="s1">'x'</span><span class="p">,</span> <span class="n">origin</span><span class="p">)</span>
|
||||||
|
<span class="n">polygon2</span> <span class="o">=</span> <span class="n">surface</span><span class="o">.</span><span class="n">ground_polygon</span><span class="o">.</span><span class="n">rotate</span><span class="p">(</span><span class="n">azimuth</span><span class="p">,</span> <span class="s1">'z'</span><span class="p">,</span> <span class="n">origin</span><span class="p">)</span><span class="o">.</span><span class="n">rotate</span><span class="p">(</span><span class="n">inclination</span><span class="p">,</span> <span class="s1">'x'</span><span class="p">,</span> <span class="n">origin</span><span class="p">)</span>
|
||||||
|
<span class="k">try</span><span class="p">:</span>
|
||||||
|
<span class="n">coordinates</span> <span class="o">=</span> <span class="s1">''</span>
|
||||||
|
<span class="n">intersection</span> <span class="o">=</span> <span class="n">pn</span><span class="o">.</span><span class="n">Surface</span><span class="p">([</span><span class="n">polygon1</span><span class="p">])</span><span class="o">.</span><span class="n">intersect_with</span><span class="p">(</span><span class="n">polygon2</span><span class="p">)</span>
|
||||||
|
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">intersection</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
|
||||||
|
<span class="k">return</span> <span class="kc">None</span>
|
||||||
|
<span class="k">for</span> <span class="n">coordinate</span> <span class="ow">in</span> <span class="n">pn</span><span class="o">.</span><span class="n">Surface</span><span class="p">([</span><span class="n">polygon1</span><span class="p">])</span><span class="o">.</span><span class="n">intersect_with</span><span class="p">(</span><span class="n">polygon2</span><span class="p">)[</span><span class="mi">0</span><span class="p">]:</span>
|
||||||
|
<span class="k">if</span> <span class="n">coordinates</span> <span class="o">!=</span> <span class="s1">''</span><span class="p">:</span>
|
||||||
|
<span class="n">coordinates</span> <span class="o">=</span> <span class="n">coordinates</span> <span class="o">+</span> <span class="s1">' '</span>
|
||||||
|
<span class="n">coordinates</span> <span class="o">=</span> <span class="n">coordinates</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">coordinate</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">+</span> <span class="s1">' '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">coordinate</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="o">+</span> <span class="s1">' 0.0'</span>
|
||||||
|
<span class="k">if</span> <span class="n">coordinates</span> <span class="o">==</span> <span class="s1">''</span><span class="p">:</span>
|
||||||
|
<span class="k">return</span> <span class="kc">None</span>
|
||||||
|
<span class="n">intersect_surface</span> <span class="o">=</span> <span class="n">Surface</span><span class="p">(</span><span class="n">coordinates</span><span class="p">,</span> <span class="n">remove_last</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
|
||||||
|
<span class="k">if</span> <span class="n">intersect_surface</span><span class="o">.</span><span class="n">polygon</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="k">return</span> <span class="kc">None</span>
|
||||||
|
<span class="k">return</span> <span class="n">Surface</span><span class="p">(</span><span class="n">coordinates</span><span class="p">,</span> <span class="n">remove_last</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
|
||||||
|
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span>
|
||||||
|
<span class="nb">print</span><span class="p">(</span><span class="s1">'Error'</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
|
||||||
|
<span class="k">return</span> <span class="kc">None</span></div></div>
|
||||||
|
</pre></div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="page-nav">
|
||||||
|
<div class="inner"><ul class="page-nav">
|
||||||
|
</ul><div class="footer" role="contentinfo">
|
||||||
|
© Copyright 2020, Guillermo Gutierrez.
|
||||||
|
<br>
|
||||||
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</page>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
359
docs/build/html/_modules/city_model_structure/thermal_boundary.html
vendored
Normal file
359
docs/build/html/_modules/city_model_structure/thermal_boundary.html
vendored
Normal file
|
|
@ -0,0 +1,359 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
<title>city_model_structure.thermal_boundary</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../../_static/pygments.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/theme.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/sphinx_press_theme.css">
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
||||||
|
|
||||||
|
<!-- sphinx script_files -->
|
||||||
|
<script src="../../_static/jquery.js"></script>
|
||||||
|
<script src="../../_static/underscore.js"></script>
|
||||||
|
<script src="../../_static/doctools.js"></script>
|
||||||
|
<script src="../../_static/language_data.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="../../_static/theme-vendors.js"></script>
|
||||||
|
<script src="../../_static/theme.js" defer></script>
|
||||||
|
|
||||||
|
<link rel="index" title="Index" href="../../genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="../../search.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
|
||||||
|
<router-link to="../../index.html" class="home-link">
|
||||||
|
|
||||||
|
<span class="site-name">CERC libs</span>
|
||||||
|
|
||||||
|
</router-link>
|
||||||
|
|
||||||
|
<div class="links">
|
||||||
|
<navlinks class="can-hide">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks>
|
||||||
|
</div>
|
||||||
|
</navbar>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="sidebar-mask" @click="toggleSidebar(false)">
|
||||||
|
</div>
|
||||||
|
<sidebar @toggle-sidebar="toggleSidebar">
|
||||||
|
|
||||||
|
<navlinks>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks><div id="searchbox" class="searchbox" role="search">
|
||||||
|
<div class="caption"><span class="caption-text">Quick search</span>
|
||||||
|
<div class="searchformwrapper">
|
||||||
|
<form class="search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" />
|
||||||
|
<input type="submit" value="Search" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
<div class="sidebar-group">
|
||||||
|
<p class="caption">
|
||||||
|
<span class="caption-text"><a href="../../index.html#welcome-to-cerc-libs-s-documentation">Contents:</a></span>
|
||||||
|
</p>
|
||||||
|
<ul class="">
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</sidebar>
|
||||||
|
|
||||||
|
<page>
|
||||||
|
<div class="body-header" role="navigation" aria-label="navigation">
|
||||||
|
|
||||||
|
<ul class="breadcrumbs">
|
||||||
|
<li><a href="../../index.html">Docs</a> »</li>
|
||||||
|
|
||||||
|
<li><a href="../index.html">Module code</a> »</li>
|
||||||
|
|
||||||
|
<li>city_model_structure.thermal_boundary</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<ul class="page-nav">
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr>
|
||||||
|
<div class="content" role="main">
|
||||||
|
|
||||||
|
<h1>Source code for city_model_structure.thermal_boundary</h1><div class="highlight"><pre>
|
||||||
|
<span></span><span class="sd">"""</span>
|
||||||
|
<span class="sd">ThermalBoundary module</span>
|
||||||
|
<span class="sd">SPDX - License - Identifier: LGPL - 3.0 - or -later</span>
|
||||||
|
<span class="sd">Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">city_model_structure.thermal_opening</span> <span class="kn">import</span> <span class="n">ThermalOpening</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">city_model_structure.thermal_zone</span> <span class="kn">import</span> <span class="n">ThermalZone</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">city_model_structure.layer</span> <span class="kn">import</span> <span class="n">Layer</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">helpers.configuration_helper</span> <span class="kn">import</span> <span class="n">ConfigurationHelper</span>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="ThermalBoundary"><a class="viewcode-back" href="../../index.html#city_model_structure.thermal_boundary.ThermalBoundary">[docs]</a><span class="k">class</span> <span class="nc">ThermalBoundary</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> ThermalBoundary class</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">surface</span><span class="p">,</span> <span class="n">delimits</span><span class="p">):</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_surface</span> <span class="o">=</span> <span class="n">surface</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_delimits</span> <span class="o">=</span> <span class="n">delimits</span>
|
||||||
|
<span class="c1"># ToDo: up to at least LOD2 will be just one thermal opening per Thermal boundary, review for LOD3 and LOD4</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_thermal_openings</span> <span class="o">=</span> <span class="p">[</span><span class="n">ThermalOpening</span><span class="p">()]</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_layers</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_outside_solar_absorptance</span> <span class="o">=</span> <span class="n">ConfigurationHelper</span><span class="p">()</span><span class="o">.</span><span class="n">outside_solar_absorptance</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_outside_thermal_absorptance</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_outside_visible_absorptance</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_window_ratio</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_u_value</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_window_area</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_shortwave_reflectance</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">_outside_solar_absorptance</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">delimits</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">ThermalZone</span><span class="p">]:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get the thermal zones delimited by the thermal boundary</span>
|
||||||
|
<span class="sd"> :return: [ThermalZone]</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_delimits</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">azimuth</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Thermal boundary azimuth in radians</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_surface</span><span class="o">.</span><span class="n">azimuth</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">inclination</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Thermal boundary inclination in radians</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_surface</span><span class="o">.</span><span class="n">inclination</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">area</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Thermal boundary area in square meters</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_surface</span><span class="o">.</span><span class="n">area</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">area_above_ground</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Thermal boundary area above ground in square meters</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_surface</span><span class="o">.</span><span class="n">area_above_ground</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">area_below_ground</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Thermal boundary area below ground in square meters</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_surface</span><span class="o">.</span><span class="n">area_below_ground</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">outside_solar_absorptance</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal boundary outside solar absorptance</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_outside_solar_absorptance</span>
|
||||||
|
|
||||||
|
<span class="nd">@outside_solar_absorptance</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">outside_solar_absorptance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set thermal boundary outside solar absorptance</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_outside_solar_absorptance</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_shortwave_reflectance</span> <span class="o">=</span> <span class="mf">1.0</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">outside_thermal_absorptance</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal boundary outside thermal absorptance</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_outside_thermal_absorptance</span>
|
||||||
|
|
||||||
|
<span class="nd">@outside_thermal_absorptance</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">outside_thermal_absorptance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set thermal boundary outside thermal absorptance</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_outside_thermal_absorptance</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">outside_visible_absorptance</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal boundary outside visible absorptance</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_outside_visible_absorptance</span>
|
||||||
|
|
||||||
|
<span class="nd">@outside_visible_absorptance</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">outside_visible_absorptance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set thermal boundary outside visible absorptance</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_outside_visible_absorptance</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">thermal_openings</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">ThermalOpening</span><span class="p">]:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal boundary thermal openings</span>
|
||||||
|
<span class="sd"> :return: [ThermalOpening]</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_thermal_openings</span>
|
||||||
|
|
||||||
|
<span class="nd">@thermal_openings</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">thermal_openings</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set thermal boundary thermal openings</span>
|
||||||
|
<span class="sd"> :param value: [ThermalOpening]</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_thermal_openings</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">layers</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">Layer</span><span class="p">]:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal boundary layers</span>
|
||||||
|
<span class="sd"> :return: [Layers]</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_layers</span>
|
||||||
|
|
||||||
|
<span class="nd">@layers</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">layers</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set thermal boundary layers</span>
|
||||||
|
<span class="sd"> :param value: [Layer]</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_layers</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">type</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Thermal boundary surface type</span>
|
||||||
|
<span class="sd"> :return: str</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_surface</span><span class="o">.</span><span class="n">type</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">window_ratio</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal boundary window ratio</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_window_ratio</span>
|
||||||
|
|
||||||
|
<span class="nd">@window_ratio</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">window_ratio</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set thermal boundary window ratio</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_window_ratio</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">window_area</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Thermal boundary window area in square meters</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_window_area</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="k">try</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_window_area</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_surface</span><span class="o">.</span><span class="n">area</span><span class="p">)</span> <span class="o">*</span> <span class="nb">float</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">window_ratio</span><span class="p">)</span>
|
||||||
|
<span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
|
||||||
|
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'Window ratio is not defined or invalid surface area'</span><span class="p">)</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_window_area</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">u_value</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Thermal boundary u value in W/m2K</span>
|
||||||
|
<span class="sd"> internal and external convective coefficient in W/m2K values, can be configured at configuration.ini</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_u_value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="n">h_i</span> <span class="o">=</span> <span class="n">ConfigurationHelper</span><span class="p">()</span><span class="o">.</span><span class="n">h_i</span>
|
||||||
|
<span class="n">h_e</span> <span class="o">=</span> <span class="n">ConfigurationHelper</span><span class="p">()</span><span class="o">.</span><span class="n">h_e</span>
|
||||||
|
<span class="n">r_value</span> <span class="o">=</span> <span class="mf">1.0</span><span class="o">/</span><span class="n">h_i</span> <span class="o">+</span> <span class="mf">1.0</span><span class="o">/</span><span class="n">h_e</span>
|
||||||
|
<span class="k">try</span><span class="p">:</span>
|
||||||
|
<span class="k">for</span> <span class="n">layer</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">layers</span><span class="p">:</span>
|
||||||
|
<span class="k">if</span> <span class="n">layer</span><span class="o">.</span><span class="n">material</span><span class="o">.</span><span class="n">no_mass</span><span class="p">:</span>
|
||||||
|
<span class="n">r_value</span> <span class="o">+=</span> <span class="nb">float</span><span class="p">(</span><span class="n">layer</span><span class="o">.</span><span class="n">material</span><span class="o">.</span><span class="n">thermal_resistance</span><span class="p">)</span>
|
||||||
|
<span class="k">else</span><span class="p">:</span>
|
||||||
|
<span class="n">r_value</span> <span class="o">=</span> <span class="n">r_value</span> <span class="o">+</span> <span class="nb">float</span><span class="p">(</span><span class="n">layer</span><span class="o">.</span><span class="n">material</span><span class="o">.</span><span class="n">conductivity</span><span class="p">)</span> <span class="o">/</span> <span class="nb">float</span><span class="p">(</span><span class="n">layer</span><span class="o">.</span><span class="n">thickness</span><span class="p">)</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_u_value</span> <span class="o">=</span> <span class="mf">1.0</span><span class="o">/</span><span class="n">r_value</span>
|
||||||
|
<span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
|
||||||
|
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'Constructions layers are not initialized'</span><span class="p">)</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_u_value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">shortwave_reflectance</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal boundary shortwave reflectance</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_shortwave_reflectance</span>
|
||||||
|
|
||||||
|
<span class="nd">@shortwave_reflectance</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">shortwave_reflectance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set thermal boundary shortwave reflectance</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return:</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_shortwave_reflectance</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_outside_solar_absorptance</span> <span class="o">=</span> <span class="mf">1.0</span> <span class="o">-</span> <span class="nb">float</span><span class="p">(</span><span class="n">value</span><span class="p">)</span></div>
|
||||||
|
</pre></div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="page-nav">
|
||||||
|
<div class="inner"><ul class="page-nav">
|
||||||
|
</ul><div class="footer" role="contentinfo">
|
||||||
|
© Copyright 2020, Guillermo Gutierrez.
|
||||||
|
<br>
|
||||||
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</page>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
289
docs/build/html/_modules/city_model_structure/thermal_opening.html
vendored
Normal file
289
docs/build/html/_modules/city_model_structure/thermal_opening.html
vendored
Normal file
|
|
@ -0,0 +1,289 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
<title>city_model_structure.thermal_opening</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../../_static/pygments.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/theme.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/sphinx_press_theme.css">
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
||||||
|
|
||||||
|
<!-- sphinx script_files -->
|
||||||
|
<script src="../../_static/jquery.js"></script>
|
||||||
|
<script src="../../_static/underscore.js"></script>
|
||||||
|
<script src="../../_static/doctools.js"></script>
|
||||||
|
<script src="../../_static/language_data.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="../../_static/theme-vendors.js"></script>
|
||||||
|
<script src="../../_static/theme.js" defer></script>
|
||||||
|
|
||||||
|
<link rel="index" title="Index" href="../../genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="../../search.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
|
||||||
|
<router-link to="../../index.html" class="home-link">
|
||||||
|
|
||||||
|
<span class="site-name">CERC libs</span>
|
||||||
|
|
||||||
|
</router-link>
|
||||||
|
|
||||||
|
<div class="links">
|
||||||
|
<navlinks class="can-hide">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks>
|
||||||
|
</div>
|
||||||
|
</navbar>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="sidebar-mask" @click="toggleSidebar(false)">
|
||||||
|
</div>
|
||||||
|
<sidebar @toggle-sidebar="toggleSidebar">
|
||||||
|
|
||||||
|
<navlinks>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks><div id="searchbox" class="searchbox" role="search">
|
||||||
|
<div class="caption"><span class="caption-text">Quick search</span>
|
||||||
|
<div class="searchformwrapper">
|
||||||
|
<form class="search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" />
|
||||||
|
<input type="submit" value="Search" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
<div class="sidebar-group">
|
||||||
|
<p class="caption">
|
||||||
|
<span class="caption-text"><a href="../../index.html#welcome-to-cerc-libs-s-documentation">Contents:</a></span>
|
||||||
|
</p>
|
||||||
|
<ul class="">
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</sidebar>
|
||||||
|
|
||||||
|
<page>
|
||||||
|
<div class="body-header" role="navigation" aria-label="navigation">
|
||||||
|
|
||||||
|
<ul class="breadcrumbs">
|
||||||
|
<li><a href="../../index.html">Docs</a> »</li>
|
||||||
|
|
||||||
|
<li><a href="../index.html">Module code</a> »</li>
|
||||||
|
|
||||||
|
<li>city_model_structure.thermal_opening</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<ul class="page-nav">
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr>
|
||||||
|
<div class="content" role="main">
|
||||||
|
|
||||||
|
<h1>Source code for city_model_structure.thermal_opening</h1><div class="highlight"><pre>
|
||||||
|
<span></span><span class="sd">"""</span>
|
||||||
|
<span class="sd">ThermalOpening module</span>
|
||||||
|
<span class="sd">SPDX - License - Identifier: LGPL - 3.0 - or -later</span>
|
||||||
|
<span class="sd">Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">helpers.configuration_helper</span> <span class="kn">import</span> <span class="n">ConfigurationHelper</span>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="ThermalOpening"><a class="viewcode-back" href="../../index.html#city_model_structure.thermal_opening.ThermalOpening">[docs]</a><span class="k">class</span> <span class="nc">ThermalOpening</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> ThermalOpening class</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_openable_ratio</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_conductivity</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_frame_ratio</span> <span class="o">=</span> <span class="n">ConfigurationHelper</span><span class="p">()</span><span class="o">.</span><span class="n">frame_ratio</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_g_value</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_thickness</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_front_side_solar_transmittance_at_normal_incidence</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_back_side_solar_transmittance_at_normal_incidence</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_overall_u_value</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">openable_ratio</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal opening openable ratio, NOT IMPLEMENTED</span>
|
||||||
|
<span class="sd"> :return: Exception</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'Not implemented'</span><span class="p">)</span>
|
||||||
|
|
||||||
|
<span class="nd">@openable_ratio</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">openable_ratio</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set thermal opening openable ratio, NOT IMPLEMENTED</span>
|
||||||
|
<span class="sd"> :param value: Any</span>
|
||||||
|
<span class="sd"> :return: Exception</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'Not implemented'</span><span class="p">)</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">conductivity</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal opening conductivity in W/mK</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conductivity</span>
|
||||||
|
|
||||||
|
<span class="nd">@conductivity</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">conductivity</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal opening conductivity in W/mK</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="c1"># The code to calculate overall_u_value is duplicated here and in thickness_m.</span>
|
||||||
|
<span class="c1"># This ensures a more robust code that returns the overall_u_value regardless the order the parameters are read.</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_conductivity</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_overall_u_value</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">thickness</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="n">h_i</span> <span class="o">=</span> <span class="n">ConfigurationHelper</span><span class="p">()</span><span class="o">.</span><span class="n">h_i</span>
|
||||||
|
<span class="n">h_e</span> <span class="o">=</span> <span class="n">ConfigurationHelper</span><span class="p">()</span><span class="o">.</span><span class="n">h_e</span>
|
||||||
|
<span class="n">r_value</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">/</span> <span class="n">h_i</span> <span class="o">+</span> <span class="mi">1</span> <span class="o">/</span> <span class="n">h_e</span> <span class="o">+</span> <span class="nb">float</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">conductivity</span><span class="p">)</span> <span class="o">/</span> <span class="nb">float</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">thickness</span><span class="p">)</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_overall_u_value</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">/</span> <span class="n">r_value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">frame_ratio</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal opening frame ratio</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_frame_ratio</span>
|
||||||
|
|
||||||
|
<span class="nd">@frame_ratio</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">frame_ratio</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set thermal opening frame ratio</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_frame_ratio</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">g_value</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal opening g value</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_g_value</span>
|
||||||
|
|
||||||
|
<span class="nd">@g_value</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">g_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set thermal opening g value</span>
|
||||||
|
<span class="sd"> :param value:</span>
|
||||||
|
<span class="sd"> :return:</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_g_value</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">thickness</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal opening thickness in meters</span>
|
||||||
|
<span class="sd"> :return:</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_thickness</span>
|
||||||
|
|
||||||
|
<span class="nd">@thickness</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">thickness</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set thermal opening thickness in meters</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="c1"># The code to calculate overall_u_value is duplicated here and in conductivity.</span>
|
||||||
|
<span class="c1"># This ensures a more robust code that returns the overall_u_value regardless the order the parameters are read.</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_thickness</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_overall_u_value</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">conductivity</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="n">h_i</span> <span class="o">=</span> <span class="n">ConfigurationHelper</span><span class="p">()</span><span class="o">.</span><span class="n">h_i</span>
|
||||||
|
<span class="n">h_e</span> <span class="o">=</span> <span class="n">ConfigurationHelper</span><span class="p">()</span><span class="o">.</span><span class="n">h_e</span>
|
||||||
|
<span class="n">r_value</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">/</span> <span class="n">h_i</span> <span class="o">+</span> <span class="mi">1</span> <span class="o">/</span> <span class="n">h_e</span> <span class="o">+</span> <span class="nb">float</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">conductivity</span><span class="p">)</span> <span class="o">/</span> <span class="nb">float</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">thickness</span><span class="p">)</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_overall_u_value</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">/</span> <span class="n">r_value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">front_side_solar_transmittance_at_normal_incidence</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal opening front side solar transmittance at normal incidence</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_front_side_solar_transmittance_at_normal_incidence</span>
|
||||||
|
|
||||||
|
<span class="nd">@front_side_solar_transmittance_at_normal_incidence</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">front_side_solar_transmittance_at_normal_incidence</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set thermal opening front side solar transmittance at normal incidence</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_front_side_solar_transmittance_at_normal_incidence</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">back_side_solar_transmittance_at_normal_incidence</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal opening back side solar transmittance at normal incidence</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_back_side_solar_transmittance_at_normal_incidence</span>
|
||||||
|
|
||||||
|
<span class="nd">@back_side_solar_transmittance_at_normal_incidence</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">back_side_solar_transmittance_at_normal_incidence</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set thermal opening back side solar transmittance at normal incidence</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_back_side_solar_transmittance_at_normal_incidence</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">overall_u_value</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal opening overall u value in W/m2K</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_overall_u_value</span>
|
||||||
|
|
||||||
|
<span class="nd">@overall_u_value</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">overall_u_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal opening overall u value in W/m2K</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_overall_u_value</span> <span class="o">=</span> <span class="n">value</span></div>
|
||||||
|
</pre></div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="page-nav">
|
||||||
|
<div class="inner"><ul class="page-nav">
|
||||||
|
</ul><div class="footer" role="contentinfo">
|
||||||
|
© Copyright 2020, Guillermo Gutierrez.
|
||||||
|
<br>
|
||||||
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</page>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
303
docs/build/html/_modules/city_model_structure/thermal_zone.html
vendored
Normal file
303
docs/build/html/_modules/city_model_structure/thermal_zone.html
vendored
Normal file
|
|
@ -0,0 +1,303 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
<title>city_model_structure.thermal_zone</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../../_static/pygments.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/theme.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/sphinx_press_theme.css">
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
||||||
|
|
||||||
|
<!-- sphinx script_files -->
|
||||||
|
<script src="../../_static/jquery.js"></script>
|
||||||
|
<script src="../../_static/underscore.js"></script>
|
||||||
|
<script src="../../_static/doctools.js"></script>
|
||||||
|
<script src="../../_static/language_data.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="../../_static/theme-vendors.js"></script>
|
||||||
|
<script src="../../_static/theme.js" defer></script>
|
||||||
|
|
||||||
|
<link rel="index" title="Index" href="../../genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="../../search.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
|
||||||
|
<router-link to="../../index.html" class="home-link">
|
||||||
|
|
||||||
|
<span class="site-name">CERC libs</span>
|
||||||
|
|
||||||
|
</router-link>
|
||||||
|
|
||||||
|
<div class="links">
|
||||||
|
<navlinks class="can-hide">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks>
|
||||||
|
</div>
|
||||||
|
</navbar>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="sidebar-mask" @click="toggleSidebar(false)">
|
||||||
|
</div>
|
||||||
|
<sidebar @toggle-sidebar="toggleSidebar">
|
||||||
|
|
||||||
|
<navlinks>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks><div id="searchbox" class="searchbox" role="search">
|
||||||
|
<div class="caption"><span class="caption-text">Quick search</span>
|
||||||
|
<div class="searchformwrapper">
|
||||||
|
<form class="search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" />
|
||||||
|
<input type="submit" value="Search" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
<div class="sidebar-group">
|
||||||
|
<p class="caption">
|
||||||
|
<span class="caption-text"><a href="../../index.html#welcome-to-cerc-libs-s-documentation">Contents:</a></span>
|
||||||
|
</p>
|
||||||
|
<ul class="">
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</sidebar>
|
||||||
|
|
||||||
|
<page>
|
||||||
|
<div class="body-header" role="navigation" aria-label="navigation">
|
||||||
|
|
||||||
|
<ul class="breadcrumbs">
|
||||||
|
<li><a href="../../index.html">Docs</a> »</li>
|
||||||
|
|
||||||
|
<li><a href="../index.html">Module code</a> »</li>
|
||||||
|
|
||||||
|
<li>city_model_structure.thermal_zone</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<ul class="page-nav">
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr>
|
||||||
|
<div class="content" role="main">
|
||||||
|
|
||||||
|
<h1>Source code for city_model_structure.thermal_zone</h1><div class="highlight"><pre>
|
||||||
|
<span></span><span class="sd">"""</span>
|
||||||
|
<span class="sd">ThermalZone module</span>
|
||||||
|
<span class="sd">SPDX - License - Identifier: LGPL - 3.0 - or -later</span>
|
||||||
|
<span class="sd">Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">TypeVar</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">city_model_structure.usage_zone</span> <span class="kn">import</span> <span class="n">UsageZone</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">city_model_structure.surface</span> <span class="kn">import</span> <span class="n">Surface</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">helpers.configuration_helper</span> <span class="kn">import</span> <span class="n">ConfigurationHelper</span>
|
||||||
|
|
||||||
|
<span class="n">ThermalBoundary</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s1">'ThermalBoundary'</span><span class="p">)</span>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="ThermalZone"><a class="viewcode-back" href="../../index.html#city_model_structure.thermal_zone.ThermalZone">[docs]</a><span class="k">class</span> <span class="nc">ThermalZone</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> ThermalZone class</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">surfaces</span><span class="p">):</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_surfaces</span> <span class="o">=</span> <span class="n">surfaces</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_floor_area</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_bounded</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_heated</span> <span class="o">=</span> <span class="n">ConfigurationHelper</span><span class="p">()</span><span class="o">.</span><span class="n">heated</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_cooled</span> <span class="o">=</span> <span class="n">ConfigurationHelper</span><span class="p">()</span><span class="o">.</span><span class="n">cooled</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_additional_thermal_bridge_u_value</span> <span class="o">=</span> <span class="n">ConfigurationHelper</span><span class="p">()</span><span class="o">.</span><span class="n">additional_thermal_bridge_u_value</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_effective_thermal_capacity</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_indirectly_heated_area_ratio</span> <span class="o">=</span> <span class="n">ConfigurationHelper</span><span class="p">()</span><span class="o">.</span><span class="n">indirectly_heated_area_ratio</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_infiltration_rate_system_on</span> <span class="o">=</span> <span class="n">ConfigurationHelper</span><span class="p">()</span><span class="o">.</span><span class="n">infiltration_rate_system_on</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_infiltration_rate_system_off</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_usage_zones</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">heated</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal zone heated flag</span>
|
||||||
|
<span class="sd"> :return: Boolean</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_heated</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">cooled</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal zone cooled flag</span>
|
||||||
|
<span class="sd"> :return: Boolean</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cooled</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">floor_area</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal zone floor area in square meters</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_floor_area</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_floor_area</span> <span class="o">=</span> <span class="mi">0</span>
|
||||||
|
<span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_surfaces</span><span class="p">:</span>
|
||||||
|
<span class="k">if</span> <span class="n">s</span><span class="o">.</span><span class="n">type</span> <span class="o">==</span> <span class="s1">'Ground'</span><span class="p">:</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_floor_area</span> <span class="o">+=</span> <span class="n">s</span><span class="o">.</span><span class="n">area</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_floor_area</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">bounded</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">ThermalBoundary</span><span class="p">]:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal boundaries bounding with the thermal zone</span>
|
||||||
|
<span class="sd"> :return: [ThermalBoundary]</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_bounded</span>
|
||||||
|
|
||||||
|
<span class="nd">@bounded</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">bounded</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set thermal boundaries bounding with the thermal zone</span>
|
||||||
|
<span class="sd"> :param value: [ThermalBoundary]</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_bounded</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">surfaces</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">Surface</span><span class="p">]:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal zone surfaces</span>
|
||||||
|
<span class="sd"> :return: [Surface]</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_surfaces</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">additional_thermal_bridge_u_value</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal zone additional thermal bridge u value W/m2K</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_additional_thermal_bridge_u_value</span>
|
||||||
|
|
||||||
|
<span class="nd">@additional_thermal_bridge_u_value</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">additional_thermal_bridge_u_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set thermal zone additional thermal bridge u value W/m2K</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_additional_thermal_bridge_u_value</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">effective_thermal_capacity</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal zone effective thermal capacity</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_effective_thermal_capacity</span>
|
||||||
|
|
||||||
|
<span class="nd">@effective_thermal_capacity</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">effective_thermal_capacity</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set thermal zone effective thermal capacity</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_effective_thermal_capacity</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">indirectly_heated_area_ratio</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal zone indirectly heated area ratio</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_indirectly_heated_area_ratio</span>
|
||||||
|
|
||||||
|
<span class="nd">@indirectly_heated_area_ratio</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">indirectly_heated_area_ratio</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set thermal zone indirectly heated area ratio</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_indirectly_heated_area_ratio</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">infiltration_rate_system_on</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal zone infiltration rate system on in air changes per hour</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_infiltration_rate_system_on</span>
|
||||||
|
|
||||||
|
<span class="nd">@infiltration_rate_system_on</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">infiltration_rate_system_on</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set thermal zone infiltration rate system on in air changes per hour</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_infiltration_rate_system_on</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">infiltration_rate_system_off</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal zone infiltration rate system off in air changes per hour</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_infiltration_rate_system_off</span>
|
||||||
|
|
||||||
|
<span class="nd">@infiltration_rate_system_off</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">infiltration_rate_system_off</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set thermal zone infiltration rate system on in air changes per hour</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_infiltration_rate_system_off</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">usage_zones</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">UsageZone</span><span class="p">]:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get thermal zone usage zones</span>
|
||||||
|
<span class="sd"> :return: [UsageZone]</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_usage_zones</span>
|
||||||
|
|
||||||
|
<span class="nd">@usage_zones</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">usage_zones</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">values</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set thermal zone usage zones</span>
|
||||||
|
<span class="sd"> :param values: [UsageZone]</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_usage_zones</span> <span class="o">=</span> <span class="n">values</span></div>
|
||||||
|
</pre></div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="page-nav">
|
||||||
|
<div class="inner"><ul class="page-nav">
|
||||||
|
</ul><div class="footer" role="contentinfo">
|
||||||
|
© Copyright 2020, Guillermo Gutierrez.
|
||||||
|
<br>
|
||||||
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</page>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
276
docs/build/html/_modules/city_model_structure/usage_zone.html
vendored
Normal file
276
docs/build/html/_modules/city_model_structure/usage_zone.html
vendored
Normal file
|
|
@ -0,0 +1,276 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
<title>city_model_structure.usage_zone</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../../_static/pygments.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/theme.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/sphinx_press_theme.css">
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
||||||
|
|
||||||
|
<!-- sphinx script_files -->
|
||||||
|
<script src="../../_static/jquery.js"></script>
|
||||||
|
<script src="../../_static/underscore.js"></script>
|
||||||
|
<script src="../../_static/doctools.js"></script>
|
||||||
|
<script src="../../_static/language_data.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="../../_static/theme-vendors.js"></script>
|
||||||
|
<script src="../../_static/theme.js" defer></script>
|
||||||
|
|
||||||
|
<link rel="index" title="Index" href="../../genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="../../search.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
|
||||||
|
<router-link to="../../index.html" class="home-link">
|
||||||
|
|
||||||
|
<span class="site-name">CERC libs</span>
|
||||||
|
|
||||||
|
</router-link>
|
||||||
|
|
||||||
|
<div class="links">
|
||||||
|
<navlinks class="can-hide">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks>
|
||||||
|
</div>
|
||||||
|
</navbar>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="sidebar-mask" @click="toggleSidebar(false)">
|
||||||
|
</div>
|
||||||
|
<sidebar @toggle-sidebar="toggleSidebar">
|
||||||
|
|
||||||
|
<navlinks>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks><div id="searchbox" class="searchbox" role="search">
|
||||||
|
<div class="caption"><span class="caption-text">Quick search</span>
|
||||||
|
<div class="searchformwrapper">
|
||||||
|
<form class="search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" />
|
||||||
|
<input type="submit" value="Search" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
<div class="sidebar-group">
|
||||||
|
<p class="caption">
|
||||||
|
<span class="caption-text"><a href="../../index.html#welcome-to-cerc-libs-s-documentation">Contents:</a></span>
|
||||||
|
</p>
|
||||||
|
<ul class="">
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</sidebar>
|
||||||
|
|
||||||
|
<page>
|
||||||
|
<div class="body-header" role="navigation" aria-label="navigation">
|
||||||
|
|
||||||
|
<ul class="breadcrumbs">
|
||||||
|
<li><a href="../../index.html">Docs</a> »</li>
|
||||||
|
|
||||||
|
<li><a href="../index.html">Module code</a> »</li>
|
||||||
|
|
||||||
|
<li>city_model_structure.usage_zone</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<ul class="page-nav">
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr>
|
||||||
|
<div class="content" role="main">
|
||||||
|
|
||||||
|
<h1>Source code for city_model_structure.usage_zone</h1><div class="highlight"><pre>
|
||||||
|
<span></span><span class="sd">"""</span>
|
||||||
|
<span class="sd">UsageZone module</span>
|
||||||
|
<span class="sd">SPDX - License - Identifier: LGPL - 3.0 - or -later</span>
|
||||||
|
<span class="sd">Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">city_model_structure.internal_gains</span> <span class="kn">import</span> <span class="n">InternalGains</span>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="UsageZone"><a class="viewcode-back" href="../../index.html#city_model_structure.usage_zone.UsageZone">[docs]</a><span class="k">class</span> <span class="nc">UsageZone</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> UsageZone class</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_usage</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_internal_gains</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_heating_setpoint</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_heating_setback</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_cooling_setpoint</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_hours_day</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_days_year</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_mechanical_air_change</span> <span class="o">=</span> <span class="kc">None</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">internal_gains</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">InternalGains</span><span class="p">]:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get usage zone internal gains</span>
|
||||||
|
<span class="sd"> :return: [InternalGains]</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_internal_gains</span>
|
||||||
|
|
||||||
|
<span class="nd">@internal_gains</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">internal_gains</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set usage zone internal gains</span>
|
||||||
|
<span class="sd"> :param value: [InternalGains]</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_internal_gains</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">heating_setpoint</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get usage zone heating set point in celsius grads</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_heating_setpoint</span>
|
||||||
|
|
||||||
|
<span class="nd">@heating_setpoint</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">heating_setpoint</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set usage zone heating set point in celsius grads</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_heating_setpoint</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">heating_setback</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get usage zone heating setback in celsius grads</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_heating_setback</span>
|
||||||
|
|
||||||
|
<span class="nd">@heating_setback</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">heating_setback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set usage zone heating setback in celsius grads</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_heating_setback</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">cooling_setpoint</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get usage zone cooling setpoint in celsius grads</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cooling_setpoint</span>
|
||||||
|
|
||||||
|
<span class="nd">@cooling_setpoint</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">cooling_setpoint</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set usage zone cooling setpoint in celsius grads</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_cooling_setpoint</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">hours_day</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get usage zone usage hours per day</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hours_day</span>
|
||||||
|
|
||||||
|
<span class="nd">@hours_day</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">hours_day</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set usage zone usage hours per day</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_hours_day</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">days_year</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get usage zone usage days per year</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_days_year</span>
|
||||||
|
|
||||||
|
<span class="nd">@days_year</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">days_year</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set usage zone usage days per year</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_days_year</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">mechanical_air_change</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Set usage zone mechanical air change in air change per hour</span>
|
||||||
|
<span class="sd"> :return: float</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_mechanical_air_change</span>
|
||||||
|
|
||||||
|
<span class="nd">@mechanical_air_change</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">mechanical_air_change</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get usage zone mechanical air change in air change per hour</span>
|
||||||
|
<span class="sd"> :param value: float</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_mechanical_air_change</span> <span class="o">=</span> <span class="n">value</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">usage</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get usage zone usage</span>
|
||||||
|
<span class="sd"> :return: str</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_usage</span>
|
||||||
|
|
||||||
|
<span class="nd">@usage</span><span class="o">.</span><span class="n">setter</span>
|
||||||
|
<span class="k">def</span> <span class="nf">usage</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Get usage zone usage</span>
|
||||||
|
<span class="sd"> :param value: str</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_usage</span> <span class="o">=</span> <span class="n">value</span></div>
|
||||||
|
</pre></div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="page-nav">
|
||||||
|
<div class="inner"><ul class="page-nav">
|
||||||
|
</ul><div class="footer" role="contentinfo">
|
||||||
|
© Copyright 2020, Guillermo Gutierrez.
|
||||||
|
<br>
|
||||||
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</page>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
154
docs/build/html/_modules/geometry/geometry_factory.html
vendored
Normal file
154
docs/build/html/_modules/geometry/geometry_factory.html
vendored
Normal file
|
|
@ -0,0 +1,154 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
<title>geometry.geometry_factory</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../../_static/pygments.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/theme.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/sphinx_press_theme.css">
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
||||||
|
|
||||||
|
<!-- sphinx script_files -->
|
||||||
|
<script src="../../_static/jquery.js"></script>
|
||||||
|
<script src="../../_static/underscore.js"></script>
|
||||||
|
<script src="../../_static/doctools.js"></script>
|
||||||
|
<script src="../../_static/language_data.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="../../_static/theme-vendors.js"></script>
|
||||||
|
<script src="../../_static/theme.js" defer></script>
|
||||||
|
|
||||||
|
<link rel="index" title="Index" href="../../genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="../../search.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
|
||||||
|
<router-link to="../../index.html" class="home-link">
|
||||||
|
|
||||||
|
<span class="site-name">CERC libs</span>
|
||||||
|
|
||||||
|
</router-link>
|
||||||
|
|
||||||
|
<div class="links">
|
||||||
|
<navlinks class="can-hide">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks>
|
||||||
|
</div>
|
||||||
|
</navbar>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="sidebar-mask" @click="toggleSidebar(false)">
|
||||||
|
</div>
|
||||||
|
<sidebar @toggle-sidebar="toggleSidebar">
|
||||||
|
|
||||||
|
<navlinks>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks><div id="searchbox" class="searchbox" role="search">
|
||||||
|
<div class="caption"><span class="caption-text">Quick search</span>
|
||||||
|
<div class="searchformwrapper">
|
||||||
|
<form class="search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" />
|
||||||
|
<input type="submit" value="Search" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
<div class="sidebar-group">
|
||||||
|
<p class="caption">
|
||||||
|
<span class="caption-text"><a href="../../index.html#welcome-to-cerc-libs-s-documentation">Contents:</a></span>
|
||||||
|
</p>
|
||||||
|
<ul class="">
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</sidebar>
|
||||||
|
|
||||||
|
<page>
|
||||||
|
<div class="body-header" role="navigation" aria-label="navigation">
|
||||||
|
|
||||||
|
<ul class="breadcrumbs">
|
||||||
|
<li><a href="../../index.html">Docs</a> »</li>
|
||||||
|
|
||||||
|
<li><a href="../index.html">Module code</a> »</li>
|
||||||
|
|
||||||
|
<li>geometry.geometry_factory</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<ul class="page-nav">
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr>
|
||||||
|
<div class="content" role="main">
|
||||||
|
|
||||||
|
<h1>Source code for geometry.geometry_factory</h1><div class="highlight"><pre>
|
||||||
|
<span></span><span class="sd">"""</span>
|
||||||
|
<span class="sd">GeometryFactory retrieve the specific geometric module to load the given format</span>
|
||||||
|
<span class="sd">SPDX - License - Identifier: LGPL - 3.0 - or -later</span>
|
||||||
|
<span class="sd">Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">geometry.geometry_feeders.city_gml</span> <span class="kn">import</span> <span class="n">CityGml</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">city_model_structure.city</span> <span class="kn">import</span> <span class="n">City</span>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="GeometryFactory"><a class="viewcode-back" href="../../index.html#geometry.geometry_factory.GeometryFactory">[docs]</a><span class="k">class</span> <span class="nc">GeometryFactory</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> GeometryFactory class</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file_type</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_file_type</span> <span class="o">=</span> <span class="s1">'_'</span> <span class="o">+</span> <span class="n">file_type</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_path</span> <span class="o">=</span> <span class="n">path</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">_citygml</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="k">return</span> <span class="n">CityGml</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_path</span><span class="p">)</span><span class="o">.</span><span class="n">city</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">_geojson</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'Not implemented'</span><span class="p">)</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">_bim</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'Not implemented'</span><span class="p">)</span>
|
||||||
|
|
||||||
|
<span class="nd">@property</span>
|
||||||
|
<span class="k">def</span> <span class="nf">city</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">City</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Load the city model structure from a geometry source</span>
|
||||||
|
<span class="sd"> :return: City</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_file_type</span><span class="p">,</span> <span class="k">lambda</span><span class="p">:</span> <span class="kc">None</span><span class="p">)</span></div>
|
||||||
|
</pre></div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="page-nav">
|
||||||
|
<div class="inner"><ul class="page-nav">
|
||||||
|
</ul><div class="footer" role="contentinfo">
|
||||||
|
© Copyright 2020, Guillermo Gutierrez.
|
||||||
|
<br>
|
||||||
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</page>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
130
docs/build/html/_modules/index.html
vendored
Normal file
130
docs/build/html/_modules/index.html
vendored
Normal file
|
|
@ -0,0 +1,130 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
<title>Overview: module code</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../_static/pygments.css">
|
||||||
|
<link rel="stylesheet" href="../_static/theme.css">
|
||||||
|
<link rel="stylesheet" href="../_static/sphinx_press_theme.css">
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||||
|
|
||||||
|
<!-- sphinx script_files -->
|
||||||
|
<script src="../_static/jquery.js"></script>
|
||||||
|
<script src="../_static/underscore.js"></script>
|
||||||
|
<script src="../_static/doctools.js"></script>
|
||||||
|
<script src="../_static/language_data.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="../_static/theme-vendors.js"></script>
|
||||||
|
<script src="../_static/theme.js" defer></script>
|
||||||
|
|
||||||
|
<link rel="index" title="Index" href="../genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="../search.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
|
||||||
|
<router-link to="../index.html" class="home-link">
|
||||||
|
|
||||||
|
<span class="site-name">CERC libs</span>
|
||||||
|
|
||||||
|
</router-link>
|
||||||
|
|
||||||
|
<div class="links">
|
||||||
|
<navlinks class="can-hide">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks>
|
||||||
|
</div>
|
||||||
|
</navbar>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="sidebar-mask" @click="toggleSidebar(false)">
|
||||||
|
</div>
|
||||||
|
<sidebar @toggle-sidebar="toggleSidebar">
|
||||||
|
|
||||||
|
<navlinks>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks><div id="searchbox" class="searchbox" role="search">
|
||||||
|
<div class="caption"><span class="caption-text">Quick search</span>
|
||||||
|
<div class="searchformwrapper">
|
||||||
|
<form class="search" action="../search.html" method="get">
|
||||||
|
<input type="text" name="q" />
|
||||||
|
<input type="submit" value="Search" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
<div class="sidebar-group">
|
||||||
|
<p class="caption">
|
||||||
|
<span class="caption-text"><a href="../index.html#welcome-to-cerc-libs-s-documentation">Contents:</a></span>
|
||||||
|
</p>
|
||||||
|
<ul class="">
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</sidebar>
|
||||||
|
|
||||||
|
<page>
|
||||||
|
<div class="body-header" role="navigation" aria-label="navigation">
|
||||||
|
|
||||||
|
<ul class="breadcrumbs">
|
||||||
|
<li><a href="../index.html">Docs</a> »</li>
|
||||||
|
|
||||||
|
<li>Overview: module code</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<ul class="page-nav">
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr>
|
||||||
|
<div class="content" role="main">
|
||||||
|
|
||||||
|
<h1>All modules for which code is available</h1>
|
||||||
|
<ul><li><a href="city_model_structure/city.html">city_model_structure.city</a></li>
|
||||||
|
<li><a href="city_model_structure/city_object.html">city_model_structure.city_object</a></li>
|
||||||
|
<li><a href="city_model_structure/internal_gains.html">city_model_structure.internal_gains</a></li>
|
||||||
|
<li><a href="city_model_structure/layer.html">city_model_structure.layer</a></li>
|
||||||
|
<li><a href="city_model_structure/material.html">city_model_structure.material</a></li>
|
||||||
|
<li><a href="city_model_structure/polyhedron.html">city_model_structure.polyhedron</a></li>
|
||||||
|
<li><a href="city_model_structure/surface.html">city_model_structure.surface</a></li>
|
||||||
|
<li><a href="city_model_structure/thermal_boundary.html">city_model_structure.thermal_boundary</a></li>
|
||||||
|
<li><a href="city_model_structure/thermal_opening.html">city_model_structure.thermal_opening</a></li>
|
||||||
|
<li><a href="city_model_structure/thermal_zone.html">city_model_structure.thermal_zone</a></li>
|
||||||
|
<li><a href="city_model_structure/usage_zone.html">city_model_structure.usage_zone</a></li>
|
||||||
|
<li><a href="geometry/geometry_factory.html">geometry.geometry_factory</a></li>
|
||||||
|
<li><a href="physics/physics_factory.html">physics.physics_factory</a></li>
|
||||||
|
<li><a href="usage/usage_factory.html">usage.usage_factory</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="page-nav">
|
||||||
|
<div class="inner"><ul class="page-nav">
|
||||||
|
</ul><div class="footer" role="contentinfo">
|
||||||
|
© Copyright 2020, Guillermo Gutierrez.
|
||||||
|
<br>
|
||||||
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</page>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
158
docs/build/html/_modules/physics/physics_factory.html
vendored
Normal file
158
docs/build/html/_modules/physics/physics_factory.html
vendored
Normal file
|
|
@ -0,0 +1,158 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
<title>physics.physics_factory</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../../_static/pygments.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/theme.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/sphinx_press_theme.css">
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
||||||
|
|
||||||
|
<!-- sphinx script_files -->
|
||||||
|
<script src="../../_static/jquery.js"></script>
|
||||||
|
<script src="../../_static/underscore.js"></script>
|
||||||
|
<script src="../../_static/doctools.js"></script>
|
||||||
|
<script src="../../_static/language_data.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="../../_static/theme-vendors.js"></script>
|
||||||
|
<script src="../../_static/theme.js" defer></script>
|
||||||
|
|
||||||
|
<link rel="index" title="Index" href="../../genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="../../search.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
|
||||||
|
<router-link to="../../index.html" class="home-link">
|
||||||
|
|
||||||
|
<span class="site-name">CERC libs</span>
|
||||||
|
|
||||||
|
</router-link>
|
||||||
|
|
||||||
|
<div class="links">
|
||||||
|
<navlinks class="can-hide">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks>
|
||||||
|
</div>
|
||||||
|
</navbar>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="sidebar-mask" @click="toggleSidebar(false)">
|
||||||
|
</div>
|
||||||
|
<sidebar @toggle-sidebar="toggleSidebar">
|
||||||
|
|
||||||
|
<navlinks>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks><div id="searchbox" class="searchbox" role="search">
|
||||||
|
<div class="caption"><span class="caption-text">Quick search</span>
|
||||||
|
<div class="searchformwrapper">
|
||||||
|
<form class="search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" />
|
||||||
|
<input type="submit" value="Search" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
<div class="sidebar-group">
|
||||||
|
<p class="caption">
|
||||||
|
<span class="caption-text"><a href="../../index.html#welcome-to-cerc-libs-s-documentation">Contents:</a></span>
|
||||||
|
</p>
|
||||||
|
<ul class="">
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</sidebar>
|
||||||
|
|
||||||
|
<page>
|
||||||
|
<div class="body-header" role="navigation" aria-label="navigation">
|
||||||
|
|
||||||
|
<ul class="breadcrumbs">
|
||||||
|
<li><a href="../../index.html">Docs</a> »</li>
|
||||||
|
|
||||||
|
<li><a href="../index.html">Module code</a> »</li>
|
||||||
|
|
||||||
|
<li>physics.physics_factory</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<ul class="page-nav">
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr>
|
||||||
|
<div class="content" role="main">
|
||||||
|
|
||||||
|
<h1>Source code for physics.physics_factory</h1><div class="highlight"><pre>
|
||||||
|
<span></span><span class="sd">"""</span>
|
||||||
|
<span class="sd">PhysicsFactory retrieve the specific physics module for the given region</span>
|
||||||
|
<span class="sd">SPDX - License - Identifier: LGPL - 3.0 - or -later</span>
|
||||||
|
<span class="sd">Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">physics.physics_feeders.us_new_york_city_physics_parameters</span> <span class="kn">import</span> <span class="n">UsNewYorkCityPhysicsParameters</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">physics.physics_feeders.us_physics_parameters</span> <span class="kn">import</span> <span class="n">UsPhysicsParameters</span>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="PhysicsFactory"><a class="viewcode-back" href="../../index.html#physics.physics_factory.PhysicsFactory">[docs]</a><span class="k">class</span> <span class="nc">PhysicsFactory</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> PhysicsFactor class</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">handler</span><span class="p">,</span> <span class="n">city</span><span class="p">,</span> <span class="n">base_path</span><span class="o">=</span><span class="s1">'data/physics'</span><span class="p">):</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_handler</span> <span class="o">=</span> <span class="s1">'_'</span> <span class="o">+</span> <span class="n">handler</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">'_'</span><span class="p">)</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_city</span> <span class="o">=</span> <span class="n">city</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_base_path</span> <span class="o">=</span> <span class="n">base_path</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">factory</span><span class="p">()</span>
|
||||||
|
|
||||||
|
<span class="k">def</span> <span class="nf">_us_new_york_city</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="n">UsNewYorkCityPhysicsParameters</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_city</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_base_path</span><span class="p">)</span>
|
||||||
|
|
||||||
|
<span class="k">def</span> <span class="nf">_us</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="n">UsPhysicsParameters</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_city</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_base_path</span><span class="p">)</span>
|
||||||
|
|
||||||
|
<span class="k">def</span> <span class="nf">_ca</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'Not implemented'</span><span class="p">)</span>
|
||||||
|
|
||||||
|
<span class="k">def</span> <span class="nf">_de</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'Not implemented'</span><span class="p">)</span>
|
||||||
|
|
||||||
|
<span class="k">def</span> <span class="nf">_es</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'Not implemented'</span><span class="p">)</span>
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="PhysicsFactory.factory"><a class="viewcode-back" href="../../index.html#physics.physics_factory.PhysicsFactory.factory">[docs]</a> <span class="k">def</span> <span class="nf">factory</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Enrich the city with the physics information</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_handler</span><span class="p">,</span> <span class="k">lambda</span><span class="p">:</span> <span class="kc">None</span><span class="p">)()</span></div></div>
|
||||||
|
</pre></div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="page-nav">
|
||||||
|
<div class="inner"><ul class="page-nav">
|
||||||
|
</ul><div class="footer" role="contentinfo">
|
||||||
|
© Copyright 2020, Guillermo Gutierrez.
|
||||||
|
<br>
|
||||||
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</page>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
154
docs/build/html/_modules/usage/usage_factory.html
vendored
Normal file
154
docs/build/html/_modules/usage/usage_factory.html
vendored
Normal file
|
|
@ -0,0 +1,154 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
<title>usage.usage_factory</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="../../_static/pygments.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/theme.css">
|
||||||
|
<link rel="stylesheet" href="../../_static/sphinx_press_theme.css">
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
||||||
|
|
||||||
|
<!-- sphinx script_files -->
|
||||||
|
<script src="../../_static/jquery.js"></script>
|
||||||
|
<script src="../../_static/underscore.js"></script>
|
||||||
|
<script src="../../_static/doctools.js"></script>
|
||||||
|
<script src="../../_static/language_data.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="../../_static/theme-vendors.js"></script>
|
||||||
|
<script src="../../_static/theme.js" defer></script>
|
||||||
|
|
||||||
|
<link rel="index" title="Index" href="../../genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="../../search.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
|
||||||
|
<router-link to="../../index.html" class="home-link">
|
||||||
|
|
||||||
|
<span class="site-name">CERC libs</span>
|
||||||
|
|
||||||
|
</router-link>
|
||||||
|
|
||||||
|
<div class="links">
|
||||||
|
<navlinks class="can-hide">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks>
|
||||||
|
</div>
|
||||||
|
</navbar>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="sidebar-mask" @click="toggleSidebar(false)">
|
||||||
|
</div>
|
||||||
|
<sidebar @toggle-sidebar="toggleSidebar">
|
||||||
|
|
||||||
|
<navlinks>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks><div id="searchbox" class="searchbox" role="search">
|
||||||
|
<div class="caption"><span class="caption-text">Quick search</span>
|
||||||
|
<div class="searchformwrapper">
|
||||||
|
<form class="search" action="../../search.html" method="get">
|
||||||
|
<input type="text" name="q" />
|
||||||
|
<input type="submit" value="Search" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
<div class="sidebar-group">
|
||||||
|
<p class="caption">
|
||||||
|
<span class="caption-text"><a href="../../index.html#welcome-to-cerc-libs-s-documentation">Contents:</a></span>
|
||||||
|
</p>
|
||||||
|
<ul class="">
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</sidebar>
|
||||||
|
|
||||||
|
<page>
|
||||||
|
<div class="body-header" role="navigation" aria-label="navigation">
|
||||||
|
|
||||||
|
<ul class="breadcrumbs">
|
||||||
|
<li><a href="../../index.html">Docs</a> »</li>
|
||||||
|
|
||||||
|
<li><a href="../index.html">Module code</a> »</li>
|
||||||
|
|
||||||
|
<li>usage.usage_factory</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<ul class="page-nav">
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr>
|
||||||
|
<div class="content" role="main">
|
||||||
|
|
||||||
|
<h1>Source code for usage.usage_factory</h1><div class="highlight"><pre>
|
||||||
|
<span></span><span class="sd">"""</span>
|
||||||
|
<span class="sd">UsageFactory retrieve the specific usage module for the given region</span>
|
||||||
|
<span class="sd">SPDX - License - Identifier: LGPL - 3.0 - or -later</span>
|
||||||
|
<span class="sd">Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">usage.usage_feeders.de_usage_parameters</span> <span class="kn">import</span> <span class="n">DeUsageParameters</span>
|
||||||
|
<span class="kn">from</span> <span class="nn">usage.usage_feeders.us_new_york_city_usage_parameters</span> <span class="kn">import</span> <span class="n">UsNewYorkCityUsageParameters</span>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="UsageFactory"><a class="viewcode-back" href="../../index.html#usage.usage_factory.UsageFactory">[docs]</a><span class="k">class</span> <span class="nc">UsageFactory</span><span class="p">:</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> UsageFactory class</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">handler</span><span class="p">,</span> <span class="n">city</span><span class="p">):</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_handler</span> <span class="o">=</span> <span class="s1">'_'</span> <span class="o">+</span> <span class="n">handler</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">' '</span><span class="p">,</span> <span class="s1">'_'</span><span class="p">)</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">_city</span> <span class="o">=</span> <span class="n">city</span>
|
||||||
|
<span class="bp">self</span><span class="o">.</span><span class="n">factory</span><span class="p">()</span>
|
||||||
|
|
||||||
|
<span class="k">def</span> <span class="nf">_us_new_york_city</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="n">UsNewYorkCityUsageParameters</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_city</span><span class="p">)</span>
|
||||||
|
|
||||||
|
<span class="k">def</span> <span class="nf">_ca</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'Not implemented'</span><span class="p">)</span>
|
||||||
|
|
||||||
|
<span class="k">def</span> <span class="nf">_de</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="n">DeUsageParameters</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_city</span><span class="p">)</span>
|
||||||
|
|
||||||
|
<span class="k">def</span> <span class="nf">_es</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'Not implemented'</span><span class="p">)</span>
|
||||||
|
|
||||||
|
<div class="viewcode-block" id="UsageFactory.factory"><a class="viewcode-back" href="../../index.html#usage.usage_factory.UsageFactory.factory">[docs]</a> <span class="k">def</span> <span class="nf">factory</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||||
|
<span class="sd">"""</span>
|
||||||
|
<span class="sd"> Enrich the city with the usage information</span>
|
||||||
|
<span class="sd"> :return: None</span>
|
||||||
|
<span class="sd"> """</span>
|
||||||
|
<span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_handler</span><span class="p">,</span> <span class="k">lambda</span><span class="p">:</span> <span class="kc">None</span><span class="p">)()</span></div></div>
|
||||||
|
</pre></div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="page-nav">
|
||||||
|
<div class="inner"><ul class="page-nav">
|
||||||
|
</ul><div class="footer" role="contentinfo">
|
||||||
|
© Copyright 2020, Guillermo Gutierrez.
|
||||||
|
<br>
|
||||||
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</page>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
104
docs/build/html/_sources/index.rst.txt
vendored
Normal file
104
docs/build/html/_sources/index.rst.txt
vendored
Normal file
|
|
@ -0,0 +1,104 @@
|
||||||
|
.. CERC libs documentation master file, created by
|
||||||
|
sphinx-quickstart on Mon Jun 15 09:17:03 2020.
|
||||||
|
You can adapt this file completely to your liking, but it should at least
|
||||||
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
|
Welcome to CERC libs's documentation!
|
||||||
|
=====================================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 5
|
||||||
|
:caption: Contents:
|
||||||
|
|
||||||
|
Indices and tables
|
||||||
|
====================
|
||||||
|
|
||||||
|
* :ref:`genindex`
|
||||||
|
* :ref:`modindex`
|
||||||
|
* :ref:`search`
|
||||||
|
|
||||||
|
City Model Structure
|
||||||
|
====================
|
||||||
|
|
||||||
|
City
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.city
|
||||||
|
:members:
|
||||||
|
|
||||||
|
City Object
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.city_object
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Internal Gains
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.internal_gains
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Layer
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.layer
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Material
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.material
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Polyhedron
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.polyhedron
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Surface
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.surface
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Thermal Boundary
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.thermal_boundary
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Thermal Opening
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.thermal_opening
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Thermal Zone
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.thermal_zone
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Usage Zone
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.usage_zone
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Factories
|
||||||
|
====================
|
||||||
|
|
||||||
|
Geometry Factory
|
||||||
|
********************
|
||||||
|
.. automodule:: geometry.geometry_factory
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Physics Factory
|
||||||
|
********************
|
||||||
|
.. automodule:: physics.physics_factory
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Usage Factory
|
||||||
|
********************
|
||||||
|
.. automodule:: usage.usage_factory
|
||||||
|
:members:
|
||||||
|
|
||||||
|
|
||||||
|
Additional Files
|
||||||
|
====================
|
||||||
|
|
||||||
|
:download:`README.md<../../README.md>`
|
||||||
|
:download:`LICENSE.md<../../LICENSE.md>`
|
||||||
|
:download:`CODE_OF_CONDUCT.md<../../CODE_OF_CONDUCT.md>`
|
||||||
|
:download:`CONTRIBUTING.md<../../CONTRIBUTING.md>`
|
||||||
|
:download:`PYGUIDE.md<../../PYGUIDE.md>`
|
||||||
835
docs/build/html/_static/basic.css
vendored
Normal file
835
docs/build/html/_static/basic.css
vendored
Normal file
|
|
@ -0,0 +1,835 @@
|
||||||
|
/*
|
||||||
|
* basic.css
|
||||||
|
* ~~~~~~~~~
|
||||||
|
*
|
||||||
|
* Sphinx stylesheet -- basic theme.
|
||||||
|
*
|
||||||
|
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
||||||
|
* :license: BSD, see LICENSE for details.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
/* -- main layout ----------------------------------------------------------- */
|
||||||
|
|
||||||
|
div.clearer {
|
||||||
|
clear: both;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* -- relbar ---------------------------------------------------------------- */
|
||||||
|
|
||||||
|
div.related {
|
||||||
|
width: 100%;
|
||||||
|
font-size: 90%;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.related h3 {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.related ul {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0 0 0 10px;
|
||||||
|
list-style: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.related li {
|
||||||
|
display: inline;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.related li.right {
|
||||||
|
float: right;
|
||||||
|
margin-right: 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* -- sidebar --------------------------------------------------------------- */
|
||||||
|
|
||||||
|
div.sphinxsidebarwrapper {
|
||||||
|
padding: 10px 5px 0 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.sphinxsidebar {
|
||||||
|
float: left;
|
||||||
|
width: 230px;
|
||||||
|
margin-left: -100%;
|
||||||
|
font-size: 90%;
|
||||||
|
word-wrap: break-word;
|
||||||
|
overflow-wrap : break-word;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.sphinxsidebar ul {
|
||||||
|
list-style: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.sphinxsidebar ul ul,
|
||||||
|
div.sphinxsidebar ul.want-points {
|
||||||
|
margin-left: 20px;
|
||||||
|
list-style: square;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.sphinxsidebar ul ul {
|
||||||
|
margin-top: 0;
|
||||||
|
margin-bottom: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.sphinxsidebar form {
|
||||||
|
margin-top: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.sphinxsidebar input {
|
||||||
|
border: 1px solid #98dbcc;
|
||||||
|
font-family: sans-serif;
|
||||||
|
font-size: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.sphinxsidebar #searchbox form.search {
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.sphinxsidebar #searchbox input[type="text"] {
|
||||||
|
float: left;
|
||||||
|
width: 80%;
|
||||||
|
padding: 0.25em;
|
||||||
|
box-sizing: border-box;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.sphinxsidebar #searchbox input[type="submit"] {
|
||||||
|
float: left;
|
||||||
|
width: 20%;
|
||||||
|
border-left: none;
|
||||||
|
padding: 0.25em;
|
||||||
|
box-sizing: border-box;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
img {
|
||||||
|
border: 0;
|
||||||
|
max-width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* -- search page ----------------------------------------------------------- */
|
||||||
|
|
||||||
|
ul.search {
|
||||||
|
margin: 10px 0 0 20px;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul.search li {
|
||||||
|
padding: 5px 0 5px 20px;
|
||||||
|
background-image: url(file.png);
|
||||||
|
background-repeat: no-repeat;
|
||||||
|
background-position: 0 7px;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul.search li a {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul.search li div.context {
|
||||||
|
color: #888;
|
||||||
|
margin: 2px 0 0 30px;
|
||||||
|
text-align: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul.keywordmatches li.goodmatch a {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* -- index page ------------------------------------------------------------ */
|
||||||
|
|
||||||
|
table.contentstable {
|
||||||
|
width: 90%;
|
||||||
|
margin-left: auto;
|
||||||
|
margin-right: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.contentstable p.biglink {
|
||||||
|
line-height: 150%;
|
||||||
|
}
|
||||||
|
|
||||||
|
a.biglink {
|
||||||
|
font-size: 1.3em;
|
||||||
|
}
|
||||||
|
|
||||||
|
span.linkdescr {
|
||||||
|
font-style: italic;
|
||||||
|
padding-top: 5px;
|
||||||
|
font-size: 90%;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* -- general index --------------------------------------------------------- */
|
||||||
|
|
||||||
|
table.indextable {
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.indextable td {
|
||||||
|
text-align: left;
|
||||||
|
vertical-align: top;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.indextable ul {
|
||||||
|
margin-top: 0;
|
||||||
|
margin-bottom: 0;
|
||||||
|
list-style-type: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.indextable > tbody > tr > td > ul {
|
||||||
|
padding-left: 0em;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.indextable tr.pcap {
|
||||||
|
height: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.indextable tr.cap {
|
||||||
|
margin-top: 10px;
|
||||||
|
background-color: #f2f2f2;
|
||||||
|
}
|
||||||
|
|
||||||
|
img.toggler {
|
||||||
|
margin-right: 3px;
|
||||||
|
margin-top: 3px;
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.modindex-jumpbox {
|
||||||
|
border-top: 1px solid #ddd;
|
||||||
|
border-bottom: 1px solid #ddd;
|
||||||
|
margin: 1em 0 1em 0;
|
||||||
|
padding: 0.4em;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.genindex-jumpbox {
|
||||||
|
border-top: 1px solid #ddd;
|
||||||
|
border-bottom: 1px solid #ddd;
|
||||||
|
margin: 1em 0 1em 0;
|
||||||
|
padding: 0.4em;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* -- domain module index --------------------------------------------------- */
|
||||||
|
|
||||||
|
table.modindextable td {
|
||||||
|
padding: 2px;
|
||||||
|
border-collapse: collapse;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* -- general body styles --------------------------------------------------- */
|
||||||
|
|
||||||
|
div.body {
|
||||||
|
min-width: 450px;
|
||||||
|
max-width: 800px;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.body p, div.body dd, div.body li, div.body blockquote {
|
||||||
|
-moz-hyphens: auto;
|
||||||
|
-ms-hyphens: auto;
|
||||||
|
-webkit-hyphens: auto;
|
||||||
|
hyphens: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
a.headerlink {
|
||||||
|
visibility: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
a.brackets:before,
|
||||||
|
span.brackets > a:before{
|
||||||
|
content: "[";
|
||||||
|
}
|
||||||
|
|
||||||
|
a.brackets:after,
|
||||||
|
span.brackets > a:after {
|
||||||
|
content: "]";
|
||||||
|
}
|
||||||
|
|
||||||
|
h1:hover > a.headerlink,
|
||||||
|
h2:hover > a.headerlink,
|
||||||
|
h3:hover > a.headerlink,
|
||||||
|
h4:hover > a.headerlink,
|
||||||
|
h5:hover > a.headerlink,
|
||||||
|
h6:hover > a.headerlink,
|
||||||
|
dt:hover > a.headerlink,
|
||||||
|
caption:hover > a.headerlink,
|
||||||
|
p.caption:hover > a.headerlink,
|
||||||
|
div.code-block-caption:hover > a.headerlink {
|
||||||
|
visibility: visible;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.body p.caption {
|
||||||
|
text-align: inherit;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.body td {
|
||||||
|
text-align: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
.first {
|
||||||
|
margin-top: 0 !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
p.rubric {
|
||||||
|
margin-top: 30px;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
img.align-left, .figure.align-left, object.align-left {
|
||||||
|
clear: left;
|
||||||
|
float: left;
|
||||||
|
margin-right: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
img.align-right, .figure.align-right, object.align-right {
|
||||||
|
clear: right;
|
||||||
|
float: right;
|
||||||
|
margin-left: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
img.align-center, .figure.align-center, object.align-center {
|
||||||
|
display: block;
|
||||||
|
margin-left: auto;
|
||||||
|
margin-right: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
img.align-default, .figure.align-default {
|
||||||
|
display: block;
|
||||||
|
margin-left: auto;
|
||||||
|
margin-right: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.align-left {
|
||||||
|
text-align: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
.align-center {
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.align-default {
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.align-right {
|
||||||
|
text-align: right;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* -- sidebars -------------------------------------------------------------- */
|
||||||
|
|
||||||
|
div.sidebar {
|
||||||
|
margin: 0 0 0.5em 1em;
|
||||||
|
border: 1px solid #ddb;
|
||||||
|
padding: 7px;
|
||||||
|
background-color: #ffe;
|
||||||
|
width: 40%;
|
||||||
|
float: right;
|
||||||
|
clear: right;
|
||||||
|
overflow-x: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
p.sidebar-title {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.admonition, div.topic, pre, div[class|="highlight"] {
|
||||||
|
clear: both;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* -- topics ---------------------------------------------------------------- */
|
||||||
|
|
||||||
|
div.topic {
|
||||||
|
border: 1px solid #ccc;
|
||||||
|
padding: 7px;
|
||||||
|
margin: 10px 0 10px 0;
|
||||||
|
overflow-x: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
p.topic-title {
|
||||||
|
font-size: 1.1em;
|
||||||
|
font-weight: bold;
|
||||||
|
margin-top: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* -- admonitions ----------------------------------------------------------- */
|
||||||
|
|
||||||
|
div.admonition {
|
||||||
|
margin-top: 10px;
|
||||||
|
margin-bottom: 10px;
|
||||||
|
padding: 7px;
|
||||||
|
overflow-x: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.admonition dt {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
p.admonition-title {
|
||||||
|
margin: 0px 10px 5px 0px;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.body p.centered {
|
||||||
|
text-align: center;
|
||||||
|
margin-top: 25px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* -- content of sidebars/topics/admonitions -------------------------------- */
|
||||||
|
|
||||||
|
div.sidebar > :last-child,
|
||||||
|
div.topic > :last-child,
|
||||||
|
div.admonition > :last-child {
|
||||||
|
margin-bottom: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* -- tables ---------------------------------------------------------------- */
|
||||||
|
|
||||||
|
table.docutils {
|
||||||
|
margin-top: 10px;
|
||||||
|
margin-bottom: 10px;
|
||||||
|
border: 0;
|
||||||
|
border-collapse: collapse;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.align-center {
|
||||||
|
margin-left: auto;
|
||||||
|
margin-right: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.align-default {
|
||||||
|
margin-left: auto;
|
||||||
|
margin-right: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
table caption span.caption-number {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
table caption span.caption-text {
|
||||||
|
}
|
||||||
|
|
||||||
|
table.docutils td, table.docutils th {
|
||||||
|
padding: 1px 8px 1px 5px;
|
||||||
|
border-top: 0;
|
||||||
|
border-left: 0;
|
||||||
|
border-right: 0;
|
||||||
|
border-bottom: 1px solid #aaa;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.footnote td, table.footnote th {
|
||||||
|
border: 0 !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
th {
|
||||||
|
text-align: left;
|
||||||
|
padding-right: 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.citation {
|
||||||
|
border-left: solid 1px gray;
|
||||||
|
margin-left: 1px;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.citation td {
|
||||||
|
border-bottom: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
th > :first-child,
|
||||||
|
td > :first-child {
|
||||||
|
margin-top: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
th > :last-child,
|
||||||
|
td > :last-child {
|
||||||
|
margin-bottom: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* -- figures --------------------------------------------------------------- */
|
||||||
|
|
||||||
|
div.figure {
|
||||||
|
margin: 0.5em;
|
||||||
|
padding: 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.figure p.caption {
|
||||||
|
padding: 0.3em;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.figure p.caption span.caption-number {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.figure p.caption span.caption-text {
|
||||||
|
}
|
||||||
|
|
||||||
|
/* -- field list styles ----------------------------------------------------- */
|
||||||
|
|
||||||
|
table.field-list td, table.field-list th {
|
||||||
|
border: 0 !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.field-list ul {
|
||||||
|
margin: 0;
|
||||||
|
padding-left: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.field-list p {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.field-name {
|
||||||
|
-moz-hyphens: manual;
|
||||||
|
-ms-hyphens: manual;
|
||||||
|
-webkit-hyphens: manual;
|
||||||
|
hyphens: manual;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* -- hlist styles ---------------------------------------------------------- */
|
||||||
|
|
||||||
|
table.hlist {
|
||||||
|
margin: 1em 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.hlist td {
|
||||||
|
vertical-align: top;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/* -- other body styles ----------------------------------------------------- */
|
||||||
|
|
||||||
|
ol.arabic {
|
||||||
|
list-style: decimal;
|
||||||
|
}
|
||||||
|
|
||||||
|
ol.loweralpha {
|
||||||
|
list-style: lower-alpha;
|
||||||
|
}
|
||||||
|
|
||||||
|
ol.upperalpha {
|
||||||
|
list-style: upper-alpha;
|
||||||
|
}
|
||||||
|
|
||||||
|
ol.lowerroman {
|
||||||
|
list-style: lower-roman;
|
||||||
|
}
|
||||||
|
|
||||||
|
ol.upperroman {
|
||||||
|
list-style: upper-roman;
|
||||||
|
}
|
||||||
|
|
||||||
|
ol > li:first-child > :first-child,
|
||||||
|
ul > li:first-child > :first-child {
|
||||||
|
margin-top: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
ol ol > li:first-child > :first-child,
|
||||||
|
ol ul > li:first-child > :first-child,
|
||||||
|
ul ol > li:first-child > :first-child,
|
||||||
|
ul ul > li:first-child > :first-child {
|
||||||
|
margin-top: revert;
|
||||||
|
}
|
||||||
|
|
||||||
|
ol > li:last-child > :last-child,
|
||||||
|
ul > li:last-child > :last-child {
|
||||||
|
margin-bottom: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
ol ol > li:last-child > :last-child,
|
||||||
|
ol ul > li:last-child > :last-child,
|
||||||
|
ul ol > li:last-child > :last-child,
|
||||||
|
ul ul > li:last-child > :last-child {
|
||||||
|
margin-bottom: revert;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.footnote > dt,
|
||||||
|
dl.citation > dt {
|
||||||
|
float: left;
|
||||||
|
margin-right: 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.footnote > dd,
|
||||||
|
dl.citation > dd {
|
||||||
|
margin-bottom: 0em;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.footnote > dd:after,
|
||||||
|
dl.citation > dd:after {
|
||||||
|
content: "";
|
||||||
|
clear: both;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.field-list {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: fit-content(30%) auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.field-list > dt {
|
||||||
|
font-weight: bold;
|
||||||
|
word-break: break-word;
|
||||||
|
padding-left: 0.5em;
|
||||||
|
padding-right: 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.field-list > dt:after {
|
||||||
|
content: ":";
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.field-list > dd {
|
||||||
|
padding-left: 0.5em;
|
||||||
|
margin-top: 0em;
|
||||||
|
margin-left: 0em;
|
||||||
|
margin-bottom: 0em;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl {
|
||||||
|
margin-bottom: 15px;
|
||||||
|
}
|
||||||
|
|
||||||
|
dd > :first-child {
|
||||||
|
margin-top: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
dd ul, dd table {
|
||||||
|
margin-bottom: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
dd {
|
||||||
|
margin-top: 3px;
|
||||||
|
margin-bottom: 10px;
|
||||||
|
margin-left: 30px;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl > dd:last-child,
|
||||||
|
dl > dd:last-child > :last-child {
|
||||||
|
margin-bottom: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
dt:target, span.highlighted {
|
||||||
|
background-color: #fbe54e;
|
||||||
|
}
|
||||||
|
|
||||||
|
rect.highlighted {
|
||||||
|
fill: #fbe54e;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.glossary dt {
|
||||||
|
font-weight: bold;
|
||||||
|
font-size: 1.1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.optional {
|
||||||
|
font-size: 1.3em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.sig-paren {
|
||||||
|
font-size: larger;
|
||||||
|
}
|
||||||
|
|
||||||
|
.versionmodified {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
.system-message {
|
||||||
|
background-color: #fda;
|
||||||
|
padding: 5px;
|
||||||
|
border: 3px solid red;
|
||||||
|
}
|
||||||
|
|
||||||
|
.footnote:target {
|
||||||
|
background-color: #ffa;
|
||||||
|
}
|
||||||
|
|
||||||
|
.line-block {
|
||||||
|
display: block;
|
||||||
|
margin-top: 1em;
|
||||||
|
margin-bottom: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.line-block .line-block {
|
||||||
|
margin-top: 0;
|
||||||
|
margin-bottom: 0;
|
||||||
|
margin-left: 1.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.guilabel, .menuselection {
|
||||||
|
font-family: sans-serif;
|
||||||
|
}
|
||||||
|
|
||||||
|
.accelerator {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
.classifier {
|
||||||
|
font-style: oblique;
|
||||||
|
}
|
||||||
|
|
||||||
|
.classifier:before {
|
||||||
|
font-style: normal;
|
||||||
|
margin: 0.5em;
|
||||||
|
content: ":";
|
||||||
|
}
|
||||||
|
|
||||||
|
abbr, acronym {
|
||||||
|
border-bottom: dotted 1px;
|
||||||
|
cursor: help;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* -- code displays --------------------------------------------------------- */
|
||||||
|
|
||||||
|
pre {
|
||||||
|
overflow: auto;
|
||||||
|
overflow-y: hidden; /* fixes display issues on Chrome browsers */
|
||||||
|
}
|
||||||
|
|
||||||
|
span.pre {
|
||||||
|
-moz-hyphens: none;
|
||||||
|
-ms-hyphens: none;
|
||||||
|
-webkit-hyphens: none;
|
||||||
|
hyphens: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
div[class^="highlight-"] {
|
||||||
|
margin: 1em 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
td.linenos pre {
|
||||||
|
border: 0;
|
||||||
|
background-color: transparent;
|
||||||
|
color: #aaa;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.highlighttable {
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.highlighttable tbody {
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.highlighttable tr {
|
||||||
|
display: flex;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.highlighttable td {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.highlighttable td.linenos {
|
||||||
|
padding-right: 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.highlighttable td.code {
|
||||||
|
flex: 1;
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
.highlight .hll {
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.highlight pre,
|
||||||
|
table.highlighttable pre {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.code-block-caption + div {
|
||||||
|
margin-top: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.code-block-caption {
|
||||||
|
margin-top: 1em;
|
||||||
|
padding: 2px 5px;
|
||||||
|
font-size: small;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.code-block-caption code {
|
||||||
|
background-color: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.highlighttable td.linenos,
|
||||||
|
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
|
||||||
|
user-select: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.code-block-caption span.caption-number {
|
||||||
|
padding: 0.1em 0.3em;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.code-block-caption span.caption-text {
|
||||||
|
}
|
||||||
|
|
||||||
|
div.literal-block-wrapper {
|
||||||
|
margin: 1em 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
code.descname {
|
||||||
|
background-color: transparent;
|
||||||
|
font-weight: bold;
|
||||||
|
font-size: 1.2em;
|
||||||
|
}
|
||||||
|
|
||||||
|
code.descclassname {
|
||||||
|
background-color: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
code.xref, a code {
|
||||||
|
background-color: transparent;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
|
||||||
|
background-color: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
.viewcode-link {
|
||||||
|
float: right;
|
||||||
|
}
|
||||||
|
|
||||||
|
.viewcode-back {
|
||||||
|
float: right;
|
||||||
|
font-family: sans-serif;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.viewcode-block:target {
|
||||||
|
margin: -1px -10px;
|
||||||
|
padding: 0 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* -- math display ---------------------------------------------------------- */
|
||||||
|
|
||||||
|
img.math {
|
||||||
|
vertical-align: middle;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.body div.math p {
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
span.eqno {
|
||||||
|
float: right;
|
||||||
|
}
|
||||||
|
|
||||||
|
span.eqno a.headerlink {
|
||||||
|
position: absolute;
|
||||||
|
z-index: 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.math:hover a.headerlink {
|
||||||
|
visibility: visible;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* -- printout stylesheet --------------------------------------------------- */
|
||||||
|
|
||||||
|
@media print {
|
||||||
|
div.document,
|
||||||
|
div.documentwrapper,
|
||||||
|
div.bodywrapper {
|
||||||
|
margin: 0 !important;
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.sphinxsidebar,
|
||||||
|
div.related,
|
||||||
|
div.footer,
|
||||||
|
#top-link {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
}
|
||||||
315
docs/build/html/_static/doctools.js
vendored
Normal file
315
docs/build/html/_static/doctools.js
vendored
Normal file
|
|
@ -0,0 +1,315 @@
|
||||||
|
/*
|
||||||
|
* doctools.js
|
||||||
|
* ~~~~~~~~~~~
|
||||||
|
*
|
||||||
|
* Sphinx JavaScript utilities for all documentation.
|
||||||
|
*
|
||||||
|
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
||||||
|
* :license: BSD, see LICENSE for details.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* select a different prefix for underscore
|
||||||
|
*/
|
||||||
|
$u = _.noConflict();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* make the code below compatible with browsers without
|
||||||
|
* an installed firebug like debugger
|
||||||
|
if (!window.console || !console.firebug) {
|
||||||
|
var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
|
||||||
|
"dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
|
||||||
|
"profile", "profileEnd"];
|
||||||
|
window.console = {};
|
||||||
|
for (var i = 0; i < names.length; ++i)
|
||||||
|
window.console[names[i]] = function() {};
|
||||||
|
}
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* small helper function to urldecode strings
|
||||||
|
*/
|
||||||
|
jQuery.urldecode = function(x) {
|
||||||
|
return decodeURIComponent(x).replace(/\+/g, ' ');
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* small helper function to urlencode strings
|
||||||
|
*/
|
||||||
|
jQuery.urlencode = encodeURIComponent;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This function returns the parsed url parameters of the
|
||||||
|
* current request. Multiple values per key are supported,
|
||||||
|
* it will always return arrays of strings for the value parts.
|
||||||
|
*/
|
||||||
|
jQuery.getQueryParameters = function(s) {
|
||||||
|
if (typeof s === 'undefined')
|
||||||
|
s = document.location.search;
|
||||||
|
var parts = s.substr(s.indexOf('?') + 1).split('&');
|
||||||
|
var result = {};
|
||||||
|
for (var i = 0; i < parts.length; i++) {
|
||||||
|
var tmp = parts[i].split('=', 2);
|
||||||
|
var key = jQuery.urldecode(tmp[0]);
|
||||||
|
var value = jQuery.urldecode(tmp[1]);
|
||||||
|
if (key in result)
|
||||||
|
result[key].push(value);
|
||||||
|
else
|
||||||
|
result[key] = [value];
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* highlight a given string on a jquery object by wrapping it in
|
||||||
|
* span elements with the given class name.
|
||||||
|
*/
|
||||||
|
jQuery.fn.highlightText = function(text, className) {
|
||||||
|
function highlight(node, addItems) {
|
||||||
|
if (node.nodeType === 3) {
|
||||||
|
var val = node.nodeValue;
|
||||||
|
var pos = val.toLowerCase().indexOf(text);
|
||||||
|
if (pos >= 0 &&
|
||||||
|
!jQuery(node.parentNode).hasClass(className) &&
|
||||||
|
!jQuery(node.parentNode).hasClass("nohighlight")) {
|
||||||
|
var span;
|
||||||
|
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
|
||||||
|
if (isInSVG) {
|
||||||
|
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
|
||||||
|
} else {
|
||||||
|
span = document.createElement("span");
|
||||||
|
span.className = className;
|
||||||
|
}
|
||||||
|
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
|
||||||
|
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
|
||||||
|
document.createTextNode(val.substr(pos + text.length)),
|
||||||
|
node.nextSibling));
|
||||||
|
node.nodeValue = val.substr(0, pos);
|
||||||
|
if (isInSVG) {
|
||||||
|
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
|
||||||
|
var bbox = node.parentElement.getBBox();
|
||||||
|
rect.x.baseVal.value = bbox.x;
|
||||||
|
rect.y.baseVal.value = bbox.y;
|
||||||
|
rect.width.baseVal.value = bbox.width;
|
||||||
|
rect.height.baseVal.value = bbox.height;
|
||||||
|
rect.setAttribute('class', className);
|
||||||
|
addItems.push({
|
||||||
|
"parent": node.parentNode,
|
||||||
|
"target": rect});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (!jQuery(node).is("button, select, textarea")) {
|
||||||
|
jQuery.each(node.childNodes, function() {
|
||||||
|
highlight(this, addItems);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var addItems = [];
|
||||||
|
var result = this.each(function() {
|
||||||
|
highlight(this, addItems);
|
||||||
|
});
|
||||||
|
for (var i = 0; i < addItems.length; ++i) {
|
||||||
|
jQuery(addItems[i].parent).before(addItems[i].target);
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
};
|
||||||
|
|
||||||
|
/*
|
||||||
|
* backward compatibility for jQuery.browser
|
||||||
|
* This will be supported until firefox bug is fixed.
|
||||||
|
*/
|
||||||
|
if (!jQuery.browser) {
|
||||||
|
jQuery.uaMatch = function(ua) {
|
||||||
|
ua = ua.toLowerCase();
|
||||||
|
|
||||||
|
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
|
||||||
|
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
|
||||||
|
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
|
||||||
|
/(msie) ([\w.]+)/.exec(ua) ||
|
||||||
|
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
|
||||||
|
[];
|
||||||
|
|
||||||
|
return {
|
||||||
|
browser: match[ 1 ] || "",
|
||||||
|
version: match[ 2 ] || "0"
|
||||||
|
};
|
||||||
|
};
|
||||||
|
jQuery.browser = {};
|
||||||
|
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Small JavaScript module for the documentation.
|
||||||
|
*/
|
||||||
|
var Documentation = {
|
||||||
|
|
||||||
|
init : function() {
|
||||||
|
this.fixFirefoxAnchorBug();
|
||||||
|
this.highlightSearchWords();
|
||||||
|
this.initIndexTable();
|
||||||
|
if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
|
||||||
|
this.initOnKeyListeners();
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* i18n support
|
||||||
|
*/
|
||||||
|
TRANSLATIONS : {},
|
||||||
|
PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
|
||||||
|
LOCALE : 'unknown',
|
||||||
|
|
||||||
|
// gettext and ngettext don't access this so that the functions
|
||||||
|
// can safely bound to a different name (_ = Documentation.gettext)
|
||||||
|
gettext : function(string) {
|
||||||
|
var translated = Documentation.TRANSLATIONS[string];
|
||||||
|
if (typeof translated === 'undefined')
|
||||||
|
return string;
|
||||||
|
return (typeof translated === 'string') ? translated : translated[0];
|
||||||
|
},
|
||||||
|
|
||||||
|
ngettext : function(singular, plural, n) {
|
||||||
|
var translated = Documentation.TRANSLATIONS[singular];
|
||||||
|
if (typeof translated === 'undefined')
|
||||||
|
return (n == 1) ? singular : plural;
|
||||||
|
return translated[Documentation.PLURALEXPR(n)];
|
||||||
|
},
|
||||||
|
|
||||||
|
addTranslations : function(catalog) {
|
||||||
|
for (var key in catalog.messages)
|
||||||
|
this.TRANSLATIONS[key] = catalog.messages[key];
|
||||||
|
this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
|
||||||
|
this.LOCALE = catalog.locale;
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* add context elements like header anchor links
|
||||||
|
*/
|
||||||
|
addContextElements : function() {
|
||||||
|
$('div[id] > :header:first').each(function() {
|
||||||
|
$('<a class="headerlink">\u00B6</a>').
|
||||||
|
attr('href', '#' + this.id).
|
||||||
|
attr('title', _('Permalink to this headline')).
|
||||||
|
appendTo(this);
|
||||||
|
});
|
||||||
|
$('dt[id]').each(function() {
|
||||||
|
$('<a class="headerlink">\u00B6</a>').
|
||||||
|
attr('href', '#' + this.id).
|
||||||
|
attr('title', _('Permalink to this definition')).
|
||||||
|
appendTo(this);
|
||||||
|
});
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* workaround a firefox stupidity
|
||||||
|
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
|
||||||
|
*/
|
||||||
|
fixFirefoxAnchorBug : function() {
|
||||||
|
if (document.location.hash && $.browser.mozilla)
|
||||||
|
window.setTimeout(function() {
|
||||||
|
document.location.href += '';
|
||||||
|
}, 10);
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* highlight the search words provided in the url in the text
|
||||||
|
*/
|
||||||
|
highlightSearchWords : function() {
|
||||||
|
var params = $.getQueryParameters();
|
||||||
|
var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
|
||||||
|
if (terms.length) {
|
||||||
|
var body = $('div.body');
|
||||||
|
if (!body.length) {
|
||||||
|
body = $('body');
|
||||||
|
}
|
||||||
|
window.setTimeout(function() {
|
||||||
|
$.each(terms, function() {
|
||||||
|
body.highlightText(this.toLowerCase(), 'highlighted');
|
||||||
|
});
|
||||||
|
}, 10);
|
||||||
|
$('<p class="highlight-link"><a href="javascript:Documentation.' +
|
||||||
|
'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
|
||||||
|
.appendTo($('#searchbox'));
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* init the domain index toggle buttons
|
||||||
|
*/
|
||||||
|
initIndexTable : function() {
|
||||||
|
var togglers = $('img.toggler').click(function() {
|
||||||
|
var src = $(this).attr('src');
|
||||||
|
var idnum = $(this).attr('id').substr(7);
|
||||||
|
$('tr.cg-' + idnum).toggle();
|
||||||
|
if (src.substr(-9) === 'minus.png')
|
||||||
|
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
|
||||||
|
else
|
||||||
|
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
|
||||||
|
}).css('display', '');
|
||||||
|
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
|
||||||
|
togglers.click();
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* helper function to hide the search marks again
|
||||||
|
*/
|
||||||
|
hideSearchWords : function() {
|
||||||
|
$('#searchbox .highlight-link').fadeOut(300);
|
||||||
|
$('span.highlighted').removeClass('highlighted');
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* make the url absolute
|
||||||
|
*/
|
||||||
|
makeURL : function(relativeURL) {
|
||||||
|
return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* get the current relative url
|
||||||
|
*/
|
||||||
|
getCurrentURL : function() {
|
||||||
|
var path = document.location.pathname;
|
||||||
|
var parts = path.split(/\//);
|
||||||
|
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
|
||||||
|
if (this === '..')
|
||||||
|
parts.pop();
|
||||||
|
});
|
||||||
|
var url = parts.join('/');
|
||||||
|
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
|
||||||
|
},
|
||||||
|
|
||||||
|
initOnKeyListeners: function() {
|
||||||
|
$(document).keydown(function(event) {
|
||||||
|
var activeElementType = document.activeElement.tagName;
|
||||||
|
// don't navigate when in search box or textarea
|
||||||
|
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
|
||||||
|
&& !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) {
|
||||||
|
switch (event.keyCode) {
|
||||||
|
case 37: // left
|
||||||
|
var prevHref = $('link[rel="prev"]').prop('href');
|
||||||
|
if (prevHref) {
|
||||||
|
window.location.href = prevHref;
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
case 39: // right
|
||||||
|
var nextHref = $('link[rel="next"]').prop('href');
|
||||||
|
if (nextHref) {
|
||||||
|
window.location.href = nextHref;
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// quick alias for translations
|
||||||
|
_ = Documentation.gettext;
|
||||||
|
|
||||||
|
$(document).ready(function() {
|
||||||
|
Documentation.init();
|
||||||
|
});
|
||||||
12
docs/build/html/_static/documentation_options.js
vendored
Normal file
12
docs/build/html/_static/documentation_options.js
vendored
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
var DOCUMENTATION_OPTIONS = {
|
||||||
|
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||||
|
VERSION: '0.0.1',
|
||||||
|
LANGUAGE: 'None',
|
||||||
|
COLLAPSE_INDEX: false,
|
||||||
|
BUILDER: 'html',
|
||||||
|
FILE_SUFFIX: '.html',
|
||||||
|
LINK_SUFFIX: '.html',
|
||||||
|
HAS_SOURCE: true,
|
||||||
|
SOURCELINK_SUFFIX: '.txt',
|
||||||
|
NAVIGATION_WITH_KEYS: false
|
||||||
|
};
|
||||||
BIN
docs/build/html/_static/file.png
vendored
Normal file
BIN
docs/build/html/_static/file.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 286 B |
10872
docs/build/html/_static/jquery-3.5.1.js
vendored
Normal file
10872
docs/build/html/_static/jquery-3.5.1.js
vendored
Normal file
File diff suppressed because it is too large
Load Diff
2
docs/build/html/_static/jquery.js
vendored
Normal file
2
docs/build/html/_static/jquery.js
vendored
Normal file
File diff suppressed because one or more lines are too long
297
docs/build/html/_static/language_data.js
vendored
Normal file
297
docs/build/html/_static/language_data.js
vendored
Normal file
|
|
@ -0,0 +1,297 @@
|
||||||
|
/*
|
||||||
|
* language_data.js
|
||||||
|
* ~~~~~~~~~~~~~~~~
|
||||||
|
*
|
||||||
|
* This script contains the language-specific data used by searchtools.js,
|
||||||
|
* namely the list of stopwords, stemmer, scorer and splitter.
|
||||||
|
*
|
||||||
|
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
||||||
|
* :license: BSD, see LICENSE for details.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
|
||||||
|
|
||||||
|
|
||||||
|
/* Non-minified version JS is _stemmer.js if file is provided */
|
||||||
|
/**
|
||||||
|
* Porter Stemmer
|
||||||
|
*/
|
||||||
|
var Stemmer = function() {
|
||||||
|
|
||||||
|
var step2list = {
|
||||||
|
ational: 'ate',
|
||||||
|
tional: 'tion',
|
||||||
|
enci: 'ence',
|
||||||
|
anci: 'ance',
|
||||||
|
izer: 'ize',
|
||||||
|
bli: 'ble',
|
||||||
|
alli: 'al',
|
||||||
|
entli: 'ent',
|
||||||
|
eli: 'e',
|
||||||
|
ousli: 'ous',
|
||||||
|
ization: 'ize',
|
||||||
|
ation: 'ate',
|
||||||
|
ator: 'ate',
|
||||||
|
alism: 'al',
|
||||||
|
iveness: 'ive',
|
||||||
|
fulness: 'ful',
|
||||||
|
ousness: 'ous',
|
||||||
|
aliti: 'al',
|
||||||
|
iviti: 'ive',
|
||||||
|
biliti: 'ble',
|
||||||
|
logi: 'log'
|
||||||
|
};
|
||||||
|
|
||||||
|
var step3list = {
|
||||||
|
icate: 'ic',
|
||||||
|
ative: '',
|
||||||
|
alize: 'al',
|
||||||
|
iciti: 'ic',
|
||||||
|
ical: 'ic',
|
||||||
|
ful: '',
|
||||||
|
ness: ''
|
||||||
|
};
|
||||||
|
|
||||||
|
var c = "[^aeiou]"; // consonant
|
||||||
|
var v = "[aeiouy]"; // vowel
|
||||||
|
var C = c + "[^aeiouy]*"; // consonant sequence
|
||||||
|
var V = v + "[aeiou]*"; // vowel sequence
|
||||||
|
|
||||||
|
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
|
||||||
|
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
|
||||||
|
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
|
||||||
|
var s_v = "^(" + C + ")?" + v; // vowel in stem
|
||||||
|
|
||||||
|
this.stemWord = function (w) {
|
||||||
|
var stem;
|
||||||
|
var suffix;
|
||||||
|
var firstch;
|
||||||
|
var origword = w;
|
||||||
|
|
||||||
|
if (w.length < 3)
|
||||||
|
return w;
|
||||||
|
|
||||||
|
var re;
|
||||||
|
var re2;
|
||||||
|
var re3;
|
||||||
|
var re4;
|
||||||
|
|
||||||
|
firstch = w.substr(0,1);
|
||||||
|
if (firstch == "y")
|
||||||
|
w = firstch.toUpperCase() + w.substr(1);
|
||||||
|
|
||||||
|
// Step 1a
|
||||||
|
re = /^(.+?)(ss|i)es$/;
|
||||||
|
re2 = /^(.+?)([^s])s$/;
|
||||||
|
|
||||||
|
if (re.test(w))
|
||||||
|
w = w.replace(re,"$1$2");
|
||||||
|
else if (re2.test(w))
|
||||||
|
w = w.replace(re2,"$1$2");
|
||||||
|
|
||||||
|
// Step 1b
|
||||||
|
re = /^(.+?)eed$/;
|
||||||
|
re2 = /^(.+?)(ed|ing)$/;
|
||||||
|
if (re.test(w)) {
|
||||||
|
var fp = re.exec(w);
|
||||||
|
re = new RegExp(mgr0);
|
||||||
|
if (re.test(fp[1])) {
|
||||||
|
re = /.$/;
|
||||||
|
w = w.replace(re,"");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else if (re2.test(w)) {
|
||||||
|
var fp = re2.exec(w);
|
||||||
|
stem = fp[1];
|
||||||
|
re2 = new RegExp(s_v);
|
||||||
|
if (re2.test(stem)) {
|
||||||
|
w = stem;
|
||||||
|
re2 = /(at|bl|iz)$/;
|
||||||
|
re3 = new RegExp("([^aeiouylsz])\\1$");
|
||||||
|
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
||||||
|
if (re2.test(w))
|
||||||
|
w = w + "e";
|
||||||
|
else if (re3.test(w)) {
|
||||||
|
re = /.$/;
|
||||||
|
w = w.replace(re,"");
|
||||||
|
}
|
||||||
|
else if (re4.test(w))
|
||||||
|
w = w + "e";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Step 1c
|
||||||
|
re = /^(.+?)y$/;
|
||||||
|
if (re.test(w)) {
|
||||||
|
var fp = re.exec(w);
|
||||||
|
stem = fp[1];
|
||||||
|
re = new RegExp(s_v);
|
||||||
|
if (re.test(stem))
|
||||||
|
w = stem + "i";
|
||||||
|
}
|
||||||
|
|
||||||
|
// Step 2
|
||||||
|
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
|
||||||
|
if (re.test(w)) {
|
||||||
|
var fp = re.exec(w);
|
||||||
|
stem = fp[1];
|
||||||
|
suffix = fp[2];
|
||||||
|
re = new RegExp(mgr0);
|
||||||
|
if (re.test(stem))
|
||||||
|
w = stem + step2list[suffix];
|
||||||
|
}
|
||||||
|
|
||||||
|
// Step 3
|
||||||
|
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
|
||||||
|
if (re.test(w)) {
|
||||||
|
var fp = re.exec(w);
|
||||||
|
stem = fp[1];
|
||||||
|
suffix = fp[2];
|
||||||
|
re = new RegExp(mgr0);
|
||||||
|
if (re.test(stem))
|
||||||
|
w = stem + step3list[suffix];
|
||||||
|
}
|
||||||
|
|
||||||
|
// Step 4
|
||||||
|
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
|
||||||
|
re2 = /^(.+?)(s|t)(ion)$/;
|
||||||
|
if (re.test(w)) {
|
||||||
|
var fp = re.exec(w);
|
||||||
|
stem = fp[1];
|
||||||
|
re = new RegExp(mgr1);
|
||||||
|
if (re.test(stem))
|
||||||
|
w = stem;
|
||||||
|
}
|
||||||
|
else if (re2.test(w)) {
|
||||||
|
var fp = re2.exec(w);
|
||||||
|
stem = fp[1] + fp[2];
|
||||||
|
re2 = new RegExp(mgr1);
|
||||||
|
if (re2.test(stem))
|
||||||
|
w = stem;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Step 5
|
||||||
|
re = /^(.+?)e$/;
|
||||||
|
if (re.test(w)) {
|
||||||
|
var fp = re.exec(w);
|
||||||
|
stem = fp[1];
|
||||||
|
re = new RegExp(mgr1);
|
||||||
|
re2 = new RegExp(meq1);
|
||||||
|
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
||||||
|
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
|
||||||
|
w = stem;
|
||||||
|
}
|
||||||
|
re = /ll$/;
|
||||||
|
re2 = new RegExp(mgr1);
|
||||||
|
if (re.test(w) && re2.test(w)) {
|
||||||
|
re = /.$/;
|
||||||
|
w = w.replace(re,"");
|
||||||
|
}
|
||||||
|
|
||||||
|
// and turn initial Y back to y
|
||||||
|
if (firstch == "y")
|
||||||
|
w = firstch.toLowerCase() + w.substr(1);
|
||||||
|
return w;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
var splitChars = (function() {
|
||||||
|
var result = {};
|
||||||
|
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
|
||||||
|
1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
|
||||||
|
2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
|
||||||
|
2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
|
||||||
|
3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
|
||||||
|
3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
|
||||||
|
4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
|
||||||
|
8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
|
||||||
|
11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
|
||||||
|
43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
|
||||||
|
var i, j, start, end;
|
||||||
|
for (i = 0; i < singles.length; i++) {
|
||||||
|
result[singles[i]] = true;
|
||||||
|
}
|
||||||
|
var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
|
||||||
|
[722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
|
||||||
|
[1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
|
||||||
|
[1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
|
||||||
|
[1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
|
||||||
|
[2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
|
||||||
|
[2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
|
||||||
|
[2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
|
||||||
|
[2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
|
||||||
|
[2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
|
||||||
|
[2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
|
||||||
|
[2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
|
||||||
|
[3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
|
||||||
|
[3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
|
||||||
|
[3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
|
||||||
|
[3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
|
||||||
|
[3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
|
||||||
|
[3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
|
||||||
|
[4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
|
||||||
|
[4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
|
||||||
|
[4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
|
||||||
|
[4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
|
||||||
|
[5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
|
||||||
|
[6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
|
||||||
|
[6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
|
||||||
|
[6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
|
||||||
|
[6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
|
||||||
|
[7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
|
||||||
|
[7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
|
||||||
|
[8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
|
||||||
|
[8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
|
||||||
|
[8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
|
||||||
|
[10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
|
||||||
|
[11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
|
||||||
|
[12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
|
||||||
|
[12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
|
||||||
|
[12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
|
||||||
|
[19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
|
||||||
|
[42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
|
||||||
|
[42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
|
||||||
|
[43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
|
||||||
|
[43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
|
||||||
|
[43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
|
||||||
|
[43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
|
||||||
|
[44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
|
||||||
|
[57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
|
||||||
|
[64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
|
||||||
|
[65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
|
||||||
|
[65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
|
||||||
|
for (i = 0; i < ranges.length; i++) {
|
||||||
|
start = ranges[i][0];
|
||||||
|
end = ranges[i][1];
|
||||||
|
for (j = start; j <= end; j++) {
|
||||||
|
result[j] = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
})();
|
||||||
|
|
||||||
|
function splitQuery(query) {
|
||||||
|
var result = [];
|
||||||
|
var start = -1;
|
||||||
|
for (var i = 0; i < query.length; i++) {
|
||||||
|
if (splitChars[query.charCodeAt(i)]) {
|
||||||
|
if (start !== -1) {
|
||||||
|
result.push(query.slice(start, i));
|
||||||
|
start = -1;
|
||||||
|
}
|
||||||
|
} else if (start === -1) {
|
||||||
|
start = i;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (start !== -1) {
|
||||||
|
result.push(query.slice(start));
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
BIN
docs/build/html/_static/minus.png
vendored
Normal file
BIN
docs/build/html/_static/minus.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 90 B |
BIN
docs/build/html/_static/plus.png
vendored
Normal file
BIN
docs/build/html/_static/plus.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 90 B |
72
docs/build/html/_static/pygments.css
vendored
Normal file
72
docs/build/html/_static/pygments.css
vendored
Normal file
|
|
@ -0,0 +1,72 @@
|
||||||
|
.highlight .hll { background-color: #4f424c }
|
||||||
|
.highlight { background: #2f1e2e; color: #e7e9db }
|
||||||
|
.highlight .c { color: #776e71 } /* Comment */
|
||||||
|
.highlight .err { color: #ef6155 } /* Error */
|
||||||
|
.highlight .k { color: #815ba4 } /* Keyword */
|
||||||
|
.highlight .l { color: #f99b15 } /* Literal */
|
||||||
|
.highlight .n { color: #e7e9db } /* Name */
|
||||||
|
.highlight .o { color: #5bc4bf } /* Operator */
|
||||||
|
.highlight .p { color: #e7e9db } /* Punctuation */
|
||||||
|
.highlight .ch { color: #776e71 } /* Comment.Hashbang */
|
||||||
|
.highlight .cm { color: #776e71 } /* Comment.Multiline */
|
||||||
|
.highlight .cp { color: #776e71 } /* Comment.Preproc */
|
||||||
|
.highlight .cpf { color: #776e71 } /* Comment.PreprocFile */
|
||||||
|
.highlight .c1 { color: #776e71 } /* Comment.Single */
|
||||||
|
.highlight .cs { color: #776e71 } /* Comment.Special */
|
||||||
|
.highlight .gd { color: #ef6155 } /* Generic.Deleted */
|
||||||
|
.highlight .ge { font-style: italic } /* Generic.Emph */
|
||||||
|
.highlight .gh { color: #e7e9db; font-weight: bold } /* Generic.Heading */
|
||||||
|
.highlight .gi { color: #48b685 } /* Generic.Inserted */
|
||||||
|
.highlight .gp { color: #776e71; font-weight: bold } /* Generic.Prompt */
|
||||||
|
.highlight .gs { font-weight: bold } /* Generic.Strong */
|
||||||
|
.highlight .gu { color: #5bc4bf; font-weight: bold } /* Generic.Subheading */
|
||||||
|
.highlight .kc { color: #815ba4 } /* Keyword.Constant */
|
||||||
|
.highlight .kd { color: #815ba4 } /* Keyword.Declaration */
|
||||||
|
.highlight .kn { color: #5bc4bf } /* Keyword.Namespace */
|
||||||
|
.highlight .kp { color: #815ba4 } /* Keyword.Pseudo */
|
||||||
|
.highlight .kr { color: #815ba4 } /* Keyword.Reserved */
|
||||||
|
.highlight .kt { color: #fec418 } /* Keyword.Type */
|
||||||
|
.highlight .ld { color: #48b685 } /* Literal.Date */
|
||||||
|
.highlight .m { color: #f99b15 } /* Literal.Number */
|
||||||
|
.highlight .s { color: #48b685 } /* Literal.String */
|
||||||
|
.highlight .na { color: #06b6ef } /* Name.Attribute */
|
||||||
|
.highlight .nb { color: #e7e9db } /* Name.Builtin */
|
||||||
|
.highlight .nc { color: #fec418 } /* Name.Class */
|
||||||
|
.highlight .no { color: #ef6155 } /* Name.Constant */
|
||||||
|
.highlight .nd { color: #5bc4bf } /* Name.Decorator */
|
||||||
|
.highlight .ni { color: #e7e9db } /* Name.Entity */
|
||||||
|
.highlight .ne { color: #ef6155 } /* Name.Exception */
|
||||||
|
.highlight .nf { color: #06b6ef } /* Name.Function */
|
||||||
|
.highlight .nl { color: #e7e9db } /* Name.Label */
|
||||||
|
.highlight .nn { color: #fec418 } /* Name.Namespace */
|
||||||
|
.highlight .nx { color: #06b6ef } /* Name.Other */
|
||||||
|
.highlight .py { color: #e7e9db } /* Name.Property */
|
||||||
|
.highlight .nt { color: #5bc4bf } /* Name.Tag */
|
||||||
|
.highlight .nv { color: #ef6155 } /* Name.Variable */
|
||||||
|
.highlight .ow { color: #5bc4bf } /* Operator.Word */
|
||||||
|
.highlight .w { color: #e7e9db } /* Text.Whitespace */
|
||||||
|
.highlight .mb { color: #f99b15 } /* Literal.Number.Bin */
|
||||||
|
.highlight .mf { color: #f99b15 } /* Literal.Number.Float */
|
||||||
|
.highlight .mh { color: #f99b15 } /* Literal.Number.Hex */
|
||||||
|
.highlight .mi { color: #f99b15 } /* Literal.Number.Integer */
|
||||||
|
.highlight .mo { color: #f99b15 } /* Literal.Number.Oct */
|
||||||
|
.highlight .sa { color: #48b685 } /* Literal.String.Affix */
|
||||||
|
.highlight .sb { color: #48b685 } /* Literal.String.Backtick */
|
||||||
|
.highlight .sc { color: #e7e9db } /* Literal.String.Char */
|
||||||
|
.highlight .dl { color: #48b685 } /* Literal.String.Delimiter */
|
||||||
|
.highlight .sd { color: #776e71 } /* Literal.String.Doc */
|
||||||
|
.highlight .s2 { color: #48b685 } /* Literal.String.Double */
|
||||||
|
.highlight .se { color: #f99b15 } /* Literal.String.Escape */
|
||||||
|
.highlight .sh { color: #48b685 } /* Literal.String.Heredoc */
|
||||||
|
.highlight .si { color: #f99b15 } /* Literal.String.Interpol */
|
||||||
|
.highlight .sx { color: #48b685 } /* Literal.String.Other */
|
||||||
|
.highlight .sr { color: #48b685 } /* Literal.String.Regex */
|
||||||
|
.highlight .s1 { color: #48b685 } /* Literal.String.Single */
|
||||||
|
.highlight .ss { color: #48b685 } /* Literal.String.Symbol */
|
||||||
|
.highlight .bp { color: #e7e9db } /* Name.Builtin.Pseudo */
|
||||||
|
.highlight .fm { color: #06b6ef } /* Name.Function.Magic */
|
||||||
|
.highlight .vc { color: #ef6155 } /* Name.Variable.Class */
|
||||||
|
.highlight .vg { color: #ef6155 } /* Name.Variable.Global */
|
||||||
|
.highlight .vi { color: #ef6155 } /* Name.Variable.Instance */
|
||||||
|
.highlight .vm { color: #ef6155 } /* Name.Variable.Magic */
|
||||||
|
.highlight .il { color: #f99b15 } /* Literal.Number.Integer.Long */
|
||||||
515
docs/build/html/_static/searchtools.js
vendored
Normal file
515
docs/build/html/_static/searchtools.js
vendored
Normal file
|
|
@ -0,0 +1,515 @@
|
||||||
|
/*
|
||||||
|
* searchtools.js
|
||||||
|
* ~~~~~~~~~~~~~~~~
|
||||||
|
*
|
||||||
|
* Sphinx JavaScript utilities for the full-text search.
|
||||||
|
*
|
||||||
|
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
||||||
|
* :license: BSD, see LICENSE for details.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
if (!Scorer) {
|
||||||
|
/**
|
||||||
|
* Simple result scoring code.
|
||||||
|
*/
|
||||||
|
var Scorer = {
|
||||||
|
// Implement the following function to further tweak the score for each result
|
||||||
|
// The function takes a result array [filename, title, anchor, descr, score]
|
||||||
|
// and returns the new score.
|
||||||
|
/*
|
||||||
|
score: function(result) {
|
||||||
|
return result[4];
|
||||||
|
},
|
||||||
|
*/
|
||||||
|
|
||||||
|
// query matches the full name of an object
|
||||||
|
objNameMatch: 11,
|
||||||
|
// or matches in the last dotted part of the object name
|
||||||
|
objPartialMatch: 6,
|
||||||
|
// Additive scores depending on the priority of the object
|
||||||
|
objPrio: {0: 15, // used to be importantResults
|
||||||
|
1: 5, // used to be objectResults
|
||||||
|
2: -5}, // used to be unimportantResults
|
||||||
|
// Used when the priority is not in the mapping.
|
||||||
|
objPrioDefault: 0,
|
||||||
|
|
||||||
|
// query found in title
|
||||||
|
title: 15,
|
||||||
|
partialTitle: 7,
|
||||||
|
// query found in terms
|
||||||
|
term: 5,
|
||||||
|
partialTerm: 2
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!splitQuery) {
|
||||||
|
function splitQuery(query) {
|
||||||
|
return query.split(/\s+/);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Search Module
|
||||||
|
*/
|
||||||
|
var Search = {
|
||||||
|
|
||||||
|
_index : null,
|
||||||
|
_queued_query : null,
|
||||||
|
_pulse_status : -1,
|
||||||
|
|
||||||
|
htmlToText : function(htmlString) {
|
||||||
|
var htmlElement = document.createElement('span');
|
||||||
|
htmlElement.innerHTML = htmlString;
|
||||||
|
$(htmlElement).find('.headerlink').remove();
|
||||||
|
docContent = $(htmlElement).find('[role=main]')[0];
|
||||||
|
if(docContent === undefined) {
|
||||||
|
console.warn("Content block not found. Sphinx search tries to obtain it " +
|
||||||
|
"via '[role=main]'. Could you check your theme or template.");
|
||||||
|
return "";
|
||||||
|
}
|
||||||
|
return docContent.textContent || docContent.innerText;
|
||||||
|
},
|
||||||
|
|
||||||
|
init : function() {
|
||||||
|
var params = $.getQueryParameters();
|
||||||
|
if (params.q) {
|
||||||
|
var query = params.q[0];
|
||||||
|
$('input[name="q"]')[0].value = query;
|
||||||
|
this.performSearch(query);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
loadIndex : function(url) {
|
||||||
|
$.ajax({type: "GET", url: url, data: null,
|
||||||
|
dataType: "script", cache: true,
|
||||||
|
complete: function(jqxhr, textstatus) {
|
||||||
|
if (textstatus != "success") {
|
||||||
|
document.getElementById("searchindexloader").src = url;
|
||||||
|
}
|
||||||
|
}});
|
||||||
|
},
|
||||||
|
|
||||||
|
setIndex : function(index) {
|
||||||
|
var q;
|
||||||
|
this._index = index;
|
||||||
|
if ((q = this._queued_query) !== null) {
|
||||||
|
this._queued_query = null;
|
||||||
|
Search.query(q);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
hasIndex : function() {
|
||||||
|
return this._index !== null;
|
||||||
|
},
|
||||||
|
|
||||||
|
deferQuery : function(query) {
|
||||||
|
this._queued_query = query;
|
||||||
|
},
|
||||||
|
|
||||||
|
stopPulse : function() {
|
||||||
|
this._pulse_status = 0;
|
||||||
|
},
|
||||||
|
|
||||||
|
startPulse : function() {
|
||||||
|
if (this._pulse_status >= 0)
|
||||||
|
return;
|
||||||
|
function pulse() {
|
||||||
|
var i;
|
||||||
|
Search._pulse_status = (Search._pulse_status + 1) % 4;
|
||||||
|
var dotString = '';
|
||||||
|
for (i = 0; i < Search._pulse_status; i++)
|
||||||
|
dotString += '.';
|
||||||
|
Search.dots.text(dotString);
|
||||||
|
if (Search._pulse_status > -1)
|
||||||
|
window.setTimeout(pulse, 500);
|
||||||
|
}
|
||||||
|
pulse();
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* perform a search for something (or wait until index is loaded)
|
||||||
|
*/
|
||||||
|
performSearch : function(query) {
|
||||||
|
// create the required interface elements
|
||||||
|
this.out = $('#search-results');
|
||||||
|
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
|
||||||
|
this.dots = $('<span></span>').appendTo(this.title);
|
||||||
|
this.status = $('<p class="search-summary"> </p>').appendTo(this.out);
|
||||||
|
this.output = $('<ul class="search"/>').appendTo(this.out);
|
||||||
|
|
||||||
|
$('#search-progress').text(_('Preparing search...'));
|
||||||
|
this.startPulse();
|
||||||
|
|
||||||
|
// index already loaded, the browser was quick!
|
||||||
|
if (this.hasIndex())
|
||||||
|
this.query(query);
|
||||||
|
else
|
||||||
|
this.deferQuery(query);
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* execute search (requires search index to be loaded)
|
||||||
|
*/
|
||||||
|
query : function(query) {
|
||||||
|
var i;
|
||||||
|
|
||||||
|
// stem the searchterms and add them to the correct list
|
||||||
|
var stemmer = new Stemmer();
|
||||||
|
var searchterms = [];
|
||||||
|
var excluded = [];
|
||||||
|
var hlterms = [];
|
||||||
|
var tmp = splitQuery(query);
|
||||||
|
var objectterms = [];
|
||||||
|
for (i = 0; i < tmp.length; i++) {
|
||||||
|
if (tmp[i] !== "") {
|
||||||
|
objectterms.push(tmp[i].toLowerCase());
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i].match(/^\d+$/) ||
|
||||||
|
tmp[i] === "") {
|
||||||
|
// skip this "word"
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
// stem the word
|
||||||
|
var word = stemmer.stemWord(tmp[i].toLowerCase());
|
||||||
|
// prevent stemmer from cutting word smaller than two chars
|
||||||
|
if(word.length < 3 && tmp[i].length >= 3) {
|
||||||
|
word = tmp[i];
|
||||||
|
}
|
||||||
|
var toAppend;
|
||||||
|
// select the correct list
|
||||||
|
if (word[0] == '-') {
|
||||||
|
toAppend = excluded;
|
||||||
|
word = word.substr(1);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
toAppend = searchterms;
|
||||||
|
hlterms.push(tmp[i].toLowerCase());
|
||||||
|
}
|
||||||
|
// only add if not already in the list
|
||||||
|
if (!$u.contains(toAppend, word))
|
||||||
|
toAppend.push(word);
|
||||||
|
}
|
||||||
|
var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
|
||||||
|
|
||||||
|
// console.debug('SEARCH: searching for:');
|
||||||
|
// console.info('required: ', searchterms);
|
||||||
|
// console.info('excluded: ', excluded);
|
||||||
|
|
||||||
|
// prepare search
|
||||||
|
var terms = this._index.terms;
|
||||||
|
var titleterms = this._index.titleterms;
|
||||||
|
|
||||||
|
// array of [filename, title, anchor, descr, score]
|
||||||
|
var results = [];
|
||||||
|
$('#search-progress').empty();
|
||||||
|
|
||||||
|
// lookup as object
|
||||||
|
for (i = 0; i < objectterms.length; i++) {
|
||||||
|
var others = [].concat(objectterms.slice(0, i),
|
||||||
|
objectterms.slice(i+1, objectterms.length));
|
||||||
|
results = results.concat(this.performObjectSearch(objectterms[i], others));
|
||||||
|
}
|
||||||
|
|
||||||
|
// lookup as search terms in fulltext
|
||||||
|
results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms));
|
||||||
|
|
||||||
|
// let the scorer override scores with a custom scoring function
|
||||||
|
if (Scorer.score) {
|
||||||
|
for (i = 0; i < results.length; i++)
|
||||||
|
results[i][4] = Scorer.score(results[i]);
|
||||||
|
}
|
||||||
|
|
||||||
|
// now sort the results by score (in opposite order of appearance, since the
|
||||||
|
// display function below uses pop() to retrieve items) and then
|
||||||
|
// alphabetically
|
||||||
|
results.sort(function(a, b) {
|
||||||
|
var left = a[4];
|
||||||
|
var right = b[4];
|
||||||
|
if (left > right) {
|
||||||
|
return 1;
|
||||||
|
} else if (left < right) {
|
||||||
|
return -1;
|
||||||
|
} else {
|
||||||
|
// same score: sort alphabetically
|
||||||
|
left = a[1].toLowerCase();
|
||||||
|
right = b[1].toLowerCase();
|
||||||
|
return (left > right) ? -1 : ((left < right) ? 1 : 0);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// for debugging
|
||||||
|
//Search.lastresults = results.slice(); // a copy
|
||||||
|
//console.info('search results:', Search.lastresults);
|
||||||
|
|
||||||
|
// print the results
|
||||||
|
var resultCount = results.length;
|
||||||
|
function displayNextItem() {
|
||||||
|
// results left, load the summary and display it
|
||||||
|
if (results.length) {
|
||||||
|
var item = results.pop();
|
||||||
|
var listItem = $('<li style="display:none"></li>');
|
||||||
|
var requestUrl = "";
|
||||||
|
var linkUrl = "";
|
||||||
|
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
|
||||||
|
// dirhtml builder
|
||||||
|
var dirname = item[0] + '/';
|
||||||
|
if (dirname.match(/\/index\/$/)) {
|
||||||
|
dirname = dirname.substring(0, dirname.length-6);
|
||||||
|
} else if (dirname == 'index/') {
|
||||||
|
dirname = '';
|
||||||
|
}
|
||||||
|
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname;
|
||||||
|
linkUrl = requestUrl;
|
||||||
|
|
||||||
|
} else {
|
||||||
|
// normal html builders
|
||||||
|
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
|
||||||
|
linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX;
|
||||||
|
}
|
||||||
|
listItem.append($('<a/>').attr('href',
|
||||||
|
linkUrl +
|
||||||
|
highlightstring + item[2]).html(item[1]));
|
||||||
|
if (item[3]) {
|
||||||
|
listItem.append($('<span> (' + item[3] + ')</span>'));
|
||||||
|
Search.output.append(listItem);
|
||||||
|
listItem.slideDown(5, function() {
|
||||||
|
displayNextItem();
|
||||||
|
});
|
||||||
|
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
|
||||||
|
$.ajax({url: requestUrl,
|
||||||
|
dataType: "text",
|
||||||
|
complete: function(jqxhr, textstatus) {
|
||||||
|
var data = jqxhr.responseText;
|
||||||
|
if (data !== '' && data !== undefined) {
|
||||||
|
listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
|
||||||
|
}
|
||||||
|
Search.output.append(listItem);
|
||||||
|
listItem.slideDown(5, function() {
|
||||||
|
displayNextItem();
|
||||||
|
});
|
||||||
|
}});
|
||||||
|
} else {
|
||||||
|
// no source available, just display title
|
||||||
|
Search.output.append(listItem);
|
||||||
|
listItem.slideDown(5, function() {
|
||||||
|
displayNextItem();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// search finished, update title and status message
|
||||||
|
else {
|
||||||
|
Search.stopPulse();
|
||||||
|
Search.title.text(_('Search Results'));
|
||||||
|
if (!resultCount)
|
||||||
|
Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
|
||||||
|
else
|
||||||
|
Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
|
||||||
|
Search.status.fadeIn(500);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
displayNextItem();
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* search for object names
|
||||||
|
*/
|
||||||
|
performObjectSearch : function(object, otherterms) {
|
||||||
|
var filenames = this._index.filenames;
|
||||||
|
var docnames = this._index.docnames;
|
||||||
|
var objects = this._index.objects;
|
||||||
|
var objnames = this._index.objnames;
|
||||||
|
var titles = this._index.titles;
|
||||||
|
|
||||||
|
var i;
|
||||||
|
var results = [];
|
||||||
|
|
||||||
|
for (var prefix in objects) {
|
||||||
|
for (var name in objects[prefix]) {
|
||||||
|
var fullname = (prefix ? prefix + '.' : '') + name;
|
||||||
|
var fullnameLower = fullname.toLowerCase()
|
||||||
|
if (fullnameLower.indexOf(object) > -1) {
|
||||||
|
var score = 0;
|
||||||
|
var parts = fullnameLower.split('.');
|
||||||
|
// check for different match types: exact matches of full name or
|
||||||
|
// "last name" (i.e. last dotted part)
|
||||||
|
if (fullnameLower == object || parts[parts.length - 1] == object) {
|
||||||
|
score += Scorer.objNameMatch;
|
||||||
|
// matches in last name
|
||||||
|
} else if (parts[parts.length - 1].indexOf(object) > -1) {
|
||||||
|
score += Scorer.objPartialMatch;
|
||||||
|
}
|
||||||
|
var match = objects[prefix][name];
|
||||||
|
var objname = objnames[match[1]][2];
|
||||||
|
var title = titles[match[0]];
|
||||||
|
// If more than one term searched for, we require other words to be
|
||||||
|
// found in the name/title/description
|
||||||
|
if (otherterms.length > 0) {
|
||||||
|
var haystack = (prefix + ' ' + name + ' ' +
|
||||||
|
objname + ' ' + title).toLowerCase();
|
||||||
|
var allfound = true;
|
||||||
|
for (i = 0; i < otherterms.length; i++) {
|
||||||
|
if (haystack.indexOf(otherterms[i]) == -1) {
|
||||||
|
allfound = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (!allfound) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var descr = objname + _(', in ') + title;
|
||||||
|
|
||||||
|
var anchor = match[3];
|
||||||
|
if (anchor === '')
|
||||||
|
anchor = fullname;
|
||||||
|
else if (anchor == '-')
|
||||||
|
anchor = objnames[match[1]][1] + '-' + fullname;
|
||||||
|
// add custom score for some objects according to scorer
|
||||||
|
if (Scorer.objPrio.hasOwnProperty(match[2])) {
|
||||||
|
score += Scorer.objPrio[match[2]];
|
||||||
|
} else {
|
||||||
|
score += Scorer.objPrioDefault;
|
||||||
|
}
|
||||||
|
results.push([docnames[match[0]], fullname, '#'+anchor, descr, score, filenames[match[0]]]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return results;
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* search for full-text terms in the index
|
||||||
|
*/
|
||||||
|
performTermsSearch : function(searchterms, excluded, terms, titleterms) {
|
||||||
|
var docnames = this._index.docnames;
|
||||||
|
var filenames = this._index.filenames;
|
||||||
|
var titles = this._index.titles;
|
||||||
|
|
||||||
|
var i, j, file;
|
||||||
|
var fileMap = {};
|
||||||
|
var scoreMap = {};
|
||||||
|
var results = [];
|
||||||
|
|
||||||
|
// perform the search on the required terms
|
||||||
|
for (i = 0; i < searchterms.length; i++) {
|
||||||
|
var word = searchterms[i];
|
||||||
|
var files = [];
|
||||||
|
var _o = [
|
||||||
|
{files: terms[word], score: Scorer.term},
|
||||||
|
{files: titleterms[word], score: Scorer.title}
|
||||||
|
];
|
||||||
|
// add support for partial matches
|
||||||
|
if (word.length > 2) {
|
||||||
|
for (var w in terms) {
|
||||||
|
if (w.match(word) && !terms[word]) {
|
||||||
|
_o.push({files: terms[w], score: Scorer.partialTerm})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for (var w in titleterms) {
|
||||||
|
if (w.match(word) && !titleterms[word]) {
|
||||||
|
_o.push({files: titleterms[w], score: Scorer.partialTitle})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// no match but word was a required one
|
||||||
|
if ($u.every(_o, function(o){return o.files === undefined;})) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
// found search word in contents
|
||||||
|
$u.each(_o, function(o) {
|
||||||
|
var _files = o.files;
|
||||||
|
if (_files === undefined)
|
||||||
|
return
|
||||||
|
|
||||||
|
if (_files.length === undefined)
|
||||||
|
_files = [_files];
|
||||||
|
files = files.concat(_files);
|
||||||
|
|
||||||
|
// set score for the word in each file to Scorer.term
|
||||||
|
for (j = 0; j < _files.length; j++) {
|
||||||
|
file = _files[j];
|
||||||
|
if (!(file in scoreMap))
|
||||||
|
scoreMap[file] = {};
|
||||||
|
scoreMap[file][word] = o.score;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// create the mapping
|
||||||
|
for (j = 0; j < files.length; j++) {
|
||||||
|
file = files[j];
|
||||||
|
if (file in fileMap && fileMap[file].indexOf(word) === -1)
|
||||||
|
fileMap[file].push(word);
|
||||||
|
else
|
||||||
|
fileMap[file] = [word];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// now check if the files don't contain excluded terms
|
||||||
|
for (file in fileMap) {
|
||||||
|
var valid = true;
|
||||||
|
|
||||||
|
// check if all requirements are matched
|
||||||
|
var filteredTermCount = // as search terms with length < 3 are discarded: ignore
|
||||||
|
searchterms.filter(function(term){return term.length > 2}).length
|
||||||
|
if (
|
||||||
|
fileMap[file].length != searchterms.length &&
|
||||||
|
fileMap[file].length != filteredTermCount
|
||||||
|
) continue;
|
||||||
|
|
||||||
|
// ensure that none of the excluded terms is in the search result
|
||||||
|
for (i = 0; i < excluded.length; i++) {
|
||||||
|
if (terms[excluded[i]] == file ||
|
||||||
|
titleterms[excluded[i]] == file ||
|
||||||
|
$u.contains(terms[excluded[i]] || [], file) ||
|
||||||
|
$u.contains(titleterms[excluded[i]] || [], file)) {
|
||||||
|
valid = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// if we have still a valid result we can add it to the result list
|
||||||
|
if (valid) {
|
||||||
|
// select one (max) score for the file.
|
||||||
|
// for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
|
||||||
|
var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
|
||||||
|
results.push([docnames[file], titles[file], '', null, score, filenames[file]]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return results;
|
||||||
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* helper function to return a node containing the
|
||||||
|
* search summary for a given text. keywords is a list
|
||||||
|
* of stemmed words, hlwords is the list of normal, unstemmed
|
||||||
|
* words. the first one is used to find the occurrence, the
|
||||||
|
* latter for highlighting it.
|
||||||
|
*/
|
||||||
|
makeSearchSummary : function(htmlText, keywords, hlwords) {
|
||||||
|
var text = Search.htmlToText(htmlText);
|
||||||
|
var textLower = text.toLowerCase();
|
||||||
|
var start = 0;
|
||||||
|
$.each(keywords, function() {
|
||||||
|
var i = textLower.indexOf(this.toLowerCase());
|
||||||
|
if (i > -1)
|
||||||
|
start = i;
|
||||||
|
});
|
||||||
|
start = Math.max(start - 120, 0);
|
||||||
|
var excerpt = ((start > 0) ? '...' : '') +
|
||||||
|
$.trim(text.substr(start, 240)) +
|
||||||
|
((start + 240 - text.length) ? '...' : '');
|
||||||
|
var rv = $('<div class="context"></div>').text(excerpt);
|
||||||
|
$.each(hlwords, function() {
|
||||||
|
rv = rv.highlightText(this, 'highlighted');
|
||||||
|
});
|
||||||
|
return rv;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
$(document).ready(function() {
|
||||||
|
Search.init();
|
||||||
|
});
|
||||||
111
docs/build/html/_static/sphinx_press_theme.css
vendored
Normal file
111
docs/build/html/_static/sphinx_press_theme.css
vendored
Normal file
|
|
@ -0,0 +1,111 @@
|
||||||
|
/*
|
||||||
|
*
|
||||||
|
* Defines default styles specific to Sphinx Press,
|
||||||
|
* on top of VuePress styles
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
/* FONTS FOR THE CODE - will fall back to monospace if unavailable */
|
||||||
|
|
||||||
|
@import url('https://fontlibrary.org/face/roboto-mono');
|
||||||
|
@import url('https://fontlibrary.org/face/inconsolata');
|
||||||
|
|
||||||
|
/* MAKES MAIN TEXT SECTION LARGER */
|
||||||
|
.content:not(.custom) {
|
||||||
|
max-width: 840px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* THE SECTION BELOW DEFINES THE APPEARANCE OF AUTODOC-GENERATED DOCS */
|
||||||
|
|
||||||
|
.sig-name.descname {
|
||||||
|
font-size: 1.2em;
|
||||||
|
font-weight: bold;
|
||||||
|
padding: 0 0 3px; /* creates a perfect grey rectangle*/
|
||||||
|
}
|
||||||
|
|
||||||
|
.sig-param {
|
||||||
|
font-family: 'RobotoMonoRegular', 'Roboto Mono', 'Inconsolata', monospace;
|
||||||
|
margin-left: 0.3em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.sig-paren {
|
||||||
|
margin-left: 0.3em;
|
||||||
|
}
|
||||||
|
|
||||||
|
dt {
|
||||||
|
line-height: 1.5em;
|
||||||
|
margin-bottom: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
dt.field-odd, dt.field-even, p.rubric {
|
||||||
|
font-size: 1.2em;
|
||||||
|
font-weight: bold;
|
||||||
|
color: #4d6a86
|
||||||
|
}
|
||||||
|
|
||||||
|
dd {
|
||||||
|
margin-inline-start: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
dd.field-odd p strong {
|
||||||
|
margin-left: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl.method, dl.function {
|
||||||
|
margin-top: 2em;
|
||||||
|
margin-bottom: 3em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.viewcode-link {
|
||||||
|
margin-left: 1em;
|
||||||
|
color: #9ad8bc;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* THE SECTION BELOW DEFINES THE APPEARANCE OF TABLE-OF-CONTENTS */
|
||||||
|
|
||||||
|
/* color fixes for table of contents */
|
||||||
|
.toc-backref {
|
||||||
|
/* TOCS cause all your section titles to go green. Pouah! */
|
||||||
|
color: inherit;
|
||||||
|
}
|
||||||
|
|
||||||
|
.contents.topic p.topic-title {
|
||||||
|
/* Hide all TOC titles */
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.contents.topic {
|
||||||
|
margin-bottom: 3em;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/* THE SECTION BELOW CHANGES CODE FONTS FOR BETTER 80-CHARS READABILITY */
|
||||||
|
/* Code will be displayed as Roboto, or Inconsolata if screen is small */
|
||||||
|
code, pre {
|
||||||
|
font-family: 'RobotoMonoRegular', 'Roboto Mono', 'Inconsolata', monospace;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (max-width: 1200px) {
|
||||||
|
code, pre {
|
||||||
|
font-family: 'InconsolataRegular', 'Inconsolata', 'RobotoMonoRegular', 'Roboto Mono', monospace;
|
||||||
|
}
|
||||||
|
pre {
|
||||||
|
font-size: 0.95em;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
blockquote {
|
||||||
|
font-size: inherit;
|
||||||
|
}
|
||||||
|
|
||||||
|
blockquote h2 {
|
||||||
|
margin-left: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* THE SECTION BELOW FIXES A SPHINX-MERMAID OPACITY PROBLEM */
|
||||||
|
.content .section {
|
||||||
|
opacity: 1.0 !important;
|
||||||
|
}
|
||||||
|
.section {
|
||||||
|
opacity: 1.0 !important;
|
||||||
|
}
|
||||||
8
docs/build/html/_static/theme-vendors.js
vendored
Normal file
8
docs/build/html/_static/theme-vendors.js
vendored
Normal file
File diff suppressed because one or more lines are too long
1
docs/build/html/_static/theme.css
vendored
Normal file
1
docs/build/html/_static/theme.css
vendored
Normal file
File diff suppressed because one or more lines are too long
2
docs/build/html/_static/theme.js
vendored
Normal file
2
docs/build/html/_static/theme.js
vendored
Normal file
File diff suppressed because one or more lines are too long
999
docs/build/html/_static/underscore-1.3.1.js
vendored
Normal file
999
docs/build/html/_static/underscore-1.3.1.js
vendored
Normal file
|
|
@ -0,0 +1,999 @@
|
||||||
|
// Underscore.js 1.3.1
|
||||||
|
// (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc.
|
||||||
|
// Underscore is freely distributable under the MIT license.
|
||||||
|
// Portions of Underscore are inspired or borrowed from Prototype,
|
||||||
|
// Oliver Steele's Functional, and John Resig's Micro-Templating.
|
||||||
|
// For all details and documentation:
|
||||||
|
// http://documentcloud.github.com/underscore
|
||||||
|
|
||||||
|
(function() {
|
||||||
|
|
||||||
|
// Baseline setup
|
||||||
|
// --------------
|
||||||
|
|
||||||
|
// Establish the root object, `window` in the browser, or `global` on the server.
|
||||||
|
var root = this;
|
||||||
|
|
||||||
|
// Save the previous value of the `_` variable.
|
||||||
|
var previousUnderscore = root._;
|
||||||
|
|
||||||
|
// Establish the object that gets returned to break out of a loop iteration.
|
||||||
|
var breaker = {};
|
||||||
|
|
||||||
|
// Save bytes in the minified (but not gzipped) version:
|
||||||
|
var ArrayProto = Array.prototype, ObjProto = Object.prototype, FuncProto = Function.prototype;
|
||||||
|
|
||||||
|
// Create quick reference variables for speed access to core prototypes.
|
||||||
|
var slice = ArrayProto.slice,
|
||||||
|
unshift = ArrayProto.unshift,
|
||||||
|
toString = ObjProto.toString,
|
||||||
|
hasOwnProperty = ObjProto.hasOwnProperty;
|
||||||
|
|
||||||
|
// All **ECMAScript 5** native function implementations that we hope to use
|
||||||
|
// are declared here.
|
||||||
|
var
|
||||||
|
nativeForEach = ArrayProto.forEach,
|
||||||
|
nativeMap = ArrayProto.map,
|
||||||
|
nativeReduce = ArrayProto.reduce,
|
||||||
|
nativeReduceRight = ArrayProto.reduceRight,
|
||||||
|
nativeFilter = ArrayProto.filter,
|
||||||
|
nativeEvery = ArrayProto.every,
|
||||||
|
nativeSome = ArrayProto.some,
|
||||||
|
nativeIndexOf = ArrayProto.indexOf,
|
||||||
|
nativeLastIndexOf = ArrayProto.lastIndexOf,
|
||||||
|
nativeIsArray = Array.isArray,
|
||||||
|
nativeKeys = Object.keys,
|
||||||
|
nativeBind = FuncProto.bind;
|
||||||
|
|
||||||
|
// Create a safe reference to the Underscore object for use below.
|
||||||
|
var _ = function(obj) { return new wrapper(obj); };
|
||||||
|
|
||||||
|
// Export the Underscore object for **Node.js**, with
|
||||||
|
// backwards-compatibility for the old `require()` API. If we're in
|
||||||
|
// the browser, add `_` as a global object via a string identifier,
|
||||||
|
// for Closure Compiler "advanced" mode.
|
||||||
|
if (typeof exports !== 'undefined') {
|
||||||
|
if (typeof module !== 'undefined' && module.exports) {
|
||||||
|
exports = module.exports = _;
|
||||||
|
}
|
||||||
|
exports._ = _;
|
||||||
|
} else {
|
||||||
|
root['_'] = _;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Current version.
|
||||||
|
_.VERSION = '1.3.1';
|
||||||
|
|
||||||
|
// Collection Functions
|
||||||
|
// --------------------
|
||||||
|
|
||||||
|
// The cornerstone, an `each` implementation, aka `forEach`.
|
||||||
|
// Handles objects with the built-in `forEach`, arrays, and raw objects.
|
||||||
|
// Delegates to **ECMAScript 5**'s native `forEach` if available.
|
||||||
|
var each = _.each = _.forEach = function(obj, iterator, context) {
|
||||||
|
if (obj == null) return;
|
||||||
|
if (nativeForEach && obj.forEach === nativeForEach) {
|
||||||
|
obj.forEach(iterator, context);
|
||||||
|
} else if (obj.length === +obj.length) {
|
||||||
|
for (var i = 0, l = obj.length; i < l; i++) {
|
||||||
|
if (i in obj && iterator.call(context, obj[i], i, obj) === breaker) return;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
for (var key in obj) {
|
||||||
|
if (_.has(obj, key)) {
|
||||||
|
if (iterator.call(context, obj[key], key, obj) === breaker) return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// Return the results of applying the iterator to each element.
|
||||||
|
// Delegates to **ECMAScript 5**'s native `map` if available.
|
||||||
|
_.map = _.collect = function(obj, iterator, context) {
|
||||||
|
var results = [];
|
||||||
|
if (obj == null) return results;
|
||||||
|
if (nativeMap && obj.map === nativeMap) return obj.map(iterator, context);
|
||||||
|
each(obj, function(value, index, list) {
|
||||||
|
results[results.length] = iterator.call(context, value, index, list);
|
||||||
|
});
|
||||||
|
if (obj.length === +obj.length) results.length = obj.length;
|
||||||
|
return results;
|
||||||
|
};
|
||||||
|
|
||||||
|
// **Reduce** builds up a single result from a list of values, aka `inject`,
|
||||||
|
// or `foldl`. Delegates to **ECMAScript 5**'s native `reduce` if available.
|
||||||
|
_.reduce = _.foldl = _.inject = function(obj, iterator, memo, context) {
|
||||||
|
var initial = arguments.length > 2;
|
||||||
|
if (obj == null) obj = [];
|
||||||
|
if (nativeReduce && obj.reduce === nativeReduce) {
|
||||||
|
if (context) iterator = _.bind(iterator, context);
|
||||||
|
return initial ? obj.reduce(iterator, memo) : obj.reduce(iterator);
|
||||||
|
}
|
||||||
|
each(obj, function(value, index, list) {
|
||||||
|
if (!initial) {
|
||||||
|
memo = value;
|
||||||
|
initial = true;
|
||||||
|
} else {
|
||||||
|
memo = iterator.call(context, memo, value, index, list);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
if (!initial) throw new TypeError('Reduce of empty array with no initial value');
|
||||||
|
return memo;
|
||||||
|
};
|
||||||
|
|
||||||
|
// The right-associative version of reduce, also known as `foldr`.
|
||||||
|
// Delegates to **ECMAScript 5**'s native `reduceRight` if available.
|
||||||
|
_.reduceRight = _.foldr = function(obj, iterator, memo, context) {
|
||||||
|
var initial = arguments.length > 2;
|
||||||
|
if (obj == null) obj = [];
|
||||||
|
if (nativeReduceRight && obj.reduceRight === nativeReduceRight) {
|
||||||
|
if (context) iterator = _.bind(iterator, context);
|
||||||
|
return initial ? obj.reduceRight(iterator, memo) : obj.reduceRight(iterator);
|
||||||
|
}
|
||||||
|
var reversed = _.toArray(obj).reverse();
|
||||||
|
if (context && !initial) iterator = _.bind(iterator, context);
|
||||||
|
return initial ? _.reduce(reversed, iterator, memo, context) : _.reduce(reversed, iterator);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Return the first value which passes a truth test. Aliased as `detect`.
|
||||||
|
_.find = _.detect = function(obj, iterator, context) {
|
||||||
|
var result;
|
||||||
|
any(obj, function(value, index, list) {
|
||||||
|
if (iterator.call(context, value, index, list)) {
|
||||||
|
result = value;
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
return result;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Return all the elements that pass a truth test.
|
||||||
|
// Delegates to **ECMAScript 5**'s native `filter` if available.
|
||||||
|
// Aliased as `select`.
|
||||||
|
_.filter = _.select = function(obj, iterator, context) {
|
||||||
|
var results = [];
|
||||||
|
if (obj == null) return results;
|
||||||
|
if (nativeFilter && obj.filter === nativeFilter) return obj.filter(iterator, context);
|
||||||
|
each(obj, function(value, index, list) {
|
||||||
|
if (iterator.call(context, value, index, list)) results[results.length] = value;
|
||||||
|
});
|
||||||
|
return results;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Return all the elements for which a truth test fails.
|
||||||
|
_.reject = function(obj, iterator, context) {
|
||||||
|
var results = [];
|
||||||
|
if (obj == null) return results;
|
||||||
|
each(obj, function(value, index, list) {
|
||||||
|
if (!iterator.call(context, value, index, list)) results[results.length] = value;
|
||||||
|
});
|
||||||
|
return results;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Determine whether all of the elements match a truth test.
|
||||||
|
// Delegates to **ECMAScript 5**'s native `every` if available.
|
||||||
|
// Aliased as `all`.
|
||||||
|
_.every = _.all = function(obj, iterator, context) {
|
||||||
|
var result = true;
|
||||||
|
if (obj == null) return result;
|
||||||
|
if (nativeEvery && obj.every === nativeEvery) return obj.every(iterator, context);
|
||||||
|
each(obj, function(value, index, list) {
|
||||||
|
if (!(result = result && iterator.call(context, value, index, list))) return breaker;
|
||||||
|
});
|
||||||
|
return result;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Determine if at least one element in the object matches a truth test.
|
||||||
|
// Delegates to **ECMAScript 5**'s native `some` if available.
|
||||||
|
// Aliased as `any`.
|
||||||
|
var any = _.some = _.any = function(obj, iterator, context) {
|
||||||
|
iterator || (iterator = _.identity);
|
||||||
|
var result = false;
|
||||||
|
if (obj == null) return result;
|
||||||
|
if (nativeSome && obj.some === nativeSome) return obj.some(iterator, context);
|
||||||
|
each(obj, function(value, index, list) {
|
||||||
|
if (result || (result = iterator.call(context, value, index, list))) return breaker;
|
||||||
|
});
|
||||||
|
return !!result;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Determine if a given value is included in the array or object using `===`.
|
||||||
|
// Aliased as `contains`.
|
||||||
|
_.include = _.contains = function(obj, target) {
|
||||||
|
var found = false;
|
||||||
|
if (obj == null) return found;
|
||||||
|
if (nativeIndexOf && obj.indexOf === nativeIndexOf) return obj.indexOf(target) != -1;
|
||||||
|
found = any(obj, function(value) {
|
||||||
|
return value === target;
|
||||||
|
});
|
||||||
|
return found;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Invoke a method (with arguments) on every item in a collection.
|
||||||
|
_.invoke = function(obj, method) {
|
||||||
|
var args = slice.call(arguments, 2);
|
||||||
|
return _.map(obj, function(value) {
|
||||||
|
return (_.isFunction(method) ? method || value : value[method]).apply(value, args);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
// Convenience version of a common use case of `map`: fetching a property.
|
||||||
|
_.pluck = function(obj, key) {
|
||||||
|
return _.map(obj, function(value){ return value[key]; });
|
||||||
|
};
|
||||||
|
|
||||||
|
// Return the maximum element or (element-based computation).
|
||||||
|
_.max = function(obj, iterator, context) {
|
||||||
|
if (!iterator && _.isArray(obj)) return Math.max.apply(Math, obj);
|
||||||
|
if (!iterator && _.isEmpty(obj)) return -Infinity;
|
||||||
|
var result = {computed : -Infinity};
|
||||||
|
each(obj, function(value, index, list) {
|
||||||
|
var computed = iterator ? iterator.call(context, value, index, list) : value;
|
||||||
|
computed >= result.computed && (result = {value : value, computed : computed});
|
||||||
|
});
|
||||||
|
return result.value;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Return the minimum element (or element-based computation).
|
||||||
|
_.min = function(obj, iterator, context) {
|
||||||
|
if (!iterator && _.isArray(obj)) return Math.min.apply(Math, obj);
|
||||||
|
if (!iterator && _.isEmpty(obj)) return Infinity;
|
||||||
|
var result = {computed : Infinity};
|
||||||
|
each(obj, function(value, index, list) {
|
||||||
|
var computed = iterator ? iterator.call(context, value, index, list) : value;
|
||||||
|
computed < result.computed && (result = {value : value, computed : computed});
|
||||||
|
});
|
||||||
|
return result.value;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Shuffle an array.
|
||||||
|
_.shuffle = function(obj) {
|
||||||
|
var shuffled = [], rand;
|
||||||
|
each(obj, function(value, index, list) {
|
||||||
|
if (index == 0) {
|
||||||
|
shuffled[0] = value;
|
||||||
|
} else {
|
||||||
|
rand = Math.floor(Math.random() * (index + 1));
|
||||||
|
shuffled[index] = shuffled[rand];
|
||||||
|
shuffled[rand] = value;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
return shuffled;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Sort the object's values by a criterion produced by an iterator.
|
||||||
|
_.sortBy = function(obj, iterator, context) {
|
||||||
|
return _.pluck(_.map(obj, function(value, index, list) {
|
||||||
|
return {
|
||||||
|
value : value,
|
||||||
|
criteria : iterator.call(context, value, index, list)
|
||||||
|
};
|
||||||
|
}).sort(function(left, right) {
|
||||||
|
var a = left.criteria, b = right.criteria;
|
||||||
|
return a < b ? -1 : a > b ? 1 : 0;
|
||||||
|
}), 'value');
|
||||||
|
};
|
||||||
|
|
||||||
|
// Groups the object's values by a criterion. Pass either a string attribute
|
||||||
|
// to group by, or a function that returns the criterion.
|
||||||
|
_.groupBy = function(obj, val) {
|
||||||
|
var result = {};
|
||||||
|
var iterator = _.isFunction(val) ? val : function(obj) { return obj[val]; };
|
||||||
|
each(obj, function(value, index) {
|
||||||
|
var key = iterator(value, index);
|
||||||
|
(result[key] || (result[key] = [])).push(value);
|
||||||
|
});
|
||||||
|
return result;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Use a comparator function to figure out at what index an object should
|
||||||
|
// be inserted so as to maintain order. Uses binary search.
|
||||||
|
_.sortedIndex = function(array, obj, iterator) {
|
||||||
|
iterator || (iterator = _.identity);
|
||||||
|
var low = 0, high = array.length;
|
||||||
|
while (low < high) {
|
||||||
|
var mid = (low + high) >> 1;
|
||||||
|
iterator(array[mid]) < iterator(obj) ? low = mid + 1 : high = mid;
|
||||||
|
}
|
||||||
|
return low;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Safely convert anything iterable into a real, live array.
|
||||||
|
_.toArray = function(iterable) {
|
||||||
|
if (!iterable) return [];
|
||||||
|
if (iterable.toArray) return iterable.toArray();
|
||||||
|
if (_.isArray(iterable)) return slice.call(iterable);
|
||||||
|
if (_.isArguments(iterable)) return slice.call(iterable);
|
||||||
|
return _.values(iterable);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Return the number of elements in an object.
|
||||||
|
_.size = function(obj) {
|
||||||
|
return _.toArray(obj).length;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Array Functions
|
||||||
|
// ---------------
|
||||||
|
|
||||||
|
// Get the first element of an array. Passing **n** will return the first N
|
||||||
|
// values in the array. Aliased as `head`. The **guard** check allows it to work
|
||||||
|
// with `_.map`.
|
||||||
|
_.first = _.head = function(array, n, guard) {
|
||||||
|
return (n != null) && !guard ? slice.call(array, 0, n) : array[0];
|
||||||
|
};
|
||||||
|
|
||||||
|
// Returns everything but the last entry of the array. Especcialy useful on
|
||||||
|
// the arguments object. Passing **n** will return all the values in
|
||||||
|
// the array, excluding the last N. The **guard** check allows it to work with
|
||||||
|
// `_.map`.
|
||||||
|
_.initial = function(array, n, guard) {
|
||||||
|
return slice.call(array, 0, array.length - ((n == null) || guard ? 1 : n));
|
||||||
|
};
|
||||||
|
|
||||||
|
// Get the last element of an array. Passing **n** will return the last N
|
||||||
|
// values in the array. The **guard** check allows it to work with `_.map`.
|
||||||
|
_.last = function(array, n, guard) {
|
||||||
|
if ((n != null) && !guard) {
|
||||||
|
return slice.call(array, Math.max(array.length - n, 0));
|
||||||
|
} else {
|
||||||
|
return array[array.length - 1];
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// Returns everything but the first entry of the array. Aliased as `tail`.
|
||||||
|
// Especially useful on the arguments object. Passing an **index** will return
|
||||||
|
// the rest of the values in the array from that index onward. The **guard**
|
||||||
|
// check allows it to work with `_.map`.
|
||||||
|
_.rest = _.tail = function(array, index, guard) {
|
||||||
|
return slice.call(array, (index == null) || guard ? 1 : index);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Trim out all falsy values from an array.
|
||||||
|
_.compact = function(array) {
|
||||||
|
return _.filter(array, function(value){ return !!value; });
|
||||||
|
};
|
||||||
|
|
||||||
|
// Return a completely flattened version of an array.
|
||||||
|
_.flatten = function(array, shallow) {
|
||||||
|
return _.reduce(array, function(memo, value) {
|
||||||
|
if (_.isArray(value)) return memo.concat(shallow ? value : _.flatten(value));
|
||||||
|
memo[memo.length] = value;
|
||||||
|
return memo;
|
||||||
|
}, []);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Return a version of the array that does not contain the specified value(s).
|
||||||
|
_.without = function(array) {
|
||||||
|
return _.difference(array, slice.call(arguments, 1));
|
||||||
|
};
|
||||||
|
|
||||||
|
// Produce a duplicate-free version of the array. If the array has already
|
||||||
|
// been sorted, you have the option of using a faster algorithm.
|
||||||
|
// Aliased as `unique`.
|
||||||
|
_.uniq = _.unique = function(array, isSorted, iterator) {
|
||||||
|
var initial = iterator ? _.map(array, iterator) : array;
|
||||||
|
var result = [];
|
||||||
|
_.reduce(initial, function(memo, el, i) {
|
||||||
|
if (0 == i || (isSorted === true ? _.last(memo) != el : !_.include(memo, el))) {
|
||||||
|
memo[memo.length] = el;
|
||||||
|
result[result.length] = array[i];
|
||||||
|
}
|
||||||
|
return memo;
|
||||||
|
}, []);
|
||||||
|
return result;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Produce an array that contains the union: each distinct element from all of
|
||||||
|
// the passed-in arrays.
|
||||||
|
_.union = function() {
|
||||||
|
return _.uniq(_.flatten(arguments, true));
|
||||||
|
};
|
||||||
|
|
||||||
|
// Produce an array that contains every item shared between all the
|
||||||
|
// passed-in arrays. (Aliased as "intersect" for back-compat.)
|
||||||
|
_.intersection = _.intersect = function(array) {
|
||||||
|
var rest = slice.call(arguments, 1);
|
||||||
|
return _.filter(_.uniq(array), function(item) {
|
||||||
|
return _.every(rest, function(other) {
|
||||||
|
return _.indexOf(other, item) >= 0;
|
||||||
|
});
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
// Take the difference between one array and a number of other arrays.
|
||||||
|
// Only the elements present in just the first array will remain.
|
||||||
|
_.difference = function(array) {
|
||||||
|
var rest = _.flatten(slice.call(arguments, 1));
|
||||||
|
return _.filter(array, function(value){ return !_.include(rest, value); });
|
||||||
|
};
|
||||||
|
|
||||||
|
// Zip together multiple lists into a single array -- elements that share
|
||||||
|
// an index go together.
|
||||||
|
_.zip = function() {
|
||||||
|
var args = slice.call(arguments);
|
||||||
|
var length = _.max(_.pluck(args, 'length'));
|
||||||
|
var results = new Array(length);
|
||||||
|
for (var i = 0; i < length; i++) results[i] = _.pluck(args, "" + i);
|
||||||
|
return results;
|
||||||
|
};
|
||||||
|
|
||||||
|
// If the browser doesn't supply us with indexOf (I'm looking at you, **MSIE**),
|
||||||
|
// we need this function. Return the position of the first occurrence of an
|
||||||
|
// item in an array, or -1 if the item is not included in the array.
|
||||||
|
// Delegates to **ECMAScript 5**'s native `indexOf` if available.
|
||||||
|
// If the array is large and already in sort order, pass `true`
|
||||||
|
// for **isSorted** to use binary search.
|
||||||
|
_.indexOf = function(array, item, isSorted) {
|
||||||
|
if (array == null) return -1;
|
||||||
|
var i, l;
|
||||||
|
if (isSorted) {
|
||||||
|
i = _.sortedIndex(array, item);
|
||||||
|
return array[i] === item ? i : -1;
|
||||||
|
}
|
||||||
|
if (nativeIndexOf && array.indexOf === nativeIndexOf) return array.indexOf(item);
|
||||||
|
for (i = 0, l = array.length; i < l; i++) if (i in array && array[i] === item) return i;
|
||||||
|
return -1;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Delegates to **ECMAScript 5**'s native `lastIndexOf` if available.
|
||||||
|
_.lastIndexOf = function(array, item) {
|
||||||
|
if (array == null) return -1;
|
||||||
|
if (nativeLastIndexOf && array.lastIndexOf === nativeLastIndexOf) return array.lastIndexOf(item);
|
||||||
|
var i = array.length;
|
||||||
|
while (i--) if (i in array && array[i] === item) return i;
|
||||||
|
return -1;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Generate an integer Array containing an arithmetic progression. A port of
|
||||||
|
// the native Python `range()` function. See
|
||||||
|
// [the Python documentation](http://docs.python.org/library/functions.html#range).
|
||||||
|
_.range = function(start, stop, step) {
|
||||||
|
if (arguments.length <= 1) {
|
||||||
|
stop = start || 0;
|
||||||
|
start = 0;
|
||||||
|
}
|
||||||
|
step = arguments[2] || 1;
|
||||||
|
|
||||||
|
var len = Math.max(Math.ceil((stop - start) / step), 0);
|
||||||
|
var idx = 0;
|
||||||
|
var range = new Array(len);
|
||||||
|
|
||||||
|
while(idx < len) {
|
||||||
|
range[idx++] = start;
|
||||||
|
start += step;
|
||||||
|
}
|
||||||
|
|
||||||
|
return range;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Function (ahem) Functions
|
||||||
|
// ------------------
|
||||||
|
|
||||||
|
// Reusable constructor function for prototype setting.
|
||||||
|
var ctor = function(){};
|
||||||
|
|
||||||
|
// Create a function bound to a given object (assigning `this`, and arguments,
|
||||||
|
// optionally). Binding with arguments is also known as `curry`.
|
||||||
|
// Delegates to **ECMAScript 5**'s native `Function.bind` if available.
|
||||||
|
// We check for `func.bind` first, to fail fast when `func` is undefined.
|
||||||
|
_.bind = function bind(func, context) {
|
||||||
|
var bound, args;
|
||||||
|
if (func.bind === nativeBind && nativeBind) return nativeBind.apply(func, slice.call(arguments, 1));
|
||||||
|
if (!_.isFunction(func)) throw new TypeError;
|
||||||
|
args = slice.call(arguments, 2);
|
||||||
|
return bound = function() {
|
||||||
|
if (!(this instanceof bound)) return func.apply(context, args.concat(slice.call(arguments)));
|
||||||
|
ctor.prototype = func.prototype;
|
||||||
|
var self = new ctor;
|
||||||
|
var result = func.apply(self, args.concat(slice.call(arguments)));
|
||||||
|
if (Object(result) === result) return result;
|
||||||
|
return self;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
// Bind all of an object's methods to that object. Useful for ensuring that
|
||||||
|
// all callbacks defined on an object belong to it.
|
||||||
|
_.bindAll = function(obj) {
|
||||||
|
var funcs = slice.call(arguments, 1);
|
||||||
|
if (funcs.length == 0) funcs = _.functions(obj);
|
||||||
|
each(funcs, function(f) { obj[f] = _.bind(obj[f], obj); });
|
||||||
|
return obj;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Memoize an expensive function by storing its results.
|
||||||
|
_.memoize = function(func, hasher) {
|
||||||
|
var memo = {};
|
||||||
|
hasher || (hasher = _.identity);
|
||||||
|
return function() {
|
||||||
|
var key = hasher.apply(this, arguments);
|
||||||
|
return _.has(memo, key) ? memo[key] : (memo[key] = func.apply(this, arguments));
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
// Delays a function for the given number of milliseconds, and then calls
|
||||||
|
// it with the arguments supplied.
|
||||||
|
_.delay = function(func, wait) {
|
||||||
|
var args = slice.call(arguments, 2);
|
||||||
|
return setTimeout(function(){ return func.apply(func, args); }, wait);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Defers a function, scheduling it to run after the current call stack has
|
||||||
|
// cleared.
|
||||||
|
_.defer = function(func) {
|
||||||
|
return _.delay.apply(_, [func, 1].concat(slice.call(arguments, 1)));
|
||||||
|
};
|
||||||
|
|
||||||
|
// Returns a function, that, when invoked, will only be triggered at most once
|
||||||
|
// during a given window of time.
|
||||||
|
_.throttle = function(func, wait) {
|
||||||
|
var context, args, timeout, throttling, more;
|
||||||
|
var whenDone = _.debounce(function(){ more = throttling = false; }, wait);
|
||||||
|
return function() {
|
||||||
|
context = this; args = arguments;
|
||||||
|
var later = function() {
|
||||||
|
timeout = null;
|
||||||
|
if (more) func.apply(context, args);
|
||||||
|
whenDone();
|
||||||
|
};
|
||||||
|
if (!timeout) timeout = setTimeout(later, wait);
|
||||||
|
if (throttling) {
|
||||||
|
more = true;
|
||||||
|
} else {
|
||||||
|
func.apply(context, args);
|
||||||
|
}
|
||||||
|
whenDone();
|
||||||
|
throttling = true;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
// Returns a function, that, as long as it continues to be invoked, will not
|
||||||
|
// be triggered. The function will be called after it stops being called for
|
||||||
|
// N milliseconds.
|
||||||
|
_.debounce = function(func, wait) {
|
||||||
|
var timeout;
|
||||||
|
return function() {
|
||||||
|
var context = this, args = arguments;
|
||||||
|
var later = function() {
|
||||||
|
timeout = null;
|
||||||
|
func.apply(context, args);
|
||||||
|
};
|
||||||
|
clearTimeout(timeout);
|
||||||
|
timeout = setTimeout(later, wait);
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
// Returns a function that will be executed at most one time, no matter how
|
||||||
|
// often you call it. Useful for lazy initialization.
|
||||||
|
_.once = function(func) {
|
||||||
|
var ran = false, memo;
|
||||||
|
return function() {
|
||||||
|
if (ran) return memo;
|
||||||
|
ran = true;
|
||||||
|
return memo = func.apply(this, arguments);
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
// Returns the first function passed as an argument to the second,
|
||||||
|
// allowing you to adjust arguments, run code before and after, and
|
||||||
|
// conditionally execute the original function.
|
||||||
|
_.wrap = function(func, wrapper) {
|
||||||
|
return function() {
|
||||||
|
var args = [func].concat(slice.call(arguments, 0));
|
||||||
|
return wrapper.apply(this, args);
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
// Returns a function that is the composition of a list of functions, each
|
||||||
|
// consuming the return value of the function that follows.
|
||||||
|
_.compose = function() {
|
||||||
|
var funcs = arguments;
|
||||||
|
return function() {
|
||||||
|
var args = arguments;
|
||||||
|
for (var i = funcs.length - 1; i >= 0; i--) {
|
||||||
|
args = [funcs[i].apply(this, args)];
|
||||||
|
}
|
||||||
|
return args[0];
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
// Returns a function that will only be executed after being called N times.
|
||||||
|
_.after = function(times, func) {
|
||||||
|
if (times <= 0) return func();
|
||||||
|
return function() {
|
||||||
|
if (--times < 1) { return func.apply(this, arguments); }
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
// Object Functions
|
||||||
|
// ----------------
|
||||||
|
|
||||||
|
// Retrieve the names of an object's properties.
|
||||||
|
// Delegates to **ECMAScript 5**'s native `Object.keys`
|
||||||
|
_.keys = nativeKeys || function(obj) {
|
||||||
|
if (obj !== Object(obj)) throw new TypeError('Invalid object');
|
||||||
|
var keys = [];
|
||||||
|
for (var key in obj) if (_.has(obj, key)) keys[keys.length] = key;
|
||||||
|
return keys;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Retrieve the values of an object's properties.
|
||||||
|
_.values = function(obj) {
|
||||||
|
return _.map(obj, _.identity);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Return a sorted list of the function names available on the object.
|
||||||
|
// Aliased as `methods`
|
||||||
|
_.functions = _.methods = function(obj) {
|
||||||
|
var names = [];
|
||||||
|
for (var key in obj) {
|
||||||
|
if (_.isFunction(obj[key])) names.push(key);
|
||||||
|
}
|
||||||
|
return names.sort();
|
||||||
|
};
|
||||||
|
|
||||||
|
// Extend a given object with all the properties in passed-in object(s).
|
||||||
|
_.extend = function(obj) {
|
||||||
|
each(slice.call(arguments, 1), function(source) {
|
||||||
|
for (var prop in source) {
|
||||||
|
obj[prop] = source[prop];
|
||||||
|
}
|
||||||
|
});
|
||||||
|
return obj;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Fill in a given object with default properties.
|
||||||
|
_.defaults = function(obj) {
|
||||||
|
each(slice.call(arguments, 1), function(source) {
|
||||||
|
for (var prop in source) {
|
||||||
|
if (obj[prop] == null) obj[prop] = source[prop];
|
||||||
|
}
|
||||||
|
});
|
||||||
|
return obj;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Create a (shallow-cloned) duplicate of an object.
|
||||||
|
_.clone = function(obj) {
|
||||||
|
if (!_.isObject(obj)) return obj;
|
||||||
|
return _.isArray(obj) ? obj.slice() : _.extend({}, obj);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Invokes interceptor with the obj, and then returns obj.
|
||||||
|
// The primary purpose of this method is to "tap into" a method chain, in
|
||||||
|
// order to perform operations on intermediate results within the chain.
|
||||||
|
_.tap = function(obj, interceptor) {
|
||||||
|
interceptor(obj);
|
||||||
|
return obj;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Internal recursive comparison function.
|
||||||
|
function eq(a, b, stack) {
|
||||||
|
// Identical objects are equal. `0 === -0`, but they aren't identical.
|
||||||
|
// See the Harmony `egal` proposal: http://wiki.ecmascript.org/doku.php?id=harmony:egal.
|
||||||
|
if (a === b) return a !== 0 || 1 / a == 1 / b;
|
||||||
|
// A strict comparison is necessary because `null == undefined`.
|
||||||
|
if (a == null || b == null) return a === b;
|
||||||
|
// Unwrap any wrapped objects.
|
||||||
|
if (a._chain) a = a._wrapped;
|
||||||
|
if (b._chain) b = b._wrapped;
|
||||||
|
// Invoke a custom `isEqual` method if one is provided.
|
||||||
|
if (a.isEqual && _.isFunction(a.isEqual)) return a.isEqual(b);
|
||||||
|
if (b.isEqual && _.isFunction(b.isEqual)) return b.isEqual(a);
|
||||||
|
// Compare `[[Class]]` names.
|
||||||
|
var className = toString.call(a);
|
||||||
|
if (className != toString.call(b)) return false;
|
||||||
|
switch (className) {
|
||||||
|
// Strings, numbers, dates, and booleans are compared by value.
|
||||||
|
case '[object String]':
|
||||||
|
// Primitives and their corresponding object wrappers are equivalent; thus, `"5"` is
|
||||||
|
// equivalent to `new String("5")`.
|
||||||
|
return a == String(b);
|
||||||
|
case '[object Number]':
|
||||||
|
// `NaN`s are equivalent, but non-reflexive. An `egal` comparison is performed for
|
||||||
|
// other numeric values.
|
||||||
|
return a != +a ? b != +b : (a == 0 ? 1 / a == 1 / b : a == +b);
|
||||||
|
case '[object Date]':
|
||||||
|
case '[object Boolean]':
|
||||||
|
// Coerce dates and booleans to numeric primitive values. Dates are compared by their
|
||||||
|
// millisecond representations. Note that invalid dates with millisecond representations
|
||||||
|
// of `NaN` are not equivalent.
|
||||||
|
return +a == +b;
|
||||||
|
// RegExps are compared by their source patterns and flags.
|
||||||
|
case '[object RegExp]':
|
||||||
|
return a.source == b.source &&
|
||||||
|
a.global == b.global &&
|
||||||
|
a.multiline == b.multiline &&
|
||||||
|
a.ignoreCase == b.ignoreCase;
|
||||||
|
}
|
||||||
|
if (typeof a != 'object' || typeof b != 'object') return false;
|
||||||
|
// Assume equality for cyclic structures. The algorithm for detecting cyclic
|
||||||
|
// structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`.
|
||||||
|
var length = stack.length;
|
||||||
|
while (length--) {
|
||||||
|
// Linear search. Performance is inversely proportional to the number of
|
||||||
|
// unique nested structures.
|
||||||
|
if (stack[length] == a) return true;
|
||||||
|
}
|
||||||
|
// Add the first object to the stack of traversed objects.
|
||||||
|
stack.push(a);
|
||||||
|
var size = 0, result = true;
|
||||||
|
// Recursively compare objects and arrays.
|
||||||
|
if (className == '[object Array]') {
|
||||||
|
// Compare array lengths to determine if a deep comparison is necessary.
|
||||||
|
size = a.length;
|
||||||
|
result = size == b.length;
|
||||||
|
if (result) {
|
||||||
|
// Deep compare the contents, ignoring non-numeric properties.
|
||||||
|
while (size--) {
|
||||||
|
// Ensure commutative equality for sparse arrays.
|
||||||
|
if (!(result = size in a == size in b && eq(a[size], b[size], stack))) break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// Objects with different constructors are not equivalent.
|
||||||
|
if ('constructor' in a != 'constructor' in b || a.constructor != b.constructor) return false;
|
||||||
|
// Deep compare objects.
|
||||||
|
for (var key in a) {
|
||||||
|
if (_.has(a, key)) {
|
||||||
|
// Count the expected number of properties.
|
||||||
|
size++;
|
||||||
|
// Deep compare each member.
|
||||||
|
if (!(result = _.has(b, key) && eq(a[key], b[key], stack))) break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Ensure that both objects contain the same number of properties.
|
||||||
|
if (result) {
|
||||||
|
for (key in b) {
|
||||||
|
if (_.has(b, key) && !(size--)) break;
|
||||||
|
}
|
||||||
|
result = !size;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Remove the first object from the stack of traversed objects.
|
||||||
|
stack.pop();
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Perform a deep comparison to check if two objects are equal.
|
||||||
|
_.isEqual = function(a, b) {
|
||||||
|
return eq(a, b, []);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Is a given array, string, or object empty?
|
||||||
|
// An "empty" object has no enumerable own-properties.
|
||||||
|
_.isEmpty = function(obj) {
|
||||||
|
if (_.isArray(obj) || _.isString(obj)) return obj.length === 0;
|
||||||
|
for (var key in obj) if (_.has(obj, key)) return false;
|
||||||
|
return true;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Is a given value a DOM element?
|
||||||
|
_.isElement = function(obj) {
|
||||||
|
return !!(obj && obj.nodeType == 1);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Is a given value an array?
|
||||||
|
// Delegates to ECMA5's native Array.isArray
|
||||||
|
_.isArray = nativeIsArray || function(obj) {
|
||||||
|
return toString.call(obj) == '[object Array]';
|
||||||
|
};
|
||||||
|
|
||||||
|
// Is a given variable an object?
|
||||||
|
_.isObject = function(obj) {
|
||||||
|
return obj === Object(obj);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Is a given variable an arguments object?
|
||||||
|
_.isArguments = function(obj) {
|
||||||
|
return toString.call(obj) == '[object Arguments]';
|
||||||
|
};
|
||||||
|
if (!_.isArguments(arguments)) {
|
||||||
|
_.isArguments = function(obj) {
|
||||||
|
return !!(obj && _.has(obj, 'callee'));
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// Is a given value a function?
|
||||||
|
_.isFunction = function(obj) {
|
||||||
|
return toString.call(obj) == '[object Function]';
|
||||||
|
};
|
||||||
|
|
||||||
|
// Is a given value a string?
|
||||||
|
_.isString = function(obj) {
|
||||||
|
return toString.call(obj) == '[object String]';
|
||||||
|
};
|
||||||
|
|
||||||
|
// Is a given value a number?
|
||||||
|
_.isNumber = function(obj) {
|
||||||
|
return toString.call(obj) == '[object Number]';
|
||||||
|
};
|
||||||
|
|
||||||
|
// Is the given value `NaN`?
|
||||||
|
_.isNaN = function(obj) {
|
||||||
|
// `NaN` is the only value for which `===` is not reflexive.
|
||||||
|
return obj !== obj;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Is a given value a boolean?
|
||||||
|
_.isBoolean = function(obj) {
|
||||||
|
return obj === true || obj === false || toString.call(obj) == '[object Boolean]';
|
||||||
|
};
|
||||||
|
|
||||||
|
// Is a given value a date?
|
||||||
|
_.isDate = function(obj) {
|
||||||
|
return toString.call(obj) == '[object Date]';
|
||||||
|
};
|
||||||
|
|
||||||
|
// Is the given value a regular expression?
|
||||||
|
_.isRegExp = function(obj) {
|
||||||
|
return toString.call(obj) == '[object RegExp]';
|
||||||
|
};
|
||||||
|
|
||||||
|
// Is a given value equal to null?
|
||||||
|
_.isNull = function(obj) {
|
||||||
|
return obj === null;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Is a given variable undefined?
|
||||||
|
_.isUndefined = function(obj) {
|
||||||
|
return obj === void 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Has own property?
|
||||||
|
_.has = function(obj, key) {
|
||||||
|
return hasOwnProperty.call(obj, key);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Utility Functions
|
||||||
|
// -----------------
|
||||||
|
|
||||||
|
// Run Underscore.js in *noConflict* mode, returning the `_` variable to its
|
||||||
|
// previous owner. Returns a reference to the Underscore object.
|
||||||
|
_.noConflict = function() {
|
||||||
|
root._ = previousUnderscore;
|
||||||
|
return this;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Keep the identity function around for default iterators.
|
||||||
|
_.identity = function(value) {
|
||||||
|
return value;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Run a function **n** times.
|
||||||
|
_.times = function (n, iterator, context) {
|
||||||
|
for (var i = 0; i < n; i++) iterator.call(context, i);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Escape a string for HTML interpolation.
|
||||||
|
_.escape = function(string) {
|
||||||
|
return (''+string).replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>').replace(/"/g, '"').replace(/'/g, ''').replace(/\//g,'/');
|
||||||
|
};
|
||||||
|
|
||||||
|
// Add your own custom functions to the Underscore object, ensuring that
|
||||||
|
// they're correctly added to the OOP wrapper as well.
|
||||||
|
_.mixin = function(obj) {
|
||||||
|
each(_.functions(obj), function(name){
|
||||||
|
addToWrapper(name, _[name] = obj[name]);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
// Generate a unique integer id (unique within the entire client session).
|
||||||
|
// Useful for temporary DOM ids.
|
||||||
|
var idCounter = 0;
|
||||||
|
_.uniqueId = function(prefix) {
|
||||||
|
var id = idCounter++;
|
||||||
|
return prefix ? prefix + id : id;
|
||||||
|
};
|
||||||
|
|
||||||
|
// By default, Underscore uses ERB-style template delimiters, change the
|
||||||
|
// following template settings to use alternative delimiters.
|
||||||
|
_.templateSettings = {
|
||||||
|
evaluate : /<%([\s\S]+?)%>/g,
|
||||||
|
interpolate : /<%=([\s\S]+?)%>/g,
|
||||||
|
escape : /<%-([\s\S]+?)%>/g
|
||||||
|
};
|
||||||
|
|
||||||
|
// When customizing `templateSettings`, if you don't want to define an
|
||||||
|
// interpolation, evaluation or escaping regex, we need one that is
|
||||||
|
// guaranteed not to match.
|
||||||
|
var noMatch = /.^/;
|
||||||
|
|
||||||
|
// Within an interpolation, evaluation, or escaping, remove HTML escaping
|
||||||
|
// that had been previously added.
|
||||||
|
var unescape = function(code) {
|
||||||
|
return code.replace(/\\\\/g, '\\').replace(/\\'/g, "'");
|
||||||
|
};
|
||||||
|
|
||||||
|
// JavaScript micro-templating, similar to John Resig's implementation.
|
||||||
|
// Underscore templating handles arbitrary delimiters, preserves whitespace,
|
||||||
|
// and correctly escapes quotes within interpolated code.
|
||||||
|
_.template = function(str, data) {
|
||||||
|
var c = _.templateSettings;
|
||||||
|
var tmpl = 'var __p=[],print=function(){__p.push.apply(__p,arguments);};' +
|
||||||
|
'with(obj||{}){__p.push(\'' +
|
||||||
|
str.replace(/\\/g, '\\\\')
|
||||||
|
.replace(/'/g, "\\'")
|
||||||
|
.replace(c.escape || noMatch, function(match, code) {
|
||||||
|
return "',_.escape(" + unescape(code) + "),'";
|
||||||
|
})
|
||||||
|
.replace(c.interpolate || noMatch, function(match, code) {
|
||||||
|
return "'," + unescape(code) + ",'";
|
||||||
|
})
|
||||||
|
.replace(c.evaluate || noMatch, function(match, code) {
|
||||||
|
return "');" + unescape(code).replace(/[\r\n\t]/g, ' ') + ";__p.push('";
|
||||||
|
})
|
||||||
|
.replace(/\r/g, '\\r')
|
||||||
|
.replace(/\n/g, '\\n')
|
||||||
|
.replace(/\t/g, '\\t')
|
||||||
|
+ "');}return __p.join('');";
|
||||||
|
var func = new Function('obj', '_', tmpl);
|
||||||
|
if (data) return func(data, _);
|
||||||
|
return function(data) {
|
||||||
|
return func.call(this, data, _);
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
// Add a "chain" function, which will delegate to the wrapper.
|
||||||
|
_.chain = function(obj) {
|
||||||
|
return _(obj).chain();
|
||||||
|
};
|
||||||
|
|
||||||
|
// The OOP Wrapper
|
||||||
|
// ---------------
|
||||||
|
|
||||||
|
// If Underscore is called as a function, it returns a wrapped object that
|
||||||
|
// can be used OO-style. This wrapper holds altered versions of all the
|
||||||
|
// underscore functions. Wrapped objects may be chained.
|
||||||
|
var wrapper = function(obj) { this._wrapped = obj; };
|
||||||
|
|
||||||
|
// Expose `wrapper.prototype` as `_.prototype`
|
||||||
|
_.prototype = wrapper.prototype;
|
||||||
|
|
||||||
|
// Helper function to continue chaining intermediate results.
|
||||||
|
var result = function(obj, chain) {
|
||||||
|
return chain ? _(obj).chain() : obj;
|
||||||
|
};
|
||||||
|
|
||||||
|
// A method to easily add functions to the OOP wrapper.
|
||||||
|
var addToWrapper = function(name, func) {
|
||||||
|
wrapper.prototype[name] = function() {
|
||||||
|
var args = slice.call(arguments);
|
||||||
|
unshift.call(args, this._wrapped);
|
||||||
|
return result(func.apply(_, args), this._chain);
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
// Add all of the Underscore functions to the wrapper object.
|
||||||
|
_.mixin(_);
|
||||||
|
|
||||||
|
// Add all mutator Array functions to the wrapper.
|
||||||
|
each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
|
||||||
|
var method = ArrayProto[name];
|
||||||
|
wrapper.prototype[name] = function() {
|
||||||
|
var wrapped = this._wrapped;
|
||||||
|
method.apply(wrapped, arguments);
|
||||||
|
var length = wrapped.length;
|
||||||
|
if ((name == 'shift' || name == 'splice') && length === 0) delete wrapped[0];
|
||||||
|
return result(wrapped, this._chain);
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
// Add all accessor Array functions to the wrapper.
|
||||||
|
each(['concat', 'join', 'slice'], function(name) {
|
||||||
|
var method = ArrayProto[name];
|
||||||
|
wrapper.prototype[name] = function() {
|
||||||
|
return result(method.apply(this._wrapped, arguments), this._chain);
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
// Start chaining a wrapped Underscore object.
|
||||||
|
wrapper.prototype.chain = function() {
|
||||||
|
this._chain = true;
|
||||||
|
return this;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Extracts the result from a wrapped and chained object.
|
||||||
|
wrapper.prototype.value = function() {
|
||||||
|
return this._wrapped;
|
||||||
|
};
|
||||||
|
|
||||||
|
}).call(this);
|
||||||
31
docs/build/html/_static/underscore.js
vendored
Normal file
31
docs/build/html/_static/underscore.js
vendored
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
// Underscore.js 1.3.1
|
||||||
|
// (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc.
|
||||||
|
// Underscore is freely distributable under the MIT license.
|
||||||
|
// Portions of Underscore are inspired or borrowed from Prototype,
|
||||||
|
// Oliver Steele's Functional, and John Resig's Micro-Templating.
|
||||||
|
// For all details and documentation:
|
||||||
|
// http://documentcloud.github.com/underscore
|
||||||
|
(function(){function q(a,c,d){if(a===c)return a!==0||1/a==1/c;if(a==null||c==null)return a===c;if(a._chain)a=a._wrapped;if(c._chain)c=c._wrapped;if(a.isEqual&&b.isFunction(a.isEqual))return a.isEqual(c);if(c.isEqual&&b.isFunction(c.isEqual))return c.isEqual(a);var e=l.call(a);if(e!=l.call(c))return false;switch(e){case "[object String]":return a==String(c);case "[object Number]":return a!=+a?c!=+c:a==0?1/a==1/c:a==+c;case "[object Date]":case "[object Boolean]":return+a==+c;case "[object RegExp]":return a.source==
|
||||||
|
c.source&&a.global==c.global&&a.multiline==c.multiline&&a.ignoreCase==c.ignoreCase}if(typeof a!="object"||typeof c!="object")return false;for(var f=d.length;f--;)if(d[f]==a)return true;d.push(a);var f=0,g=true;if(e=="[object Array]"){if(f=a.length,g=f==c.length)for(;f--;)if(!(g=f in a==f in c&&q(a[f],c[f],d)))break}else{if("constructor"in a!="constructor"in c||a.constructor!=c.constructor)return false;for(var h in a)if(b.has(a,h)&&(f++,!(g=b.has(c,h)&&q(a[h],c[h],d))))break;if(g){for(h in c)if(b.has(c,
|
||||||
|
h)&&!f--)break;g=!f}}d.pop();return g}var r=this,G=r._,n={},k=Array.prototype,o=Object.prototype,i=k.slice,H=k.unshift,l=o.toString,I=o.hasOwnProperty,w=k.forEach,x=k.map,y=k.reduce,z=k.reduceRight,A=k.filter,B=k.every,C=k.some,p=k.indexOf,D=k.lastIndexOf,o=Array.isArray,J=Object.keys,s=Function.prototype.bind,b=function(a){return new m(a)};if(typeof exports!=="undefined"){if(typeof module!=="undefined"&&module.exports)exports=module.exports=b;exports._=b}else r._=b;b.VERSION="1.3.1";var j=b.each=
|
||||||
|
b.forEach=function(a,c,d){if(a!=null)if(w&&a.forEach===w)a.forEach(c,d);else if(a.length===+a.length)for(var e=0,f=a.length;e<f;e++){if(e in a&&c.call(d,a[e],e,a)===n)break}else for(e in a)if(b.has(a,e)&&c.call(d,a[e],e,a)===n)break};b.map=b.collect=function(a,c,b){var e=[];if(a==null)return e;if(x&&a.map===x)return a.map(c,b);j(a,function(a,g,h){e[e.length]=c.call(b,a,g,h)});if(a.length===+a.length)e.length=a.length;return e};b.reduce=b.foldl=b.inject=function(a,c,d,e){var f=arguments.length>2;a==
|
||||||
|
null&&(a=[]);if(y&&a.reduce===y)return e&&(c=b.bind(c,e)),f?a.reduce(c,d):a.reduce(c);j(a,function(a,b,i){f?d=c.call(e,d,a,b,i):(d=a,f=true)});if(!f)throw new TypeError("Reduce of empty array with no initial value");return d};b.reduceRight=b.foldr=function(a,c,d,e){var f=arguments.length>2;a==null&&(a=[]);if(z&&a.reduceRight===z)return e&&(c=b.bind(c,e)),f?a.reduceRight(c,d):a.reduceRight(c);var g=b.toArray(a).reverse();e&&!f&&(c=b.bind(c,e));return f?b.reduce(g,c,d,e):b.reduce(g,c)};b.find=b.detect=
|
||||||
|
function(a,c,b){var e;E(a,function(a,g,h){if(c.call(b,a,g,h))return e=a,true});return e};b.filter=b.select=function(a,c,b){var e=[];if(a==null)return e;if(A&&a.filter===A)return a.filter(c,b);j(a,function(a,g,h){c.call(b,a,g,h)&&(e[e.length]=a)});return e};b.reject=function(a,c,b){var e=[];if(a==null)return e;j(a,function(a,g,h){c.call(b,a,g,h)||(e[e.length]=a)});return e};b.every=b.all=function(a,c,b){var e=true;if(a==null)return e;if(B&&a.every===B)return a.every(c,b);j(a,function(a,g,h){if(!(e=
|
||||||
|
e&&c.call(b,a,g,h)))return n});return e};var E=b.some=b.any=function(a,c,d){c||(c=b.identity);var e=false;if(a==null)return e;if(C&&a.some===C)return a.some(c,d);j(a,function(a,b,h){if(e||(e=c.call(d,a,b,h)))return n});return!!e};b.include=b.contains=function(a,c){var b=false;if(a==null)return b;return p&&a.indexOf===p?a.indexOf(c)!=-1:b=E(a,function(a){return a===c})};b.invoke=function(a,c){var d=i.call(arguments,2);return b.map(a,function(a){return(b.isFunction(c)?c||a:a[c]).apply(a,d)})};b.pluck=
|
||||||
|
function(a,c){return b.map(a,function(a){return a[c]})};b.max=function(a,c,d){if(!c&&b.isArray(a))return Math.max.apply(Math,a);if(!c&&b.isEmpty(a))return-Infinity;var e={computed:-Infinity};j(a,function(a,b,h){b=c?c.call(d,a,b,h):a;b>=e.computed&&(e={value:a,computed:b})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);if(!c&&b.isEmpty(a))return Infinity;var e={computed:Infinity};j(a,function(a,b,h){b=c?c.call(d,a,b,h):a;b<e.computed&&(e={value:a,computed:b})});
|
||||||
|
return e.value};b.shuffle=function(a){var b=[],d;j(a,function(a,f){f==0?b[0]=a:(d=Math.floor(Math.random()*(f+1)),b[f]=b[d],b[d]=a)});return b};b.sortBy=function(a,c,d){return b.pluck(b.map(a,function(a,b,g){return{value:a,criteria:c.call(d,a,b,g)}}).sort(function(a,b){var c=a.criteria,d=b.criteria;return c<d?-1:c>d?1:0}),"value")};b.groupBy=function(a,c){var d={},e=b.isFunction(c)?c:function(a){return a[c]};j(a,function(a,b){var c=e(a,b);(d[c]||(d[c]=[])).push(a)});return d};b.sortedIndex=function(a,
|
||||||
|
c,d){d||(d=b.identity);for(var e=0,f=a.length;e<f;){var g=e+f>>1;d(a[g])<d(c)?e=g+1:f=g}return e};b.toArray=function(a){return!a?[]:a.toArray?a.toArray():b.isArray(a)?i.call(a):b.isArguments(a)?i.call(a):b.values(a)};b.size=function(a){return b.toArray(a).length};b.first=b.head=function(a,b,d){return b!=null&&!d?i.call(a,0,b):a[0]};b.initial=function(a,b,d){return i.call(a,0,a.length-(b==null||d?1:b))};b.last=function(a,b,d){return b!=null&&!d?i.call(a,Math.max(a.length-b,0)):a[a.length-1]};b.rest=
|
||||||
|
b.tail=function(a,b,d){return i.call(a,b==null||d?1:b)};b.compact=function(a){return b.filter(a,function(a){return!!a})};b.flatten=function(a,c){return b.reduce(a,function(a,e){if(b.isArray(e))return a.concat(c?e:b.flatten(e));a[a.length]=e;return a},[])};b.without=function(a){return b.difference(a,i.call(arguments,1))};b.uniq=b.unique=function(a,c,d){var d=d?b.map(a,d):a,e=[];b.reduce(d,function(d,g,h){if(0==h||(c===true?b.last(d)!=g:!b.include(d,g)))d[d.length]=g,e[e.length]=a[h];return d},[]);
|
||||||
|
return e};b.union=function(){return b.uniq(b.flatten(arguments,true))};b.intersection=b.intersect=function(a){var c=i.call(arguments,1);return b.filter(b.uniq(a),function(a){return b.every(c,function(c){return b.indexOf(c,a)>=0})})};b.difference=function(a){var c=b.flatten(i.call(arguments,1));return b.filter(a,function(a){return!b.include(c,a)})};b.zip=function(){for(var a=i.call(arguments),c=b.max(b.pluck(a,"length")),d=Array(c),e=0;e<c;e++)d[e]=b.pluck(a,""+e);return d};b.indexOf=function(a,c,
|
||||||
|
d){if(a==null)return-1;var e;if(d)return d=b.sortedIndex(a,c),a[d]===c?d:-1;if(p&&a.indexOf===p)return a.indexOf(c);for(d=0,e=a.length;d<e;d++)if(d in a&&a[d]===c)return d;return-1};b.lastIndexOf=function(a,b){if(a==null)return-1;if(D&&a.lastIndexOf===D)return a.lastIndexOf(b);for(var d=a.length;d--;)if(d in a&&a[d]===b)return d;return-1};b.range=function(a,b,d){arguments.length<=1&&(b=a||0,a=0);for(var d=arguments[2]||1,e=Math.max(Math.ceil((b-a)/d),0),f=0,g=Array(e);f<e;)g[f++]=a,a+=d;return g};
|
||||||
|
var F=function(){};b.bind=function(a,c){var d,e;if(a.bind===s&&s)return s.apply(a,i.call(arguments,1));if(!b.isFunction(a))throw new TypeError;e=i.call(arguments,2);return d=function(){if(!(this instanceof d))return a.apply(c,e.concat(i.call(arguments)));F.prototype=a.prototype;var b=new F,g=a.apply(b,e.concat(i.call(arguments)));return Object(g)===g?g:b}};b.bindAll=function(a){var c=i.call(arguments,1);c.length==0&&(c=b.functions(a));j(c,function(c){a[c]=b.bind(a[c],a)});return a};b.memoize=function(a,
|
||||||
|
c){var d={};c||(c=b.identity);return function(){var e=c.apply(this,arguments);return b.has(d,e)?d[e]:d[e]=a.apply(this,arguments)}};b.delay=function(a,b){var d=i.call(arguments,2);return setTimeout(function(){return a.apply(a,d)},b)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(i.call(arguments,1)))};b.throttle=function(a,c){var d,e,f,g,h,i=b.debounce(function(){h=g=false},c);return function(){d=this;e=arguments;var b;f||(f=setTimeout(function(){f=null;h&&a.apply(d,e);i()},c));g?h=true:
|
||||||
|
a.apply(d,e);i();g=true}};b.debounce=function(a,b){var d;return function(){var e=this,f=arguments;clearTimeout(d);d=setTimeout(function(){d=null;a.apply(e,f)},b)}};b.once=function(a){var b=false,d;return function(){if(b)return d;b=true;return d=a.apply(this,arguments)}};b.wrap=function(a,b){return function(){var d=[a].concat(i.call(arguments,0));return b.apply(this,d)}};b.compose=function(){var a=arguments;return function(){for(var b=arguments,d=a.length-1;d>=0;d--)b=[a[d].apply(this,b)];return b[0]}};
|
||||||
|
b.after=function(a,b){return a<=0?b():function(){if(--a<1)return b.apply(this,arguments)}};b.keys=J||function(a){if(a!==Object(a))throw new TypeError("Invalid object");var c=[],d;for(d in a)b.has(a,d)&&(c[c.length]=d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=b.methods=function(a){var c=[],d;for(d in a)b.isFunction(a[d])&&c.push(d);return c.sort()};b.extend=function(a){j(i.call(arguments,1),function(b){for(var d in b)a[d]=b[d]});return a};b.defaults=function(a){j(i.call(arguments,
|
||||||
|
1),function(b){for(var d in b)a[d]==null&&(a[d]=b[d])});return a};b.clone=function(a){return!b.isObject(a)?a:b.isArray(a)?a.slice():b.extend({},a)};b.tap=function(a,b){b(a);return a};b.isEqual=function(a,b){return q(a,b,[])};b.isEmpty=function(a){if(b.isArray(a)||b.isString(a))return a.length===0;for(var c in a)if(b.has(a,c))return false;return true};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=o||function(a){return l.call(a)=="[object Array]"};b.isObject=function(a){return a===Object(a)};
|
||||||
|
b.isArguments=function(a){return l.call(a)=="[object Arguments]"};if(!b.isArguments(arguments))b.isArguments=function(a){return!(!a||!b.has(a,"callee"))};b.isFunction=function(a){return l.call(a)=="[object Function]"};b.isString=function(a){return l.call(a)=="[object String]"};b.isNumber=function(a){return l.call(a)=="[object Number]"};b.isNaN=function(a){return a!==a};b.isBoolean=function(a){return a===true||a===false||l.call(a)=="[object Boolean]"};b.isDate=function(a){return l.call(a)=="[object Date]"};
|
||||||
|
b.isRegExp=function(a){return l.call(a)=="[object RegExp]"};b.isNull=function(a){return a===null};b.isUndefined=function(a){return a===void 0};b.has=function(a,b){return I.call(a,b)};b.noConflict=function(){r._=G;return this};b.identity=function(a){return a};b.times=function(a,b,d){for(var e=0;e<a;e++)b.call(d,e)};b.escape=function(a){return(""+a).replace(/&/g,"&").replace(/</g,"<").replace(/>/g,">").replace(/"/g,""").replace(/'/g,"'").replace(/\//g,"/")};b.mixin=function(a){j(b.functions(a),
|
||||||
|
function(c){K(c,b[c]=a[c])})};var L=0;b.uniqueId=function(a){var b=L++;return a?a+b:b};b.templateSettings={evaluate:/<%([\s\S]+?)%>/g,interpolate:/<%=([\s\S]+?)%>/g,escape:/<%-([\s\S]+?)%>/g};var t=/.^/,u=function(a){return a.replace(/\\\\/g,"\\").replace(/\\'/g,"'")};b.template=function(a,c){var d=b.templateSettings,d="var __p=[],print=function(){__p.push.apply(__p,arguments);};with(obj||{}){__p.push('"+a.replace(/\\/g,"\\\\").replace(/'/g,"\\'").replace(d.escape||t,function(a,b){return"',_.escape("+
|
||||||
|
u(b)+"),'"}).replace(d.interpolate||t,function(a,b){return"',"+u(b)+",'"}).replace(d.evaluate||t,function(a,b){return"');"+u(b).replace(/[\r\n\t]/g," ")+";__p.push('"}).replace(/\r/g,"\\r").replace(/\n/g,"\\n").replace(/\t/g,"\\t")+"');}return __p.join('');",e=new Function("obj","_",d);return c?e(c,b):function(a){return e.call(this,a,b)}};b.chain=function(a){return b(a).chain()};var m=function(a){this._wrapped=a};b.prototype=m.prototype;var v=function(a,c){return c?b(a).chain():a},K=function(a,c){m.prototype[a]=
|
||||||
|
function(){var a=i.call(arguments);H.call(a,this._wrapped);return v(c.apply(b,a),this._chain)}};b.mixin(b);j("pop,push,reverse,shift,sort,splice,unshift".split(","),function(a){var b=k[a];m.prototype[a]=function(){var d=this._wrapped;b.apply(d,arguments);var e=d.length;(a=="shift"||a=="splice")&&e===0&&delete d[0];return v(d,this._chain)}});j(["concat","join","slice"],function(a){var b=k[a];m.prototype[a]=function(){return v(b.apply(this._wrapped,arguments),this._chain)}});m.prototype.chain=function(){this._chain=
|
||||||
|
true;return this};m.prototype.value=function(){return this._wrapped}}).call(this);
|
||||||
722
docs/build/html/genindex.html
vendored
Normal file
722
docs/build/html/genindex.html
vendored
Normal file
|
|
@ -0,0 +1,722 @@
|
||||||
|
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
<title>Index</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="_static/pygments.css">
|
||||||
|
<link rel="stylesheet" href="_static/theme.css">
|
||||||
|
<link rel="stylesheet" href="_static/sphinx_press_theme.css">
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
|
||||||
|
<!-- sphinx script_files -->
|
||||||
|
<script src="_static/jquery.js"></script>
|
||||||
|
<script src="_static/underscore.js"></script>
|
||||||
|
<script src="_static/doctools.js"></script>
|
||||||
|
<script src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="_static/theme-vendors.js"></script>
|
||||||
|
<script src="_static/theme.js" defer></script>
|
||||||
|
|
||||||
|
<link rel="index" title="Index" href="#" />
|
||||||
|
<link rel="search" title="Search" href="search.html" />
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
|
||||||
|
<router-link to="index.html" class="home-link">
|
||||||
|
|
||||||
|
<span class="site-name">CERC libs</span>
|
||||||
|
|
||||||
|
</router-link>
|
||||||
|
|
||||||
|
<div class="links">
|
||||||
|
<navlinks class="can-hide">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks>
|
||||||
|
</div>
|
||||||
|
</navbar>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="sidebar-mask" @click="toggleSidebar(false)">
|
||||||
|
</div>
|
||||||
|
<sidebar @toggle-sidebar="toggleSidebar">
|
||||||
|
|
||||||
|
<navlinks>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks><div id="searchbox" class="searchbox" role="search">
|
||||||
|
<div class="caption"><span class="caption-text">Quick search</span>
|
||||||
|
<div class="searchformwrapper">
|
||||||
|
<form class="search" action="search.html" method="get">
|
||||||
|
<input type="text" name="q" />
|
||||||
|
<input type="submit" value="Search" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
<div class="sidebar-group">
|
||||||
|
<p class="caption">
|
||||||
|
<span class="caption-text"><a href="index.html#welcome-to-cerc-libs-s-documentation">Contents:</a></span>
|
||||||
|
</p>
|
||||||
|
<ul class="">
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</sidebar>
|
||||||
|
|
||||||
|
<page>
|
||||||
|
<div class="body-header" role="navigation" aria-label="navigation">
|
||||||
|
|
||||||
|
<ul class="breadcrumbs">
|
||||||
|
<li><a href="index.html">Docs</a> »</li>
|
||||||
|
|
||||||
|
<li>Index</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<ul class="page-nav">
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr>
|
||||||
|
<div class="content" role="main">
|
||||||
|
|
||||||
|
|
||||||
|
<h1 id="index">Index</h1>
|
||||||
|
|
||||||
|
<div class="genindex-jumpbox">
|
||||||
|
<a href="#A"><strong>A</strong></a>
|
||||||
|
| <a href="#B"><strong>B</strong></a>
|
||||||
|
| <a href="#C"><strong>C</strong></a>
|
||||||
|
| <a href="#D"><strong>D</strong></a>
|
||||||
|
| <a href="#E"><strong>E</strong></a>
|
||||||
|
| <a href="#F"><strong>F</strong></a>
|
||||||
|
| <a href="#G"><strong>G</strong></a>
|
||||||
|
| <a href="#H"><strong>H</strong></a>
|
||||||
|
| <a href="#I"><strong>I</strong></a>
|
||||||
|
| <a href="#L"><strong>L</strong></a>
|
||||||
|
| <a href="#M"><strong>M</strong></a>
|
||||||
|
| <a href="#N"><strong>N</strong></a>
|
||||||
|
| <a href="#O"><strong>O</strong></a>
|
||||||
|
| <a href="#P"><strong>P</strong></a>
|
||||||
|
| <a href="#R"><strong>R</strong></a>
|
||||||
|
| <a href="#S"><strong>S</strong></a>
|
||||||
|
| <a href="#T"><strong>T</strong></a>
|
||||||
|
| <a href="#U"><strong>U</strong></a>
|
||||||
|
| <a href="#V"><strong>V</strong></a>
|
||||||
|
| <a href="#W"><strong>W</strong></a>
|
||||||
|
| <a href="#Y"><strong>Y</strong></a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<h2 id="A">A</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.city.City.add_city_object">add_city_object() (city_model_structure.city.City method)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.add_shared">add_shared() (city_model_structure.surface.Surface method)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_zone.ThermalZone.additional_thermal_bridge_u_value">additional_thermal_bridge_u_value() (city_model_structure.thermal_zone.ThermalZone property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.area">area() (city_model_structure.surface.Surface property)</a>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_boundary.ThermalBoundary.area">(city_model_structure.thermal_boundary.ThermalBoundary property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.area_above_ground">area_above_ground() (city_model_structure.surface.Surface property)</a>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_boundary.ThermalBoundary.area_above_ground">(city_model_structure.thermal_boundary.ThermalBoundary property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
</ul></td>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.area_below_ground">area_below_ground() (city_model_structure.surface.Surface property)</a>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_boundary.ThermalBoundary.area_below_ground">(city_model_structure.thermal_boundary.ThermalBoundary property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
<li><a href="index.html#city_model_structure.city_object.CityObject.attic_heated">attic_heated() (city_model_structure.city_object.CityObject property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.internal_gains.InternalGains.average_internal_gain">average_internal_gain() (city_model_structure.internal_gains.InternalGains property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.city_object.CityObject.average_storey_height">average_storey_height() (city_model_structure.city_object.CityObject property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.azimuth">azimuth() (city_model_structure.surface.Surface property)</a>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_boundary.ThermalBoundary.azimuth">(city_model_structure.thermal_boundary.ThermalBoundary property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
<h2 id="B">B</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_opening.ThermalOpening.back_side_solar_transmittance_at_normal_incidence">back_side_solar_transmittance_at_normal_incidence() (city_model_structure.thermal_opening.ThermalOpening property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.city_object.CityObject.basement_heated">basement_heated() (city_model_structure.city_object.CityObject property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_zone.ThermalZone.bounded">bounded() (city_model_structure.thermal_zone.ThermalZone property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
<h2 id="C">C</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.city.City">City (class in city_model_structure.city)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#geometry.geometry_factory.GeometryFactory.city">city() (geometry.geometry_factory.GeometryFactory property)</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
city_model_structure.city
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#module-city_model_structure.city">module</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
<li>
|
||||||
|
city_model_structure.city_object
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#module-city_model_structure.city_object">module</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
<li>
|
||||||
|
city_model_structure.internal_gains
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#module-city_model_structure.internal_gains">module</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
<li>
|
||||||
|
city_model_structure.layer
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#module-city_model_structure.layer">module</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
<li>
|
||||||
|
city_model_structure.material
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#module-city_model_structure.material">module</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
<li>
|
||||||
|
city_model_structure.polyhedron
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#module-city_model_structure.polyhedron">module</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
<li>
|
||||||
|
city_model_structure.surface
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#module-city_model_structure.surface">module</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
</ul></td>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li>
|
||||||
|
city_model_structure.thermal_boundary
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#module-city_model_structure.thermal_boundary">module</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
<li>
|
||||||
|
city_model_structure.thermal_opening
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#module-city_model_structure.thermal_opening">module</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
<li>
|
||||||
|
city_model_structure.thermal_zone
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#module-city_model_structure.thermal_zone">module</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
<li>
|
||||||
|
city_model_structure.usage_zone
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#module-city_model_structure.usage_zone">module</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
<li><a href="index.html#city_model_structure.city.City.city_object">city_object() (city_model_structure.city.City method)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.city.City.city_objects">city_objects() (city_model_structure.city.City property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.city_object.CityObject">CityObject (class in city_model_structure.city_object)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.material.Material.conductivity">conductivity() (city_model_structure.material.Material property)</a>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_opening.ThermalOpening.conductivity">(city_model_structure.thermal_opening.ThermalOpening property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
<li><a href="index.html#city_model_structure.internal_gains.InternalGains.convective_fraction">convective_fraction() (city_model_structure.internal_gains.InternalGains property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_zone.ThermalZone.cooled">cooled() (city_model_structure.thermal_zone.ThermalZone property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.usage_zone.UsageZone.cooling_setpoint">cooling_setpoint() (city_model_structure.usage_zone.UsageZone property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.city.City.country_code">country_code() (city_model_structure.city.City property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
<h2 id="D">D</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.usage_zone.UsageZone.days_year">days_year() (city_model_structure.usage_zone.UsageZone property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_boundary.ThermalBoundary.delimits">delimits() (city_model_structure.thermal_boundary.ThermalBoundary property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.material.Material.density">density() (city_model_structure.material.Material property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
<h2 id="E">E</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_zone.ThermalZone.effective_thermal_capacity">effective_thermal_capacity() (city_model_structure.thermal_zone.ThermalZone property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
<h2 id="F">F</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.polyhedron.Polyhedron.faces">faces() (city_model_structure.polyhedron.Polyhedron property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#physics.physics_factory.PhysicsFactory.factory">factory() (physics.physics_factory.PhysicsFactory method)</a>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#usage.usage_factory.UsageFactory.factory">(usage.usage_factory.UsageFactory method)</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_zone.ThermalZone.floor_area">floor_area() (city_model_structure.thermal_zone.ThermalZone property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.city_object.CityObject.foot_print">foot_print() (city_model_structure.city_object.CityObject property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_opening.ThermalOpening.frame_ratio">frame_ratio() (city_model_structure.thermal_opening.ThermalOpening property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_opening.ThermalOpening.front_side_solar_transmittance_at_normal_incidence">front_side_solar_transmittance_at_normal_incidence() (city_model_structure.thermal_opening.ThermalOpening property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.city_object.CityObject.function">function() (city_model_structure.city_object.CityObject property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
<h2 id="G">G</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_opening.ThermalOpening.g_value">g_value() (city_model_structure.thermal_opening.ThermalOpening property)</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
geometry.geometry_factory
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#module-geometry.geometry_factory">module</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
<li><a href="index.html#geometry.geometry_factory.GeometryFactory">GeometryFactory (class in geometry.geometry_factory)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.global_irradiance_hour">global_irradiance_hour() (city_model_structure.surface.Surface property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.global_irradiance_month">global_irradiance_month() (city_model_structure.surface.Surface property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.ground_points">ground_points() (city_model_structure.surface.Surface property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.ground_polygon">ground_polygon() (city_model_structure.surface.Surface property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
<h2 id="H">H</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_zone.ThermalZone.heated">heated() (city_model_structure.thermal_zone.ThermalZone property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.city_object.CityObject.heated_volume">heated_volume() (city_model_structure.city_object.CityObject property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.usage_zone.UsageZone.heating_setback">heating_setback() (city_model_structure.usage_zone.UsageZone property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.usage_zone.UsageZone.heating_setpoint">heating_setpoint() (city_model_structure.usage_zone.UsageZone property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.usage_zone.UsageZone.hours_day">hours_day() (city_model_structure.usage_zone.UsageZone property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
<h2 id="I">I</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.inclination">inclination() (city_model_structure.surface.Surface property)</a>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_boundary.ThermalBoundary.inclination">(city_model_structure.thermal_boundary.ThermalBoundary property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_zone.ThermalZone.indirectly_heated_area_ratio">indirectly_heated_area_ratio() (city_model_structure.thermal_zone.ThermalZone property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_zone.ThermalZone.infiltration_rate_system_off">infiltration_rate_system_off() (city_model_structure.thermal_zone.ThermalZone property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_zone.ThermalZone.infiltration_rate_system_on">infiltration_rate_system_on() (city_model_structure.thermal_zone.ThermalZone property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.usage_zone.UsageZone.internal_gains">internal_gains() (city_model_structure.usage_zone.UsageZone property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.internal_gains.InternalGains">InternalGains (class in city_model_structure.internal_gains)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.intersect">intersect() (city_model_structure.surface.Surface method)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
<h2 id="L">L</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.internal_gains.InternalGains.latent_fraction">latent_fraction() (city_model_structure.internal_gains.InternalGains property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.layer.Layer">Layer (class in city_model_structure.layer)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_boundary.ThermalBoundary.layers">layers() (city_model_structure.thermal_boundary.ThermalBoundary property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.city_object.CityObject.lod">lod() (city_model_structure.city_object.CityObject property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.city.City.lower_corner">lower_corner() (city_model_structure.city.City property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
<h2 id="M">M</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.material.Material">Material (class in city_model_structure.material)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.layer.Layer.material">material() (city_model_structure.layer.Layer property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.city_object.CityObject.max_height">max_height() (city_model_structure.city_object.CityObject property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.polyhedron.Polyhedron.max_z">max_z() (city_model_structure.polyhedron.Polyhedron property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.usage_zone.UsageZone.mechanical_air_change">mechanical_air_change() (city_model_structure.usage_zone.UsageZone property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.min_x">min_x() (city_model_structure.surface.Surface property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.min_y">min_y() (city_model_structure.surface.Surface property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.min_z">min_z() (city_model_structure.surface.Surface property)</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
module
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#module-city_model_structure.city">city_model_structure.city</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#module-city_model_structure.city_object">city_model_structure.city_object</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#module-city_model_structure.internal_gains">city_model_structure.internal_gains</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#module-city_model_structure.layer">city_model_structure.layer</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#module-city_model_structure.material">city_model_structure.material</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#module-city_model_structure.polyhedron">city_model_structure.polyhedron</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#module-city_model_structure.surface">city_model_structure.surface</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#module-city_model_structure.thermal_boundary">city_model_structure.thermal_boundary</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#module-city_model_structure.thermal_opening">city_model_structure.thermal_opening</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#module-city_model_structure.thermal_zone">city_model_structure.thermal_zone</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#module-city_model_structure.usage_zone">city_model_structure.usage_zone</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#module-geometry.geometry_factory">geometry.geometry_factory</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#module-physics.physics_factory">physics.physics_factory</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#module-usage.usage_factory">usage.usage_factory</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
<h2 id="N">N</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.city.City.name">name() (city_model_structure.city.City property)</a>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#city_model_structure.city_object.CityObject.name">(city_model_structure.city_object.CityObject property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.name">(city_model_structure.surface.Surface property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
</ul></td>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.material.Material.no_mass">no_mass() (city_model_structure.material.Material property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.normal">normal() (city_model_structure.surface.Surface property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
<h2 id="O">O</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_opening.ThermalOpening.openable_ratio">openable_ratio() (city_model_structure.thermal_opening.ThermalOpening property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_boundary.ThermalBoundary.outside_solar_absorptance">outside_solar_absorptance() (city_model_structure.thermal_boundary.ThermalBoundary property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_boundary.ThermalBoundary.outside_thermal_absorptance">outside_thermal_absorptance() (city_model_structure.thermal_boundary.ThermalBoundary property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_boundary.ThermalBoundary.outside_visible_absorptance">outside_visible_absorptance() (city_model_structure.thermal_boundary.ThermalBoundary property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_opening.ThermalOpening.overall_u_value">overall_u_value() (city_model_structure.thermal_opening.ThermalOpening property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
<h2 id="P">P</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.parent">parent() (city_model_structure.surface.Surface method)</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
physics.physics_factory
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#module-physics.physics_factory">module</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
<li><a href="index.html#physics.physics_factory.PhysicsFactory">PhysicsFactory (class in physics.physics_factory)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.points">points() (city_model_structure.surface.Surface property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.points_list">points_list() (city_model_structure.surface.Surface property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.polygon">polygon() (city_model_structure.surface.Surface property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.polyhedron.Polyhedron">Polyhedron (class in city_model_structure.polyhedron)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.projection">projection() (city_model_structure.surface.Surface property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
<h2 id="R">R</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.internal_gains.InternalGains.radiative_fraction">radiative_fraction() (city_model_structure.internal_gains.InternalGains property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
<h2 id="S">S</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.polyhedron.Polyhedron.save">save() (city_model_structure.polyhedron.Polyhedron method)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.shapely">shapely() (city_model_structure.surface.Surface property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.shared">shared() (city_model_structure.surface.Surface method)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_boundary.ThermalBoundary.shortwave_reflectance">shortwave_reflectance() (city_model_structure.thermal_boundary.ThermalBoundary property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.material.Material.solar_absorptance">solar_absorptance() (city_model_structure.material.Material property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.material.Material.specific_heat">specific_heat() (city_model_structure.material.Material property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.city.City.srs_name">srs_name() (city_model_structure.city.City property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.city_object.CityObject.stl_export">stl_export() (city_model_structure.city_object.CityObject method)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.city_object.CityObject.storeys_above_ground">storeys_above_ground() (city_model_structure.city_object.CityObject property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface">Surface (class in city_model_structure.surface)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.city_object.CityObject.surface">surface() (city_model_structure.city_object.CityObject method)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.city_object.CityObject.surfaces">surfaces() (city_model_structure.city_object.CityObject property)</a>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_zone.ThermalZone.surfaces">(city_model_structure.thermal_zone.ThermalZone property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.swr">swr() (city_model_structure.surface.Surface property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
<h2 id="T">T</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.city_object.CityObject.terrains">terrains() (city_model_structure.city_object.CityObject property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.material.Material.thermal_absorptance">thermal_absorptance() (city_model_structure.material.Material property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_boundary.ThermalBoundary.thermal_openings">thermal_openings() (city_model_structure.thermal_boundary.ThermalBoundary property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.material.Material.thermal_resistance">thermal_resistance() (city_model_structure.material.Material property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.city_object.CityObject.thermal_zones">thermal_zones() (city_model_structure.city_object.CityObject property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_boundary.ThermalBoundary">ThermalBoundary (class in city_model_structure.thermal_boundary)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_opening.ThermalOpening">ThermalOpening (class in city_model_structure.thermal_opening)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_zone.ThermalZone">ThermalZone (class in city_model_structure.thermal_zone)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.layer.Layer.thickness">thickness() (city_model_structure.layer.Layer property)</a>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_opening.ThermalOpening.thickness">(city_model_structure.thermal_opening.ThermalOpening property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
<li><a href="index.html#city_model_structure.city_object.CityObject.type">type() (city_model_structure.city_object.CityObject property)</a>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#city_model_structure.surface.Surface.type">(city_model_structure.surface.Surface property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_boundary.ThermalBoundary.type">(city_model_structure.thermal_boundary.ThermalBoundary property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
<h2 id="U">U</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_boundary.ThermalBoundary.u_value">u_value() (city_model_structure.thermal_boundary.ThermalBoundary property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.city.City.upper_corner">upper_corner() (city_model_structure.city.City property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.usage_zone.UsageZone.usage">usage() (city_model_structure.usage_zone.UsageZone property)</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
usage.usage_factory
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#module-usage.usage_factory">module</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
</ul></td>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.city_object.CityObject.usage_zones">usage_zones() (city_model_structure.city_object.CityObject property)</a>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_zone.ThermalZone.usage_zones">(city_model_structure.thermal_zone.ThermalZone property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
<li><a href="index.html#usage.usage_factory.UsageFactory">UsageFactory (class in usage.usage_factory)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.usage_zone.UsageZone">UsageZone (class in city_model_structure.usage_zone)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
<h2 id="V">V</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.polyhedron.Polyhedron.vertices">vertices() (city_model_structure.polyhedron.Polyhedron property)</a>
|
||||||
|
</li>
|
||||||
|
<li><a href="index.html#city_model_structure.material.Material.visible_absorptance">visible_absorptance() (city_model_structure.material.Material property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.city_object.CityObject.volume">volume() (city_model_structure.city_object.CityObject property)</a>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li><a href="index.html#city_model_structure.polyhedron.Polyhedron.volume">(city_model_structure.polyhedron.Polyhedron property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
<h2 id="W">W</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_boundary.ThermalBoundary.window_area">window_area() (city_model_structure.thermal_boundary.ThermalBoundary property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.thermal_boundary.ThermalBoundary.window_ratio">window_ratio() (city_model_structure.thermal_boundary.ThermalBoundary property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
<h2 id="Y">Y</h2>
|
||||||
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||||
|
<td style="width: 33%; vertical-align: top;"><ul>
|
||||||
|
<li><a href="index.html#city_model_structure.city_object.CityObject.year_of_construction">year_of_construction() (city_model_structure.city_object.CityObject property)</a>
|
||||||
|
</li>
|
||||||
|
</ul></td>
|
||||||
|
</tr></table>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="page-nav">
|
||||||
|
<div class="inner"><ul class="page-nav">
|
||||||
|
</ul><div class="footer" role="contentinfo">
|
||||||
|
© Copyright 2020, Guillermo Gutierrez.
|
||||||
|
<br>
|
||||||
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</page>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
1141
docs/build/html/index.html
vendored
Normal file
1141
docs/build/html/index.html
vendored
Normal file
File diff suppressed because it is too large
Load Diff
BIN
docs/build/html/objects.inv
vendored
Normal file
BIN
docs/build/html/objects.inv
vendored
Normal file
Binary file not shown.
236
docs/build/html/py-modindex.html
vendored
Normal file
236
docs/build/html/py-modindex.html
vendored
Normal file
|
|
@ -0,0 +1,236 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
<title>Python Module Index</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="_static/pygments.css">
|
||||||
|
<link rel="stylesheet" href="_static/theme.css">
|
||||||
|
<link rel="stylesheet" href="_static/sphinx_press_theme.css">
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
|
||||||
|
<!-- sphinx script_files -->
|
||||||
|
<script src="_static/jquery.js"></script>
|
||||||
|
<script src="_static/underscore.js"></script>
|
||||||
|
<script src="_static/doctools.js"></script>
|
||||||
|
<script src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="_static/theme-vendors.js"></script>
|
||||||
|
<script src="_static/theme.js" defer></script>
|
||||||
|
|
||||||
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="search.html" />
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
|
||||||
|
<router-link to="index.html" class="home-link">
|
||||||
|
|
||||||
|
<span class="site-name">CERC libs</span>
|
||||||
|
|
||||||
|
</router-link>
|
||||||
|
|
||||||
|
<div class="links">
|
||||||
|
<navlinks class="can-hide">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks>
|
||||||
|
</div>
|
||||||
|
</navbar>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="sidebar-mask" @click="toggleSidebar(false)">
|
||||||
|
</div>
|
||||||
|
<sidebar @toggle-sidebar="toggleSidebar">
|
||||||
|
|
||||||
|
<navlinks>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks><div id="searchbox" class="searchbox" role="search">
|
||||||
|
<div class="caption"><span class="caption-text">Quick search</span>
|
||||||
|
<div class="searchformwrapper">
|
||||||
|
<form class="search" action="search.html" method="get">
|
||||||
|
<input type="text" name="q" />
|
||||||
|
<input type="submit" value="Search" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
<div class="sidebar-group">
|
||||||
|
<p class="caption">
|
||||||
|
<span class="caption-text"><a href="index.html#welcome-to-cerc-libs-s-documentation">Contents:</a></span>
|
||||||
|
</p>
|
||||||
|
<ul class="">
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</sidebar>
|
||||||
|
|
||||||
|
<page>
|
||||||
|
<div class="body-header" role="navigation" aria-label="navigation">
|
||||||
|
|
||||||
|
<ul class="breadcrumbs">
|
||||||
|
<li><a href="index.html">Docs</a> »</li>
|
||||||
|
|
||||||
|
<li>Python Module Index</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<ul class="page-nav">
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr>
|
||||||
|
<div class="content" role="main">
|
||||||
|
|
||||||
|
|
||||||
|
<h1>Python Module Index</h1>
|
||||||
|
|
||||||
|
<div class="modindex-jumpbox">
|
||||||
|
<a href="#cap-c"><strong>c</strong></a> |
|
||||||
|
<a href="#cap-g"><strong>g</strong></a> |
|
||||||
|
<a href="#cap-p"><strong>p</strong></a> |
|
||||||
|
<a href="#cap-u"><strong>u</strong></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<table class="indextable modindextable">
|
||||||
|
<tr class="pcap"><td></td><td> </td><td></td></tr>
|
||||||
|
<tr class="cap" id="cap-c"><td></td><td>
|
||||||
|
<strong>c</strong></td><td></td></tr>
|
||||||
|
<tr>
|
||||||
|
<td><img src="_static/minus.png" class="toggler"
|
||||||
|
id="toggle-1" style="display: none" alt="-" /></td>
|
||||||
|
<td>
|
||||||
|
<code class="xref">city_model_structure</code></td><td>
|
||||||
|
<em></em></td></tr>
|
||||||
|
<tr class="cg-1">
|
||||||
|
<td></td>
|
||||||
|
<td>   
|
||||||
|
<a href="index.html#module-city_model_structure.city"><code class="xref">city_model_structure.city</code></a></td><td>
|
||||||
|
<em></em></td></tr>
|
||||||
|
<tr class="cg-1">
|
||||||
|
<td></td>
|
||||||
|
<td>   
|
||||||
|
<a href="index.html#module-city_model_structure.city_object"><code class="xref">city_model_structure.city_object</code></a></td><td>
|
||||||
|
<em></em></td></tr>
|
||||||
|
<tr class="cg-1">
|
||||||
|
<td></td>
|
||||||
|
<td>   
|
||||||
|
<a href="index.html#module-city_model_structure.internal_gains"><code class="xref">city_model_structure.internal_gains</code></a></td><td>
|
||||||
|
<em></em></td></tr>
|
||||||
|
<tr class="cg-1">
|
||||||
|
<td></td>
|
||||||
|
<td>   
|
||||||
|
<a href="index.html#module-city_model_structure.layer"><code class="xref">city_model_structure.layer</code></a></td><td>
|
||||||
|
<em></em></td></tr>
|
||||||
|
<tr class="cg-1">
|
||||||
|
<td></td>
|
||||||
|
<td>   
|
||||||
|
<a href="index.html#module-city_model_structure.material"><code class="xref">city_model_structure.material</code></a></td><td>
|
||||||
|
<em></em></td></tr>
|
||||||
|
<tr class="cg-1">
|
||||||
|
<td></td>
|
||||||
|
<td>   
|
||||||
|
<a href="index.html#module-city_model_structure.polyhedron"><code class="xref">city_model_structure.polyhedron</code></a></td><td>
|
||||||
|
<em></em></td></tr>
|
||||||
|
<tr class="cg-1">
|
||||||
|
<td></td>
|
||||||
|
<td>   
|
||||||
|
<a href="index.html#module-city_model_structure.surface"><code class="xref">city_model_structure.surface</code></a></td><td>
|
||||||
|
<em></em></td></tr>
|
||||||
|
<tr class="cg-1">
|
||||||
|
<td></td>
|
||||||
|
<td>   
|
||||||
|
<a href="index.html#module-city_model_structure.thermal_boundary"><code class="xref">city_model_structure.thermal_boundary</code></a></td><td>
|
||||||
|
<em></em></td></tr>
|
||||||
|
<tr class="cg-1">
|
||||||
|
<td></td>
|
||||||
|
<td>   
|
||||||
|
<a href="index.html#module-city_model_structure.thermal_opening"><code class="xref">city_model_structure.thermal_opening</code></a></td><td>
|
||||||
|
<em></em></td></tr>
|
||||||
|
<tr class="cg-1">
|
||||||
|
<td></td>
|
||||||
|
<td>   
|
||||||
|
<a href="index.html#module-city_model_structure.thermal_zone"><code class="xref">city_model_structure.thermal_zone</code></a></td><td>
|
||||||
|
<em></em></td></tr>
|
||||||
|
<tr class="cg-1">
|
||||||
|
<td></td>
|
||||||
|
<td>   
|
||||||
|
<a href="index.html#module-city_model_structure.usage_zone"><code class="xref">city_model_structure.usage_zone</code></a></td><td>
|
||||||
|
<em></em></td></tr>
|
||||||
|
<tr class="pcap"><td></td><td> </td><td></td></tr>
|
||||||
|
<tr class="cap" id="cap-g"><td></td><td>
|
||||||
|
<strong>g</strong></td><td></td></tr>
|
||||||
|
<tr>
|
||||||
|
<td><img src="_static/minus.png" class="toggler"
|
||||||
|
id="toggle-2" style="display: none" alt="-" /></td>
|
||||||
|
<td>
|
||||||
|
<code class="xref">geometry</code></td><td>
|
||||||
|
<em></em></td></tr>
|
||||||
|
<tr class="cg-2">
|
||||||
|
<td></td>
|
||||||
|
<td>   
|
||||||
|
<a href="index.html#module-geometry.geometry_factory"><code class="xref">geometry.geometry_factory</code></a></td><td>
|
||||||
|
<em></em></td></tr>
|
||||||
|
<tr class="pcap"><td></td><td> </td><td></td></tr>
|
||||||
|
<tr class="cap" id="cap-p"><td></td><td>
|
||||||
|
<strong>p</strong></td><td></td></tr>
|
||||||
|
<tr>
|
||||||
|
<td><img src="_static/minus.png" class="toggler"
|
||||||
|
id="toggle-3" style="display: none" alt="-" /></td>
|
||||||
|
<td>
|
||||||
|
<code class="xref">physics</code></td><td>
|
||||||
|
<em></em></td></tr>
|
||||||
|
<tr class="cg-3">
|
||||||
|
<td></td>
|
||||||
|
<td>   
|
||||||
|
<a href="index.html#module-physics.physics_factory"><code class="xref">physics.physics_factory</code></a></td><td>
|
||||||
|
<em></em></td></tr>
|
||||||
|
<tr class="pcap"><td></td><td> </td><td></td></tr>
|
||||||
|
<tr class="cap" id="cap-u"><td></td><td>
|
||||||
|
<strong>u</strong></td><td></td></tr>
|
||||||
|
<tr>
|
||||||
|
<td><img src="_static/minus.png" class="toggler"
|
||||||
|
id="toggle-4" style="display: none" alt="-" /></td>
|
||||||
|
<td>
|
||||||
|
<code class="xref">usage</code></td><td>
|
||||||
|
<em></em></td></tr>
|
||||||
|
<tr class="cg-4">
|
||||||
|
<td></td>
|
||||||
|
<td>   
|
||||||
|
<a href="index.html#module-usage.usage_factory"><code class="xref">usage.usage_factory</code></a></td><td>
|
||||||
|
<em></em></td></tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="page-nav">
|
||||||
|
<div class="inner"><ul class="page-nav">
|
||||||
|
</ul><div class="footer" role="contentinfo">
|
||||||
|
© Copyright 2020, Guillermo Gutierrez.
|
||||||
|
<br>
|
||||||
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</page>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
144
docs/build/html/search.html
vendored
Normal file
144
docs/build/html/search.html
vendored
Normal file
|
|
@ -0,0 +1,144 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html >
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||||
|
<title>Search</title>
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="_static/pygments.css">
|
||||||
|
<link rel="stylesheet" href="_static/theme.css">
|
||||||
|
<link rel="stylesheet" href="_static/sphinx_press_theme.css">
|
||||||
|
|
||||||
|
|
||||||
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||||
|
|
||||||
|
<!-- sphinx script_files -->
|
||||||
|
<script src="_static/jquery.js"></script>
|
||||||
|
<script src="_static/underscore.js"></script>
|
||||||
|
<script src="_static/doctools.js"></script>
|
||||||
|
<script src="_static/language_data.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="_static/theme-vendors.js"></script>
|
||||||
|
<script src="_static/theme.js" defer></script>
|
||||||
|
<script type="text/javascript" src="_static/searchtools.js"></script>
|
||||||
|
|
||||||
|
<link rel="index" title="Index" href="genindex.html" />
|
||||||
|
<link rel="search" title="Search" href="#" />
|
||||||
|
<script type="text/javascript" src="searchindex.js" defer></script>
|
||||||
|
|
||||||
|
<script type="text/javascript" id="searchindexloader"></script>
|
||||||
|
|
||||||
|
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
|
||||||
|
<router-link to="index.html" class="home-link">
|
||||||
|
|
||||||
|
<span class="site-name">CERC libs</span>
|
||||||
|
|
||||||
|
</router-link>
|
||||||
|
|
||||||
|
<div class="links">
|
||||||
|
<navlinks class="can-hide">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks>
|
||||||
|
</div>
|
||||||
|
</navbar>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="sidebar-mask" @click="toggleSidebar(false)">
|
||||||
|
</div>
|
||||||
|
<sidebar @toggle-sidebar="toggleSidebar">
|
||||||
|
|
||||||
|
<navlinks>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</navlinks><div id="searchbox" class="searchbox" role="search">
|
||||||
|
<div class="caption"><span class="caption-text">Quick search</span>
|
||||||
|
<div class="searchformwrapper">
|
||||||
|
<form class="search" action="#" method="get">
|
||||||
|
<input type="text" name="q" />
|
||||||
|
<input type="submit" value="Search" />
|
||||||
|
<input type="hidden" name="check_keywords" value="yes" />
|
||||||
|
<input type="hidden" name="area" value="default" />
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
|
||||||
|
|
||||||
|
<div class="sidebar-group">
|
||||||
|
<p class="caption">
|
||||||
|
<span class="caption-text"><a href="index.html#welcome-to-cerc-libs-s-documentation">Contents:</a></span>
|
||||||
|
</p>
|
||||||
|
<ul class="">
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</sidebar>
|
||||||
|
|
||||||
|
<page>
|
||||||
|
<div class="body-header" role="navigation" aria-label="navigation">
|
||||||
|
|
||||||
|
<ul class="breadcrumbs">
|
||||||
|
<li><a href="index.html">Docs</a> »</li>
|
||||||
|
|
||||||
|
<li>Search</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<ul class="page-nav">
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr>
|
||||||
|
<div class="content" role="main">
|
||||||
|
|
||||||
|
<h1 id="search-documentation">Search</h1>
|
||||||
|
<div id="fallback" class="admonition warning">
|
||||||
|
<script type="text/javascript">$('#fallback').hide();</script>
|
||||||
|
<p>
|
||||||
|
Please activate JavaScript to enable the search
|
||||||
|
functionality.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<p>
|
||||||
|
From here you can search these documents. Enter your search
|
||||||
|
words into the box below and click "search". Note that the search
|
||||||
|
function will automatically search for all of the words. Pages
|
||||||
|
containing fewer words won't appear in the result list.
|
||||||
|
</p>
|
||||||
|
<form action="" method="get">
|
||||||
|
<input type="text" name="q" value="" />
|
||||||
|
<input type="submit" value="search" />
|
||||||
|
<span id="search-progress" style="padding-left: 10px"></span>
|
||||||
|
</form>
|
||||||
|
|
||||||
|
<div id="search-results">
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div class="page-nav">
|
||||||
|
<div class="inner"><ul class="page-nav">
|
||||||
|
</ul><div class="footer" role="contentinfo">
|
||||||
|
© Copyright 2020, Guillermo Gutierrez.
|
||||||
|
<br>
|
||||||
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</page>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
1
docs/build/html/searchindex.js
vendored
Normal file
1
docs/build/html/searchindex.js
vendored
Normal file
File diff suppressed because one or more lines are too long
35
docs/make.bat
Normal file
35
docs/make.bat
Normal file
|
|
@ -0,0 +1,35 @@
|
||||||
|
@ECHO OFF
|
||||||
|
|
||||||
|
pushd %~dp0
|
||||||
|
|
||||||
|
REM Command file for Sphinx documentation
|
||||||
|
|
||||||
|
if "%SPHINXBUILD%" == "" (
|
||||||
|
set SPHINXBUILD=sphinx-build
|
||||||
|
)
|
||||||
|
set SOURCEDIR=source
|
||||||
|
set BUILDDIR=build
|
||||||
|
|
||||||
|
if "%1" == "" goto help
|
||||||
|
|
||||||
|
%SPHINXBUILD% >NUL 2>NUL
|
||||||
|
if errorlevel 9009 (
|
||||||
|
echo.
|
||||||
|
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||||
|
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||||
|
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||||
|
echo.may add the Sphinx directory to PATH.
|
||||||
|
echo.
|
||||||
|
echo.If you don't have Sphinx installed, grab it from
|
||||||
|
echo.http://sphinx-doc.org/
|
||||||
|
exit /b 1
|
||||||
|
)
|
||||||
|
|
||||||
|
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
|
||||||
|
goto end
|
||||||
|
|
||||||
|
:help
|
||||||
|
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
|
||||||
|
|
||||||
|
:end
|
||||||
|
popd
|
||||||
193
docs/source/conf.py
Normal file
193
docs/source/conf.py
Normal file
|
|
@ -0,0 +1,193 @@
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
#
|
||||||
|
# Configuration file for the Sphinx documentation builder.
|
||||||
|
#
|
||||||
|
# This file does only contain a selection of the most common options. For a
|
||||||
|
# full list see the documentation:
|
||||||
|
# http://www.sphinx-doc.org/en/master/config
|
||||||
|
|
||||||
|
# -- Path setup --------------------------------------------------------------
|
||||||
|
|
||||||
|
# If extensions (or modules to document with autodoc) are in another directory,
|
||||||
|
# add these directories to sys.path here. If the directory is relative to the
|
||||||
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||||
|
#
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
sys.path.insert(0, os.path.abspath('/home/daimon/Projects/MonthlyEnergyBalance/venv/lib/python3.7/site-packages'))
|
||||||
|
sys.path.insert(0, os.path.abspath('../..'))
|
||||||
|
|
||||||
|
sys.setrecursionlimit(1500)
|
||||||
|
|
||||||
|
|
||||||
|
# -- Project information -----------------------------------------------------
|
||||||
|
|
||||||
|
project = 'CERC libs'
|
||||||
|
copyright = '2020, Guillermo Gutierrez'
|
||||||
|
author = 'Guillermo Gutierrez'
|
||||||
|
|
||||||
|
# The short X.Y version
|
||||||
|
version = ''
|
||||||
|
# The full version, including alpha/beta/rc tags
|
||||||
|
release = '0.0.1'
|
||||||
|
|
||||||
|
|
||||||
|
# -- General configuration ---------------------------------------------------
|
||||||
|
|
||||||
|
# If your documentation needs a minimal Sphinx version, state it here.
|
||||||
|
#
|
||||||
|
# needs_sphinx = '1.0'
|
||||||
|
|
||||||
|
# Add any Sphinx extension module names here, as strings. They can be
|
||||||
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||||
|
# ones.
|
||||||
|
extensions = [
|
||||||
|
'sphinx.ext.autodoc',
|
||||||
|
'sphinx.ext.doctest',
|
||||||
|
'sphinx.ext.todo',
|
||||||
|
'sphinx.ext.ifconfig',
|
||||||
|
'sphinx.ext.viewcode',
|
||||||
|
'sphinx.ext.githubpages',
|
||||||
|
'rinoh.frontend.sphinx',
|
||||||
|
'sphinx.ext.autosectionlabel',
|
||||||
|
'recommonmark'
|
||||||
|
]
|
||||||
|
|
||||||
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
|
templates_path = ['_templates']
|
||||||
|
|
||||||
|
# The suffix(es) of source filenames.
|
||||||
|
# You can specify multiple suffix as a list of string:
|
||||||
|
#
|
||||||
|
# source_suffix = ['.rst', '.md']
|
||||||
|
source_suffix = '.rst'
|
||||||
|
|
||||||
|
# The master toctree document.
|
||||||
|
master_doc = 'index'
|
||||||
|
|
||||||
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
|
# for a list of supported languages.
|
||||||
|
#
|
||||||
|
# This is also used if you do content translation via gettext catalogs.
|
||||||
|
# Usually you set "language" from the command line for these cases.
|
||||||
|
language = None
|
||||||
|
|
||||||
|
# List of patterns, relative to source directory, that match files and
|
||||||
|
# directories to ignore when looking for source files.
|
||||||
|
# This pattern also affects html_static_path and html_extra_path.
|
||||||
|
exclude_patterns = []
|
||||||
|
|
||||||
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
|
pygments_style = None
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for HTML output -------------------------------------------------
|
||||||
|
|
||||||
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
|
# a list of builtin themes.
|
||||||
|
#
|
||||||
|
html_theme = 'press'
|
||||||
|
|
||||||
|
# Theme options are theme-specific and customize the look and feel of a theme
|
||||||
|
# further. For a list of options available for each theme, see the
|
||||||
|
# documentation.
|
||||||
|
#
|
||||||
|
# html_theme_options = {}
|
||||||
|
|
||||||
|
# Add any paths that contain custom static files (such as style sheets) here,
|
||||||
|
# relative to this directory. They are copied after the builtin static files,
|
||||||
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||||
|
html_static_path = ['_static']
|
||||||
|
|
||||||
|
# Custom sidebar templates, must be a dictionary that maps document names
|
||||||
|
# to template names.
|
||||||
|
#
|
||||||
|
# The default sidebars (for documents that don't match any pattern) are
|
||||||
|
# defined by theme itself. Builtin themes are using these templates by
|
||||||
|
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
|
||||||
|
# 'searchbox.html']``.
|
||||||
|
#
|
||||||
|
# html_sidebars = {}
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for HTMLHelp output ---------------------------------------------
|
||||||
|
|
||||||
|
# Output file base name for HTML help builder.
|
||||||
|
htmlhelp_basename = 'CERClibsdoc'
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for LaTeX output ------------------------------------------------
|
||||||
|
|
||||||
|
latex_elements = {
|
||||||
|
# The paper size ('letterpaper' or 'a4paper').
|
||||||
|
|
||||||
|
'papersize': 'letterpaper',
|
||||||
|
|
||||||
|
# The font size ('10pt', '11pt' or '12pt').
|
||||||
|
|
||||||
|
'pointsize': '10pt',
|
||||||
|
|
||||||
|
# Additional stuff for the LaTeX preamble.
|
||||||
|
|
||||||
|
'preamble': '',
|
||||||
|
|
||||||
|
# Latex figure (float) alignment
|
||||||
|
|
||||||
|
'figure_align': 'htbp',
|
||||||
|
}
|
||||||
|
|
||||||
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
|
# (source start file, target name, title,
|
||||||
|
# author, documentclass [howto, manual, or own class]).
|
||||||
|
latex_documents = [
|
||||||
|
(master_doc, 'CERClibs.tex', 'CERC libs Documentation',
|
||||||
|
'Guillermo Gutierrez', 'manual'),
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for manual page output ------------------------------------------
|
||||||
|
|
||||||
|
# One entry per manual page. List of tuples
|
||||||
|
# (source start file, name, description, authors, manual section).
|
||||||
|
man_pages = [
|
||||||
|
(master_doc, 'cerclibs', 'CERC libs Documentation',
|
||||||
|
[author], 1)
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for Texinfo output ----------------------------------------------
|
||||||
|
|
||||||
|
# Grouping the document tree into Texinfo files. List of tuples
|
||||||
|
# (source start file, target name, title, author,
|
||||||
|
# dir menu entry, description, category)
|
||||||
|
texinfo_documents = [
|
||||||
|
(master_doc, 'CERClibs', 'CERC libs Documentation',
|
||||||
|
author, 'CERClibs', 'One line description of project.',
|
||||||
|
'Miscellaneous'),
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
# -- Options for Epub output -------------------------------------------------
|
||||||
|
|
||||||
|
# Bibliographic Dublin Core info.
|
||||||
|
epub_title = project
|
||||||
|
|
||||||
|
# The unique identifier of the text. This can be a ISBN number
|
||||||
|
# or the project homepage.
|
||||||
|
#
|
||||||
|
# epub_identifier = ''
|
||||||
|
|
||||||
|
# A unique identification for the text.
|
||||||
|
#
|
||||||
|
# epub_uid = ''
|
||||||
|
|
||||||
|
# A list of files that should not be packed into the epub file.
|
||||||
|
epub_exclude_files = ['search.html']
|
||||||
|
|
||||||
|
|
||||||
|
# -- Extension configuration -------------------------------------------------
|
||||||
|
|
||||||
|
# -- Options for todo extension ----------------------------------------------
|
||||||
|
|
||||||
|
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||||
|
todo_include_todos = True
|
||||||
104
docs/source/index.rst
Normal file
104
docs/source/index.rst
Normal file
|
|
@ -0,0 +1,104 @@
|
||||||
|
.. CERC libs documentation master file, created by
|
||||||
|
sphinx-quickstart on Mon Jun 15 09:17:03 2020.
|
||||||
|
You can adapt this file completely to your liking, but it should at least
|
||||||
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
|
Welcome to CERC libs's documentation!
|
||||||
|
=====================================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 5
|
||||||
|
:caption: Contents:
|
||||||
|
|
||||||
|
Indices and tables
|
||||||
|
====================
|
||||||
|
|
||||||
|
* :ref:`genindex`
|
||||||
|
* :ref:`modindex`
|
||||||
|
* :ref:`search`
|
||||||
|
|
||||||
|
City Model Structure
|
||||||
|
====================
|
||||||
|
|
||||||
|
City
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.city
|
||||||
|
:members:
|
||||||
|
|
||||||
|
City Object
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.city_object
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Internal Gains
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.internal_gains
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Layer
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.layer
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Material
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.material
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Polyhedron
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.polyhedron
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Surface
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.surface
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Thermal Boundary
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.thermal_boundary
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Thermal Opening
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.thermal_opening
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Thermal Zone
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.thermal_zone
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Usage Zone
|
||||||
|
********************
|
||||||
|
.. automodule:: city_model_structure.usage_zone
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Factories
|
||||||
|
====================
|
||||||
|
|
||||||
|
Geometry Factory
|
||||||
|
********************
|
||||||
|
.. automodule:: geometry.geometry_factory
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Physics Factory
|
||||||
|
********************
|
||||||
|
.. automodule:: physics.physics_factory
|
||||||
|
:members:
|
||||||
|
|
||||||
|
Usage Factory
|
||||||
|
********************
|
||||||
|
.. automodule:: usage.usage_factory
|
||||||
|
:members:
|
||||||
|
|
||||||
|
|
||||||
|
Additional Files
|
||||||
|
====================
|
||||||
|
|
||||||
|
:download:`README.md<../../README.md>`
|
||||||
|
:download:`LICENSE.md<../../LICENSE.md>`
|
||||||
|
:download:`CODE_OF_CONDUCT.md<../../CODE_OF_CONDUCT.md>`
|
||||||
|
:download:`CONTRIBUTING.md<../../CONTRIBUTING.md>`
|
||||||
|
:download:`PYGUIDE.md<../../PYGUIDE.md>`
|
||||||
|
|
@ -8,6 +8,9 @@ from city_model_structure.city import City
|
||||||
|
|
||||||
|
|
||||||
class GeometryFactory:
|
class GeometryFactory:
|
||||||
|
"""
|
||||||
|
GeometryFactory class
|
||||||
|
"""
|
||||||
def __init__(self, file_type, path):
|
def __init__(self, file_type, path):
|
||||||
self._file_type = '_' + file_type.lower()
|
self._file_type = '_' + file_type.lower()
|
||||||
self._path = path
|
self._path = path
|
||||||
|
|
@ -27,7 +30,7 @@ class GeometryFactory:
|
||||||
@property
|
@property
|
||||||
def city(self) -> City:
|
def city(self) -> City:
|
||||||
"""
|
"""
|
||||||
Geometry factory city model structure with geometry
|
Load the city model structure from a geometry source
|
||||||
:return: City
|
:return: City
|
||||||
"""
|
"""
|
||||||
return getattr(self, self._file_type, lambda: None)
|
return getattr(self, self._file_type, lambda: None)
|
||||||
|
|
|
||||||
|
|
@ -12,8 +12,7 @@ class ConfigurationHelper:
|
||||||
Configuration class
|
Configuration class
|
||||||
"""
|
"""
|
||||||
def __init__(self):
|
def __init__(self):
|
||||||
base_path = Path().resolve().parent
|
config_file = Path(Path(__file__).parent.parent / 'config/configuration.ini').resolve()
|
||||||
config_file = Path(base_path / 'libs/config/configuration.ini').resolve()
|
|
||||||
self._config = configparser.ConfigParser()
|
self._config = configparser.ConfigParser()
|
||||||
self._config.read(config_file)
|
self._config.read(config_file)
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -115,16 +115,16 @@ class TestGeometryFactory(TestCase):
|
||||||
self.assertIsNotNone(thermal_zone.floor_area, 'thermal_zone floor_area is none')
|
self.assertIsNotNone(thermal_zone.floor_area, 'thermal_zone floor_area is none')
|
||||||
self.assertIsNotNone(thermal_zone.heated, 'thermal_zone heated is none')
|
self.assertIsNotNone(thermal_zone.heated, 'thermal_zone heated is none')
|
||||||
self.assertIsNotNone(thermal_zone.cooled, 'thermal_zone cooled is none')
|
self.assertIsNotNone(thermal_zone.cooled, 'thermal_zone cooled is none')
|
||||||
self.assertIsNone(thermal_zone.additional_thermal_bridge_u_value,
|
self.assertEqual(thermal_zone.additional_thermal_bridge_u_value, 0.0,
|
||||||
'thermal_zone additional_thermal_bridge_u_value is not none')
|
'thermal_zone additional_thermal_bridge_u_value is not 0.0')
|
||||||
self.assertIsNone(thermal_zone.effective_thermal_capacity,
|
self.assertIsNone(thermal_zone.effective_thermal_capacity,
|
||||||
'thermal_zone effective_thermal_capacity is not none')
|
'thermal_zone effective_thermal_capacity is not none')
|
||||||
self.assertIsNone(thermal_zone.indirectly_heated_area_ratio,
|
self.assertEqual(thermal_zone.indirectly_heated_area_ratio, 0.0,
|
||||||
'thermal_zone indirectly_heated_area_ratio is not none')
|
'thermal_zone indirectly_heated_area_ratio is not none')
|
||||||
self.assertIsNone(thermal_zone.infiltration_rate_system_off,
|
self.assertIsNone(thermal_zone.infiltration_rate_system_off,
|
||||||
'thermal_zone infiltration_rate_system_off is not none')
|
'thermal_zone infiltration_rate_system_off is not none')
|
||||||
self.assertIsNone(thermal_zone.infiltration_rate_system_on,
|
self.assertEqual(thermal_zone.infiltration_rate_system_on, 0.0,
|
||||||
'thermal_zone infiltration_rate_system_on is not none')
|
'thermal_zone infiltration_rate_system_on is not none')
|
||||||
self.assertIsNone(thermal_zone.usage_zones,
|
self.assertIsNone(thermal_zone.usage_zones,
|
||||||
'thermal_zone usage_zones are not none')
|
'thermal_zone usage_zones are not none')
|
||||||
|
|
||||||
|
|
@ -168,14 +168,14 @@ class TestGeometryFactory(TestCase):
|
||||||
for thermal_zone in city_object.thermal_zones:
|
for thermal_zone in city_object.thermal_zones:
|
||||||
for thermal_boundary in thermal_zone.bounded:
|
for thermal_boundary in thermal_zone.bounded:
|
||||||
for thermal_opening in thermal_boundary.thermal_openings:
|
for thermal_opening in thermal_boundary.thermal_openings:
|
||||||
self.assertIsNone(thermal_opening.area, 'thermal_opening area was initialized')
|
|
||||||
self.assertTrue(thermal_opening.frame_ratio == 0, 'thermal_opening frame_ratio was not 0')
|
self.assertTrue(thermal_opening.frame_ratio == 0, 'thermal_opening frame_ratio was not 0')
|
||||||
self.assertIsNone(thermal_opening.g_value, 'thermal_opening g_value was initialized')
|
self.assertIsNone(thermal_opening.g_value, 'thermal_opening g_value was initialized')
|
||||||
self.assertIsNone(thermal_opening.conductivity, 'thermal_opening conductivity_w_mk was initialized')
|
self.assertIsNone(thermal_opening.conductivity, 'thermal_opening conductivity_w_mk was initialized')
|
||||||
self.assertIsNone(thermal_opening.inside_reflectance, 'thermal_opening inside_reflectance was initialized')
|
self.assertIsNone(thermal_opening.back_side_solar_transmittance_at_normal_incidence,
|
||||||
|
'thermal_opening back_side_solar_transmittance_at_normal_incidence was initialized')
|
||||||
self.assertRaises(Exception, lambda: thermal_opening.openable_ratio,
|
self.assertRaises(Exception, lambda: thermal_opening.openable_ratio,
|
||||||
'thermal_opening openable_ratio is not raising an exception')
|
'thermal_opening openable_ratio is not raising an exception')
|
||||||
self.assertIsNone(thermal_opening.outside_reflectance,
|
self.assertIsNone(thermal_opening.front_side_solar_transmittance_at_normal_incidence,
|
||||||
'thermal_opening outside_reflectance was initialized')
|
'thermal_opening front_side_solar_transmittance_at_normal_incidence was initialized')
|
||||||
self.assertIsNone(thermal_opening.thickness, 'thermal_opening thickness_m was initialized')
|
self.assertIsNone(thermal_opening.thickness, 'thermal_opening thickness_m was initialized')
|
||||||
self.assertRaises(Exception, lambda: thermal_opening.u_value, 'thermal_opening u_value was initialized')
|
self.assertRaises(Exception, lambda: thermal_opening.u_value, 'thermal_opening u_value was initialized')
|
||||||
|
|
|
||||||
|
|
@ -54,7 +54,5 @@ class TestPhysicsFactory(TestCase):
|
||||||
self.assertIsNotNone(thermal_zone.bounded, 'bounded is none')
|
self.assertIsNotNone(thermal_zone.bounded, 'bounded is none')
|
||||||
for thermal_boundary in thermal_zone.bounded:
|
for thermal_boundary in thermal_zone.bounded:
|
||||||
self.assertIsNotNone(thermal_boundary.outside_solar_absorptance, 'outside_solar_absorptance is none')
|
self.assertIsNotNone(thermal_boundary.outside_solar_absorptance, 'outside_solar_absorptance is none')
|
||||||
self.assertIsNotNone(thermal_boundary.outside_thermal_absorptance, 'outside_thermal_absorptance is none')
|
|
||||||
self.assertIsNotNone(thermal_boundary.outside_visible_absorptance, 'outside_visible_absorptance is none')
|
|
||||||
self.assertIsNotNone(thermal_boundary.window_ratio, 'window_ratio is none')
|
self.assertIsNotNone(thermal_boundary.window_ratio, 'window_ratio is none')
|
||||||
self.assertIsNotNone(thermal_boundary.layers, 'layers is none')
|
self.assertIsNotNone(thermal_boundary.layers, 'layers is none')
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user