diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 343ba92..91dca7c 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -9,11 +9,13 @@ on: - reopened paths: - '**.py' + - 'pyproject.toml' push: branches: - main paths: - '**.py' + - 'pyproject.toml' jobs: test: @@ -21,31 +23,62 @@ jobs: strategy: fail-fast: false matrix: - python-version: [ "3.9", "3.10" ] + python-version: [ "3.9", "3.10", "3.11" ] steps: - uses: actions/checkout@v4 + with: + token: ${{ secrets.GITHUB_TOKEN }} - name: Install Python - uses: actions/setup-python@v1 + uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} - name: Install dependencies run: | python -m pip install --upgrade pip - pip install flake8 pytest - if [ -f requirements.txt ]; then pip install -r requirements.txt; fi - if [ -f ./engforge/datastores/datastores_requirements.txt ]; then pip install -r ./engforge/datastores/datastores_requirements.txt; fi + pip install flake8 pytest black + pip install -e .[all] - name: Display Python Version run: python -c "import sys; print(sys.version)" + - name: Check for existing release + if: github.event_name == 'pull_request' + run: | + VERSION=$(python -c " + try: + import tomllib + except ImportError: + import tomli as tomllib + with open('pyproject.toml', 'rb') as f: + print(tomllib.load(f)['project']['version']) + ") + echo "Checking for existing release v$VERSION" + if gh release view "v$VERSION" >/dev/null 2>&1; then + echo "::error::Release v$VERSION already exists. Please bump the version in pyproject.toml" + exit 1 + else + echo "Version v$VERSION is available" + fi + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: Auto-format with Black + if: github.event_name == 'pull_request' + run: | + black ./engforge + if ! git diff --quiet; then + git config --local user.email "action@github.com" + git config --local user.name "GitHub Action" + git add -A + git commit -m "Auto-format code with Black [skip ci]" || exit 0 + git push + fi + - name: Run tests - run: python -m unittest discover ./test/ + run: python -m unittest discover -s engforge/test -p "test_*.py" -v - - uses: psf/black@stable - with: - version: "24.8.0" - options: "--check --verbose" - src: "./engforge" \ No newline at end of file + - name: Verify Black formatting + run: black --check --verbose ./engforge \ No newline at end of file diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 9a4df6f..671f255 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,26 +1,19 @@ name: "docs" on: - push: - branches: - - main + pull_request: paths: - '**.py' - '**.md' - '**.rst' - - '**.yml' + - 'docs/**' permissions: - pages: write - id-token: write + contents: read jobs: docs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 - with: - ref: ${{ github.head_ref }} - - uses: actions/checkout@v4 - name: Install Python @@ -31,26 +24,16 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install -e . - if [ -f "./engforge/datastores/datastores_requirements.txt" ]; then pip install -r ./engforge/datastores/datastores_requirements.txt; fi + pip install -e .[all] pip install -r ./docs/requirements.txt - - name: make html + - name: Test documentation build run: | cd docs make html - - # - uses: actions/upload-artifact@v4 - # with: - # name: DocumentationHTML - # path: docs/_build/html/ - - name: Upload artifact - uses: actions/upload-pages-artifact@v3 + - name: Upload documentation artifact + uses: actions/upload-artifact@v4 with: - # Upload entire repository - path: 'docs/_build/html/' - - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v4 \ No newline at end of file + name: documentation-preview + path: docs/_build/html/ \ No newline at end of file diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..f6d7ce1 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,100 @@ +name: release + +on: + push: + branches: + - main + paths: + - '**.py' + - 'pyproject.toml' + - '**.md' + - '**.rst' + - '**.yml' + +permissions: + contents: write + pages: write + id-token: write + +jobs: + release: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Install Python + uses: actions/setup-python@v4 + with: + python-version: "3.10" + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install build twine + pip install -e .[all] + pip install -r ./docs/requirements.txt + + - name: Get version + id: version + run: | + VERSION=$(python -c " + try: + import tomllib + except ImportError: + import tomli as tomllib + with open('pyproject.toml', 'rb') as f: + print(tomllib.load(f)['project']['version']) + ") + echo "version=$VERSION" >> $GITHUB_OUTPUT + echo "Version: $VERSION" + + - name: Check if release exists + id: check_release + run: | + if gh release view "v${{ steps.version.outputs.version }}" >/dev/null 2>&1; then + echo "exists=true" >> $GITHUB_OUTPUT + echo "Release v${{ steps.version.outputs.version }} already exists" + else + echo "exists=false" >> $GITHUB_OUTPUT + echo "Release v${{ steps.version.outputs.version }} does not exist" + fi + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: Build documentation + run: | + cd docs + make html + + - name: Upload pages artifact + uses: actions/upload-pages-artifact@v3 + with: + path: 'docs/_build/html/' + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 + + - name: Build package + if: steps.check_release.outputs.exists == 'false' + run: | + python -m build + + - name: Create GitHub Release + if: steps.check_release.outputs.exists == 'false' + run: | + gh release create "v${{ steps.version.outputs.version }}" \ + --title "Release v${{ steps.version.outputs.version }}" \ + --notes "Automated release for version ${{ steps.version.outputs.version }}" \ + --generate-notes \ + dist/* + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: Publish to PyPI + if: steps.check_release.outputs.exists == 'false' + uses: pypa/gh-action-pypi-publish@release/v1 + with: + repository-url: https://upload.pypi.org/legacy/ \ No newline at end of file diff --git a/.gitignore b/.gitignore index 8b0e6e4..830264b 100644 --- a/.gitignore +++ b/.gitignore @@ -8,4 +8,18 @@ dist/* *.profile *.log -docs/_autosummary* \ No newline at end of file +# Build artifacts and packaging +*.egg-info/ +*.egg +.eggs/ +MANIFEST +.installed.cfg + +# Claude Code tracking files +*.claude.rar +.claude/ +claude_session_* + +# Documentation build +docs/_autosummary* +docs/_build/ \ No newline at end of file diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..39e94c8 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,289 @@ +# EngForge - Claude Development Guide + +## Overview +EngForge is a sophisticated engineering systems framework that provides tabulation, analysis, and solver capabilities for complex engineering problems. It's built on a component-system architecture with dynamic programming optimizations and integrated reporting. + +## Core Architecture + +### Key Design Patterns + +1. **Component-System Architecture**: The framework uses a hierarchical design where: + - `Component`: Basic building blocks that encapsulate engineering calculations and properties + - `System`: Orchestrates multiple components, manages data flow, and provides solver capabilities + - Both inherit from `SolveableInterface` which provides tabulation, configuration, and solving capabilities + +2. **Configuration-Based Design**: Uses the `@forge` decorator (similar to `@attrs.define`) to automatically configure classes with: + - Attribute validation and transformation + - Property change tracking + - Signal and slot management + - Automatic name generation + +3. **Cached Property System**: Implements dynamic programming through cached properties: + - `@system_property`: Basic cached properties + - `@cached_system_property`: Only recalculates when dependencies change + - Properties automatically track dependencies and invalidate when inputs change + +4. **Signal-Slot Pattern**: Data flow between components is managed via: + - `Signal.define(source, target, mode)`: Defines data flow connections + - `Slot.define(ComponentType)`: Defines component mounting points + - Supports pre/post execution modes and control signals + +### Core Classes and Concepts + +#### Configuration (`engforge/configuration.py`) +- `@forge` decorator: Main class decorator that configures all EngForge classes +- `Configuration`: Base class providing attribute management and property change callbacks +- Automatic name generation using randomized technical terms +- Property change tracking with `property_changed` callback + +#### Component (`engforge/components.py`) +- `SolveableInterface`: Common base providing tabulation, configuration, and solving +- `Component`: Basic building block with evaluation and caching capabilities +- `DynamicsMixin`: Provides time-based integration capabilities + +#### System (`engforge/system.py`) +- `System`: Orchestrates components, manages solver execution, provides plotting +- Inherits from `SolverMixin`, `SolveableInterface`, `PlottingMixin`, `GlobalDynamics` +- Manages component slots and signal routing +- Provides solver execution with constraint handling + +#### Solver Framework (`engforge/solver.py`, `engforge/attr_solver.py`) +- `SolverMixin`: Core solver capabilities using scipy optimizers +- `Solver.define(dependent, independent)`: Defines solver equations +- Constraint system with min/max limits and custom functions +- Supports multiple solver combos and variable sets + +#### Attributes System (`engforge/attributes.py`, `engforge/attr_*.py`) +- `ATTR_BASE`: Base attribute system with dependency tracking +- `Time`: Time integration attributes for dynamics +- `Signal`: Data flow attributes +- `Slot`: Component mounting attributes +- `Plot`/`Trace`: Plotting and visualization attributes +- All attributes support instance-level customization and caching + +### Property and Caching System + +The framework implements sophisticated caching through several property decorators: + +```python +@system_property +def calculated_value(self) -> float: + """Basic cached property""" + return expensive_calculation() + +@cached_system_property +def dynamic_value(self) -> float: + """Only recalculates when dependencies change""" + return self.input_a * self.input_b +``` + +Properties automatically: +- Cache results until dependencies change +- Track inter-property dependencies +- Support type validation and conversion +- Integrate with the solver system for constraint handling + +### Data Flow and Tabulation + +The framework provides comprehensive data capture through: + +1. **System References** (`engforge/system_reference.py`): Lightweight references to nested attributes +2. **DataframeMixin** (`engforge/dataframe.py`): Automatic pandas DataFrame generation +3. **TabulationMixin** (`engforge/tabulation.py`): Data collection and organization + +All component attributes and system properties are automatically captured into structured DataFrames suitable for analysis and reporting. + +## Engineering Domain Libraries + +### Fluid Mechanics (`engforge/eng/fluid_material.py`) +- `FluidMaterial`: Base class for fluid property calculations +- `CoolPropMaterial`: Integration with CoolProp thermodynamic database +- Built-in materials: Air, Water, Steam, Hydrogen, Oxygen +- Support for mixtures and ideal gas approximations + +### Solid Mechanics (`engforge/eng/solid_materials.py`) +- `SolidMaterial`: Material property definitions +- Standard materials: Steel (SS_316, ANSI_4130/4340), Aluminum, Carbon Fiber, Concrete +- Stress/strain calculations and safety factors + +### Thermodynamics (`engforge/eng/thermodynamics.py`) +- Component models: Compressor, Turbine, Heat Exchanger, Pump +- Cycle analysis capabilities +- Heat transfer and pressure drop correlations + +### Structural Analysis (`engforge/eng/structure_beams.py`, `engforge/eng/geometry.py`) +- Beam analysis with PyNite FEA integration +- Cross-sectional property calculations +- Geometric primitives and section properties + +### Pipe Networks (`engforge/eng/pipes.py`) +- Flow network modeling with pressure drop calculations +- Pump and fitting models +- System-level flow analysis + +### Cost Analysis (`engforge/eng/costs.py`) +- Engineering economics with time value of money +- Cost categorization and breakdown analysis +- Integration with system design parameters + +## Testing Framework + +The project uses Python's built-in `unittest` framework: + +### Test Structure +- Tests located in `engforge/test/` directory +- Import tests in `test_modules.py` verify all modules load correctly +- Domain-specific tests for components, solver, dynamics, etc. + +### Running Tests +```bash +# Install package in development mode +pip install -e . + +# Run all tests +python -m unittest discover -s engforge/test -p "test_*.py" -v + +# Run specific test module +python -m unittest engforge.test.test_modules -v +``` + +### Test Dependencies +The full test suite requires all optional dependencies. Core functionality can be tested with: +- `attrs>=23.2.0` - Core attribute system +- `numpy>=1.24.3` - Numerical computations +- `scipy` - Solver algorithms +- `matplotlib>=3.8.1` - Plotting +- `pandas` - Data handling + +## Examples and Usage Patterns + +### Air Filter Analysis Example +Located in `examples/air_filter.py`, demonstrates: +- Component definition with `@forge` decorator +- System assembly with slots and signals +- Solver configuration for flow balancing +- Plotting integration and data analysis + +### Spring-Mass-Damper Example +Shows dynamic system analysis with: +- Time integration using `Time.integrate()` +- Solver constraints and variable handling +- Multi-parameter studies with `run()` method + +### Analysis and Reporting +The `Analysis` class provides: +- System wrapping with additional post-processing +- Multiple reporter integration (CSV, Excel, plots) +- Automated data collection and storage + +## Development Guidelines + +### Code Quality Focus +- **Only modify non-scientific code**: Algorithmic and engineering calculations should not be altered +- **Follow existing patterns**: Use `@forge`, inherit from appropriate base classes +- **Maintain property caching**: Ensure expensive calculations are properly cached +- **Preserve signal-slot architecture**: Data flow should use defined patterns + +### Build-Test-Fix Process +The project uses a comprehensive CI/CD pipeline that can be validated locally: + +#### Local Validation Steps +1. **Create clean test environment:** + ```bash + cd /tmp && python -m venv test_engforge_env + source test_engforge_env/bin/activate + pip install --upgrade pip + ``` + +2. **Install package and dependencies:** + ```bash + cd + source /tmp/test_engforge_env/bin/activate + pip install -e . # Core dependencies only + pip install -e .[all] # All optional dependencies + pip install -e .[database] # Database functionality only + pip install -e .[google,cloud] # Specific optional groups + ``` + +3. **Test version extraction (CI compatibility):** + ```bash + python -c " + try: + import tomllib + except ImportError: + import tomli as tomllib + with open('pyproject.toml', 'rb') as f: + print('✅ Version:', tomllib.load(f)['project']['version']) + " + ``` + +4. **Run tests:** + ```bash + python -m unittest discover -s engforge/test -p "test_*.py" -v + ``` + +5. **Check code formatting:** + ```bash + black --check --verbose ./engforge + ``` + +#### Common Issues and Solutions +- **tomllib ImportError**: Fixed with `tomli>=1.2.0;python_version<'3.11'` dependency +- **SQLAlchemy missing**: Auto-installation will prompt when importing datastores, or install manually with `pip install engforge[database]` +- **Black formatting**: All files should pass formatting checks; use `black ./engforge` to auto-format + +#### Optional Dependencies & Auto-Installation +The project uses modern pyproject.toml optional dependencies with intelligent auto-installation: + +**Dependency Groups:** +- **`[database]`**: SQLAlchemy, PostgreSQL, disk caching +- **`[google]`**: Google Sheets and Drive integration +- **`[cloud]`**: AWS boto3 integration +- **`[distributed]`**: Ray distributed computing +- **`[all]`**: All optional dependencies combined + +**Auto-Installation Behavior:** +- When importing `engforge.datastores`, missing dependencies trigger an auto-install prompt +- Reads pyproject.toml directly to determine required packages +- Works in development mode (editable installs) by detecting project root +- Graceful fallback to manual installation instructions + +**Manual Installation:** +```bash +pip install engforge[database,cloud] # Specific groups +pip install engforge[all] # All optional dependencies +pip install -e .[all] # Development mode with all deps +``` + +### Key Files to Understand +1. `configuration.py` - Core class configuration system +2. `components.py` - Component base classes +3. `system.py` - System orchestration +4. `properties.py` - Property and caching decorators +5. `attributes.py` - Attribute system foundation + +### Common Patterns +```python +@forge # Always use this decorator +class MyComponent(Component): + # Use attrs.field for inputs + input_value: float = attrs.field(default=1.0) + + # Use system_property for calculated outputs + @system_property + def output_value(self) -> float: + return self.input_value * 2.0 + +@forge +class MySystem(System): + # Define component slots + comp: MyComponent = Slot.define(MyComponent) + + # Define data flow + set_input = Signal.define('external_param', 'comp.input_value') + + # Define solver if needed + solver = Solver.define('constraint_equation', 'control_variable') +``` + +The framework emphasizes declarative configuration over imperative programming, extensive use of caching for performance, and clear separation between data flow definition and execution. \ No newline at end of file diff --git a/docs/_build/doctrees/_autosummary/engforge.analysis.Analysis.doctree b/docs/_build/doctrees/_autosummary/engforge.analysis.Analysis.doctree deleted file mode 100644 index 3b2ca98..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.analysis.Analysis.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.analysis.doctree b/docs/_build/doctrees/_autosummary/engforge.analysis.doctree deleted file mode 100644 index 25d1b86..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.analysis.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.analysis.make_reporter_check.doctree b/docs/_build/doctrees/_autosummary/engforge.analysis.make_reporter_check.doctree deleted file mode 100644 index 790a4a1..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.analysis.make_reporter_check.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_dynamics.IntegratorInstance.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_dynamics.IntegratorInstance.doctree deleted file mode 100644 index dd63726..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_dynamics.IntegratorInstance.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_dynamics.TRANSIENT.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_dynamics.TRANSIENT.doctree deleted file mode 100644 index 3d52684..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_dynamics.TRANSIENT.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_dynamics.Time.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_dynamics.Time.doctree deleted file mode 100644 index 51f5c79..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_dynamics.Time.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_dynamics.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_dynamics.doctree deleted file mode 100644 index ccd126c..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_dynamics.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.PLOT.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_plotting.PLOT.doctree deleted file mode 100644 index 1078a39..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.PLOT.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.PlotBase.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_plotting.PlotBase.doctree deleted file mode 100644 index aefef90..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.PlotBase.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.PlotInstance.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_plotting.PlotInstance.doctree deleted file mode 100644 index e648aa7..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.PlotInstance.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.PlotLog.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_plotting.PlotLog.doctree deleted file mode 100644 index 7110d17..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.PlotLog.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.PlottingMixin.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_plotting.PlottingMixin.doctree deleted file mode 100644 index 7112454..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.PlottingMixin.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.Trace.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_plotting.Trace.doctree deleted file mode 100644 index efd4862..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.Trace.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.TraceInstance.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_plotting.TraceInstance.doctree deleted file mode 100644 index 2521a0e..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.TraceInstance.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.conv_ctx.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_plotting.conv_ctx.doctree deleted file mode 100644 index b0db1ac..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.conv_ctx.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.conv_maps.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_plotting.conv_maps.doctree deleted file mode 100644 index 6c45b25..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.conv_maps.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.conv_theme.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_plotting.conv_theme.doctree deleted file mode 100644 index 81086b8..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.conv_theme.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_plotting.doctree deleted file mode 100644 index 2035abf..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.install_seaborn.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_plotting.install_seaborn.doctree deleted file mode 100644 index a796c55..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.install_seaborn.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.save_all_figures_to_pdf.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_plotting.save_all_figures_to_pdf.doctree deleted file mode 100644 index 494c698..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_plotting.save_all_figures_to_pdf.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_signals.Signal.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_signals.Signal.doctree deleted file mode 100644 index 8544a61..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_signals.Signal.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_signals.SignalInstance.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_signals.SignalInstance.doctree deleted file mode 100644 index 699ffbe..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_signals.SignalInstance.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_signals.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_signals.doctree deleted file mode 100644 index 5c8cb73..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_signals.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_slots.Slot.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_slots.Slot.doctree deleted file mode 100644 index 95d5348..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_slots.Slot.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_slots.SlotLog.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_slots.SlotLog.doctree deleted file mode 100644 index ef99be8..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_slots.SlotLog.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_slots.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_slots.doctree deleted file mode 100644 index 375110c..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_slots.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_solver.AttrSolverLog.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_solver.AttrSolverLog.doctree deleted file mode 100644 index a4a3898..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_solver.AttrSolverLog.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_solver.Solver.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_solver.Solver.doctree deleted file mode 100644 index fc615c9..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_solver.Solver.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_solver.SolverInstance.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_solver.SolverInstance.doctree deleted file mode 100644 index 0c02cbe..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_solver.SolverInstance.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attr_solver.doctree b/docs/_build/doctrees/_autosummary/engforge.attr_solver.doctree deleted file mode 100644 index 7cc5b2b..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attr_solver.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attributes.ATTRLog.doctree b/docs/_build/doctrees/_autosummary/engforge.attributes.ATTRLog.doctree deleted file mode 100644 index d83620a..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attributes.ATTRLog.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attributes.ATTR_BASE.doctree b/docs/_build/doctrees/_autosummary/engforge.attributes.ATTR_BASE.doctree deleted file mode 100644 index 37990fd..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attributes.ATTR_BASE.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attributes.AttributeInstance.doctree b/docs/_build/doctrees/_autosummary/engforge.attributes.AttributeInstance.doctree deleted file mode 100644 index e606b26..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attributes.AttributeInstance.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.attributes.doctree b/docs/_build/doctrees/_autosummary/engforge.attributes.doctree deleted file mode 100644 index 33f7adc..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.attributes.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.common.ForgeLog.doctree b/docs/_build/doctrees/_autosummary/engforge.common.ForgeLog.doctree deleted file mode 100644 index 9d88153..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.common.ForgeLog.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.common.chunks.doctree b/docs/_build/doctrees/_autosummary/engforge.common.chunks.doctree deleted file mode 100644 index 0ba3e01..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.common.chunks.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.common.doctree b/docs/_build/doctrees/_autosummary/engforge.common.doctree deleted file mode 100644 index ce25b7c..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.common.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.common.get_size.doctree b/docs/_build/doctrees/_autosummary/engforge.common.get_size.doctree deleted file mode 100644 index 518ddab..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.common.get_size.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.common.inst_vectorize.doctree b/docs/_build/doctrees/_autosummary/engforge.common.inst_vectorize.doctree deleted file mode 100644 index 057de55..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.common.inst_vectorize.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.common.is_ec2_instance.doctree b/docs/_build/doctrees/_autosummary/engforge.common.is_ec2_instance.doctree deleted file mode 100644 index 8b39344..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.common.is_ec2_instance.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.component_collections.ComponentDict.doctree b/docs/_build/doctrees/_autosummary/engforge.component_collections.ComponentDict.doctree deleted file mode 100644 index 650cc99..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.component_collections.ComponentDict.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.component_collections.ComponentIter.doctree b/docs/_build/doctrees/_autosummary/engforge.component_collections.ComponentIter.doctree deleted file mode 100644 index 05bd2cc..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.component_collections.ComponentIter.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.component_collections.ComponentIterator.doctree b/docs/_build/doctrees/_autosummary/engforge.component_collections.ComponentIterator.doctree deleted file mode 100644 index 58baa37..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.component_collections.ComponentIterator.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.component_collections.check_comp_type.doctree b/docs/_build/doctrees/_autosummary/engforge.component_collections.check_comp_type.doctree deleted file mode 100644 index 8ac8782..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.component_collections.check_comp_type.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.component_collections.doctree b/docs/_build/doctrees/_autosummary/engforge.component_collections.doctree deleted file mode 100644 index d24aba8..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.component_collections.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.component_collections.iter_tkn.doctree b/docs/_build/doctrees/_autosummary/engforge.component_collections.iter_tkn.doctree deleted file mode 100644 index bc8e303..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.component_collections.iter_tkn.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.components.Component.doctree b/docs/_build/doctrees/_autosummary/engforge.components.Component.doctree deleted file mode 100644 index 6e4230e..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.components.Component.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.components.SolveableInterface.doctree b/docs/_build/doctrees/_autosummary/engforge.components.SolveableInterface.doctree deleted file mode 100644 index 1420146..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.components.SolveableInterface.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.components.doctree b/docs/_build/doctrees/_autosummary/engforge.components.doctree deleted file mode 100644 index 11cc98c..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.components.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.configuration.ConfigLog.doctree b/docs/_build/doctrees/_autosummary/engforge.configuration.ConfigLog.doctree deleted file mode 100644 index 3b43277..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.configuration.ConfigLog.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.configuration.Configuration.doctree b/docs/_build/doctrees/_autosummary/engforge.configuration.Configuration.doctree deleted file mode 100644 index 4f24a21..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.configuration.Configuration.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.configuration.comp_transform.doctree b/docs/_build/doctrees/_autosummary/engforge.configuration.comp_transform.doctree deleted file mode 100644 index e4c0a8a..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.configuration.comp_transform.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.configuration.conv_nms.doctree b/docs/_build/doctrees/_autosummary/engforge.configuration.conv_nms.doctree deleted file mode 100644 index bdb350b..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.configuration.conv_nms.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.configuration.doctree b/docs/_build/doctrees/_autosummary/engforge.configuration.doctree deleted file mode 100644 index fbcbc94..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.configuration.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.configuration.forge.doctree b/docs/_build/doctrees/_autosummary/engforge.configuration.forge.doctree deleted file mode 100644 index 41e61d1..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.configuration.forge.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.configuration.meta.doctree b/docs/_build/doctrees/_autosummary/engforge.configuration.meta.doctree deleted file mode 100644 index 0464361..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.configuration.meta.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.configuration.name_generator.doctree b/docs/_build/doctrees/_autosummary/engforge.configuration.name_generator.doctree deleted file mode 100644 index 3ca4a22..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.configuration.name_generator.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.configuration.property_changed.doctree b/docs/_build/doctrees/_autosummary/engforge.configuration.property_changed.doctree deleted file mode 100644 index 5ae7102..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.configuration.property_changed.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.configuration.signals_slots_handler.doctree b/docs/_build/doctrees/_autosummary/engforge.configuration.signals_slots_handler.doctree deleted file mode 100644 index 000f577..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.configuration.signals_slots_handler.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.dataframe.DataFrameLog.doctree b/docs/_build/doctrees/_autosummary/engforge.dataframe.DataFrameLog.doctree deleted file mode 100644 index 5447880..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.dataframe.DataFrameLog.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.dataframe.DataframeMixin.doctree b/docs/_build/doctrees/_autosummary/engforge.dataframe.DataframeMixin.doctree deleted file mode 100644 index f2e8259..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.dataframe.DataframeMixin.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.dataframe.dataframe_prop.doctree b/docs/_build/doctrees/_autosummary/engforge.dataframe.dataframe_prop.doctree deleted file mode 100644 index ba05fb6..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.dataframe.dataframe_prop.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.dataframe.dataframe_property.doctree b/docs/_build/doctrees/_autosummary/engforge.dataframe.dataframe_property.doctree deleted file mode 100644 index 170f805..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.dataframe.dataframe_property.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.dataframe.determine_split.doctree b/docs/_build/doctrees/_autosummary/engforge.dataframe.determine_split.doctree deleted file mode 100644 index 37098c8..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.dataframe.determine_split.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.dataframe.df_prop.doctree b/docs/_build/doctrees/_autosummary/engforge.dataframe.df_prop.doctree deleted file mode 100644 index c847445..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.dataframe.df_prop.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.dataframe.doctree b/docs/_build/doctrees/_autosummary/engforge.dataframe.doctree deleted file mode 100644 index 3b9b49b..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.dataframe.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.dataframe.is_uniform.doctree b/docs/_build/doctrees/_autosummary/engforge.dataframe.is_uniform.doctree deleted file mode 100644 index bce5339..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.dataframe.is_uniform.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.dataframe.key_func.doctree b/docs/_build/doctrees/_autosummary/engforge.dataframe.key_func.doctree deleted file mode 100644 index 980603e..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.dataframe.key_func.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.dataframe.split_dataframe.doctree b/docs/_build/doctrees/_autosummary/engforge.dataframe.split_dataframe.doctree deleted file mode 100644 index e7eccd6..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.dataframe.split_dataframe.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.datastores.data.DBConnection.doctree b/docs/_build/doctrees/_autosummary/engforge.datastores.data.DBConnection.doctree deleted file mode 100644 index 5f1506e..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.datastores.data.DBConnection.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.datastores.data.DiskCacheStore.doctree b/docs/_build/doctrees/_autosummary/engforge.datastores.data.DiskCacheStore.doctree deleted file mode 100644 index 4f84cf9..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.datastores.data.DiskCacheStore.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.datastores.data.addapt_numpy_array.doctree b/docs/_build/doctrees/_autosummary/engforge.datastores.data.addapt_numpy_array.doctree deleted file mode 100644 index 1ae2215..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.datastores.data.addapt_numpy_array.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.datastores.data.addapt_numpy_float32.doctree b/docs/_build/doctrees/_autosummary/engforge.datastores.data.addapt_numpy_float32.doctree deleted file mode 100644 index 7acb1f7..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.datastores.data.addapt_numpy_float32.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.datastores.data.addapt_numpy_float64.doctree b/docs/_build/doctrees/_autosummary/engforge.datastores.data.addapt_numpy_float64.doctree deleted file mode 100644 index 651906e..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.datastores.data.addapt_numpy_float64.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.datastores.data.addapt_numpy_int32.doctree b/docs/_build/doctrees/_autosummary/engforge.datastores.data.addapt_numpy_int32.doctree deleted file mode 100644 index fc1d094..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.datastores.data.addapt_numpy_int32.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.datastores.data.addapt_numpy_int64.doctree b/docs/_build/doctrees/_autosummary/engforge.datastores.data.addapt_numpy_int64.doctree deleted file mode 100644 index fd81cf7..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.datastores.data.addapt_numpy_int64.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.datastores.data.autocorrelation_direct.doctree b/docs/_build/doctrees/_autosummary/engforge.datastores.data.autocorrelation_direct.doctree deleted file mode 100644 index dc416c8..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.datastores.data.autocorrelation_direct.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.datastores.data.autocorrelation_fft.doctree b/docs/_build/doctrees/_autosummary/engforge.datastores.data.autocorrelation_fft.doctree deleted file mode 100644 index b13374b..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.datastores.data.autocorrelation_fft.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.datastores.data.autocorrelation_numpy.doctree b/docs/_build/doctrees/_autosummary/engforge.datastores.data.autocorrelation_numpy.doctree deleted file mode 100644 index 68961f2..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.datastores.data.autocorrelation_numpy.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.datastores.data.doctree b/docs/_build/doctrees/_autosummary/engforge.datastores.data.doctree deleted file mode 100644 index c4f1124..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.datastores.data.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.datastores.data.nan_to_null.doctree b/docs/_build/doctrees/_autosummary/engforge.datastores.data.nan_to_null.doctree deleted file mode 100644 index 6775f32..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.datastores.data.nan_to_null.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.datastores.doctree b/docs/_build/doctrees/_autosummary/engforge.datastores.doctree deleted file mode 100644 index b3ef339..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.datastores.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.doctree b/docs/_build/doctrees/_autosummary/engforge.doctree deleted file mode 100644 index e26d702..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.dynamics.DynamicsMixin.doctree b/docs/_build/doctrees/_autosummary/engforge.dynamics.DynamicsMixin.doctree deleted file mode 100644 index 29344fc..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.dynamics.DynamicsMixin.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.dynamics.GlobalDynamics.doctree b/docs/_build/doctrees/_autosummary/engforge.dynamics.GlobalDynamics.doctree deleted file mode 100644 index 0a14349..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.dynamics.GlobalDynamics.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.dynamics.INDEX_MAP.doctree b/docs/_build/doctrees/_autosummary/engforge.dynamics.INDEX_MAP.doctree deleted file mode 100644 index d941cfe..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.dynamics.INDEX_MAP.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.dynamics.doctree b/docs/_build/doctrees/_autosummary/engforge.dynamics.doctree deleted file mode 100644 index fb12f0d..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.dynamics.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.dynamics.valid_mtx.doctree b/docs/_build/doctrees/_autosummary/engforge.dynamics.valid_mtx.doctree deleted file mode 100644 index c38714e..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.dynamics.valid_mtx.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.costs.CostLog.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.costs.CostLog.doctree deleted file mode 100644 index 3b80c66..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.costs.CostLog.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.costs.CostModel.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.costs.CostModel.doctree deleted file mode 100644 index dfb4cfd..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.costs.CostModel.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.costs.Economics.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.costs.Economics.doctree deleted file mode 100644 index 5294d8f..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.costs.Economics.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.costs.cost_property.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.costs.cost_property.doctree deleted file mode 100644 index 2b1249c..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.costs.cost_property.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.costs.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.costs.doctree deleted file mode 100644 index 55f7b00..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.costs.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.costs.eval_slot_cost.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.costs.eval_slot_cost.doctree deleted file mode 100644 index f32c768..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.costs.eval_slot_cost.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.costs.gend.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.costs.gend.doctree deleted file mode 100644 index f945c13..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.costs.gend.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.doctree deleted file mode 100644 index 0f38c25..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.Air.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.Air.doctree deleted file mode 100644 index 90c05ac..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.Air.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.AirWaterMix.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.AirWaterMix.doctree deleted file mode 100644 index ac282ca..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.AirWaterMix.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.CoolPropMaterial.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.CoolPropMaterial.doctree deleted file mode 100644 index 2ebca05..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.CoolPropMaterial.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.CoolPropMixture.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.CoolPropMixture.doctree deleted file mode 100644 index 4392f9b..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.CoolPropMixture.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.FluidMaterial.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.FluidMaterial.doctree deleted file mode 100644 index 1049887..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.FluidMaterial.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.Hydrogen.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.Hydrogen.doctree deleted file mode 100644 index 8db3aa5..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.Hydrogen.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.IdealAir.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.IdealAir.doctree deleted file mode 100644 index e514e7d..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.IdealAir.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.IdealGas.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.IdealGas.doctree deleted file mode 100644 index 7858201..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.IdealGas.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.IdealH2.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.IdealH2.doctree deleted file mode 100644 index ab1aa62..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.IdealH2.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.IdealOxygen.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.IdealOxygen.doctree deleted file mode 100644 index 49605f3..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.IdealOxygen.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.IdealSteam.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.IdealSteam.doctree deleted file mode 100644 index 9c71b81..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.IdealSteam.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.Oxygen.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.Oxygen.doctree deleted file mode 100644 index 83cb9b0..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.Oxygen.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.SeaWater.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.SeaWater.doctree deleted file mode 100644 index 909f1db..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.SeaWater.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.Steam.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.Steam.doctree deleted file mode 100644 index f63772f..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.Steam.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.Water.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.Water.doctree deleted file mode 100644 index d67c0e4..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.Water.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.doctree deleted file mode 100644 index 9c39831..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.fluid_material.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.Circle.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.geometry.Circle.doctree deleted file mode 100644 index 7281e97..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.Circle.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.GeometryLog.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.geometry.GeometryLog.doctree deleted file mode 100644 index 9e2adb0..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.GeometryLog.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.HollowCircle.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.geometry.HollowCircle.doctree deleted file mode 100644 index 1bb216c..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.HollowCircle.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.ParametricSpline.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.geometry.ParametricSpline.doctree deleted file mode 100644 index 003b0e1..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.ParametricSpline.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.Profile2D.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.geometry.Profile2D.doctree deleted file mode 100644 index 83c97b2..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.Profile2D.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.Rectangle.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.geometry.Rectangle.doctree deleted file mode 100644 index bbc9962..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.Rectangle.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.ShapelySection.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.geometry.ShapelySection.doctree deleted file mode 100644 index 976afe5..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.ShapelySection.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.Triangle.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.geometry.Triangle.doctree deleted file mode 100644 index 03c9ff7..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.Triangle.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.calculate_stress.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.geometry.calculate_stress.doctree deleted file mode 100644 index 7be39d2..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.calculate_stress.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.conver_np.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.geometry.conver_np.doctree deleted file mode 100644 index de05ae1..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.conver_np.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.geometry.doctree deleted file mode 100644 index e1764b9..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.get_mesh_size.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.geometry.get_mesh_size.doctree deleted file mode 100644 index 5d97327..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.geometry.get_mesh_size.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.pipes.FlowInput.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.pipes.FlowInput.doctree deleted file mode 100644 index 09263b5..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.pipes.FlowInput.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.pipes.FlowNode.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.pipes.FlowNode.doctree deleted file mode 100644 index 6ba1c09..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.pipes.FlowNode.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.pipes.Pipe.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.pipes.Pipe.doctree deleted file mode 100644 index 66fbd50..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.pipes.Pipe.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.pipes.PipeFitting.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.pipes.PipeFitting.doctree deleted file mode 100644 index 70536b7..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.pipes.PipeFitting.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.pipes.PipeFlow.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.pipes.PipeFlow.doctree deleted file mode 100644 index 64d4d90..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.pipes.PipeFlow.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.pipes.PipeLog.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.pipes.PipeLog.doctree deleted file mode 100644 index f932422..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.pipes.PipeLog.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.pipes.PipeNode.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.pipes.PipeNode.doctree deleted file mode 100644 index 59b1b96..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.pipes.PipeNode.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.pipes.PipeSystem.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.pipes.PipeSystem.doctree deleted file mode 100644 index 8cd3226..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.pipes.PipeSystem.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.pipes.Pump.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.pipes.Pump.doctree deleted file mode 100644 index bedb085..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.pipes.Pump.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.pipes.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.pipes.doctree deleted file mode 100644 index 160c0d2..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.pipes.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.prediction.PredictionMixin.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.prediction.PredictionMixin.doctree deleted file mode 100644 index 665f400..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.prediction.PredictionMixin.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.prediction.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.prediction.doctree deleted file mode 100644 index 0fb47a6..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.prediction.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.ANSI_4130.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.ANSI_4130.doctree deleted file mode 100644 index 1cd450d..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.ANSI_4130.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.ANSI_4340.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.ANSI_4340.doctree deleted file mode 100644 index a86e70a..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.ANSI_4340.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.Aluminum.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.Aluminum.doctree deleted file mode 100644 index c643b1f..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.Aluminum.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.CarbonFiber.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.CarbonFiber.doctree deleted file mode 100644 index 135ab12..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.CarbonFiber.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.Concrete.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.Concrete.doctree deleted file mode 100644 index 3a741c2..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.Concrete.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.DrySoil.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.DrySoil.doctree deleted file mode 100644 index bfd1806..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.DrySoil.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.Rock.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.Rock.doctree deleted file mode 100644 index 4970a88..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.Rock.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.Rubber.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.Rubber.doctree deleted file mode 100644 index cf33511..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.Rubber.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.SS_316.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.SS_316.doctree deleted file mode 100644 index 9d6a60e..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.SS_316.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.SolidMaterial.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.SolidMaterial.doctree deleted file mode 100644 index 76fc98a..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.SolidMaterial.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.WetSoil.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.WetSoil.doctree deleted file mode 100644 index 8c0e566..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.WetSoil.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.doctree deleted file mode 100644 index b5d78c6..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.ih.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.ih.doctree deleted file mode 100644 index 5e71d24..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.ih.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.random_color.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.random_color.doctree deleted file mode 100644 index 7249a90..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.solid_materials.random_color.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.structure_beams.Beam.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.structure_beams.Beam.doctree deleted file mode 100644 index 2a5aa4b..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.structure_beams.Beam.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.structure_beams.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.structure_beams.doctree deleted file mode 100644 index 4bb023e..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.structure_beams.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.structure_beams.rotation_matrix_from_vectors.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.structure_beams.rotation_matrix_from_vectors.doctree deleted file mode 100644 index 5cc4770..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.structure_beams.rotation_matrix_from_vectors.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.SimpleCompressor.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.SimpleCompressor.doctree deleted file mode 100644 index c2b0720..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.SimpleCompressor.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.SimpleHeatExchanger.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.SimpleHeatExchanger.doctree deleted file mode 100644 index fed7c71..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.SimpleHeatExchanger.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.SimplePump.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.SimplePump.doctree deleted file mode 100644 index 5a62b9d..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.SimplePump.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.SimpleTurbine.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.SimpleTurbine.doctree deleted file mode 100644 index 4c4726a..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.SimpleTurbine.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.doctree deleted file mode 100644 index 5ebfc3f..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.dp_he_core.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.dp_he_core.doctree deleted file mode 100644 index 52e4dbc..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.dp_he_core.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.dp_he_entrance.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.dp_he_entrance.doctree deleted file mode 100644 index 775f45c..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.dp_he_entrance.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.dp_he_exit.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.dp_he_exit.doctree deleted file mode 100644 index 346d26a..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.dp_he_exit.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.dp_he_gas_losses.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.dp_he_gas_losses.doctree deleted file mode 100644 index 7ca3a6f..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.dp_he_gas_losses.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.fanning_friction_factor.doctree b/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.fanning_friction_factor.doctree deleted file mode 100644 index 3924e3e..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.eng.thermodynamics.fanning_friction_factor.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.engforge_attributes.AttributedBaseMixin.doctree b/docs/_build/doctrees/_autosummary/engforge.engforge_attributes.AttributedBaseMixin.doctree deleted file mode 100644 index 1cc95bf..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.engforge_attributes.AttributedBaseMixin.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.engforge_attributes.EngAttr.doctree b/docs/_build/doctrees/_autosummary/engforge.engforge_attributes.EngAttr.doctree deleted file mode 100644 index 21b4b3a..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.engforge_attributes.EngAttr.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.engforge_attributes.doctree b/docs/_build/doctrees/_autosummary/engforge.engforge_attributes.doctree deleted file mode 100644 index 2690475..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.engforge_attributes.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.engforge_attributes.get_attributes_of.doctree b/docs/_build/doctrees/_autosummary/engforge.engforge_attributes.get_attributes_of.doctree deleted file mode 100644 index 78c9fa1..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.engforge_attributes.get_attributes_of.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.env_var.EnvVariable.doctree b/docs/_build/doctrees/_autosummary/engforge.env_var.EnvVariable.doctree deleted file mode 100644 index c1d17f2..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.env_var.EnvVariable.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.env_var.doctree b/docs/_build/doctrees/_autosummary/engforge.env_var.doctree deleted file mode 100644 index 2bab2ad..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.env_var.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.env_var.parse_bool.doctree b/docs/_build/doctrees/_autosummary/engforge.env_var.parse_bool.doctree deleted file mode 100644 index 492e4d0..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.env_var.parse_bool.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.locations.client_path.doctree b/docs/_build/doctrees/_autosummary/engforge.locations.client_path.doctree deleted file mode 100644 index bfc2097..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.locations.client_path.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.locations.doctree b/docs/_build/doctrees/_autosummary/engforge.locations.doctree deleted file mode 100644 index 6636943..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.locations.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.logging.Log.doctree b/docs/_build/doctrees/_autosummary/engforge.logging.Log.doctree deleted file mode 100644 index 2a92472..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.logging.Log.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.logging.LoggingMixin.doctree b/docs/_build/doctrees/_autosummary/engforge.logging.LoggingMixin.doctree deleted file mode 100644 index e69c925..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.logging.LoggingMixin.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.logging.change_all_log_levels.doctree b/docs/_build/doctrees/_autosummary/engforge.logging.change_all_log_levels.doctree deleted file mode 100644 index ff5b071..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.logging.change_all_log_levels.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.logging.doctree b/docs/_build/doctrees/_autosummary/engforge.logging.doctree deleted file mode 100644 index d136f79..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.logging.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.patterns.InputSingletonMeta.doctree b/docs/_build/doctrees/_autosummary/engforge.patterns.InputSingletonMeta.doctree deleted file mode 100644 index e3f48c4..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.patterns.InputSingletonMeta.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.patterns.Singleton.doctree b/docs/_build/doctrees/_autosummary/engforge.patterns.Singleton.doctree deleted file mode 100644 index 1bde539..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.patterns.Singleton.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.patterns.SingletonMeta.doctree b/docs/_build/doctrees/_autosummary/engforge.patterns.SingletonMeta.doctree deleted file mode 100644 index 7eeef98..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.patterns.SingletonMeta.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.patterns.chunks.doctree b/docs/_build/doctrees/_autosummary/engforge.patterns.chunks.doctree deleted file mode 100644 index 5f44e41..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.patterns.chunks.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.patterns.doctree b/docs/_build/doctrees/_autosummary/engforge.patterns.doctree deleted file mode 100644 index 34c4092..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.patterns.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.patterns.flat2gen.doctree b/docs/_build/doctrees/_autosummary/engforge.patterns.flat2gen.doctree deleted file mode 100644 index 30c6658..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.patterns.flat2gen.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.patterns.flatten.doctree b/docs/_build/doctrees/_autosummary/engforge.patterns.flatten.doctree deleted file mode 100644 index 82cc6f8..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.patterns.flatten.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.patterns.inst_vectorize.doctree b/docs/_build/doctrees/_autosummary/engforge.patterns.inst_vectorize.doctree deleted file mode 100644 index 7988a83..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.patterns.inst_vectorize.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.patterns.singleton_meta_object.doctree b/docs/_build/doctrees/_autosummary/engforge.patterns.singleton_meta_object.doctree deleted file mode 100644 index 8d11576..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.patterns.singleton_meta_object.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.problem_context.IllegalArgument.doctree b/docs/_build/doctrees/_autosummary/engforge.problem_context.IllegalArgument.doctree deleted file mode 100644 index b9cd9eb..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.problem_context.IllegalArgument.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.problem_context.ProbLog.doctree b/docs/_build/doctrees/_autosummary/engforge.problem_context.ProbLog.doctree deleted file mode 100644 index a516ac5..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.problem_context.ProbLog.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.problem_context.Problem.doctree b/docs/_build/doctrees/_autosummary/engforge.problem_context.Problem.doctree deleted file mode 100644 index 74aaa00..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.problem_context.Problem.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.problem_context.ProblemExec.doctree b/docs/_build/doctrees/_autosummary/engforge.problem_context.ProblemExec.doctree deleted file mode 100644 index 636c53a..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.problem_context.ProblemExec.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.problem_context.ProblemExit.doctree b/docs/_build/doctrees/_autosummary/engforge.problem_context.ProblemExit.doctree deleted file mode 100644 index c0a4995..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.problem_context.ProblemExit.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.problem_context.ProblemExitAtLevel.doctree b/docs/_build/doctrees/_autosummary/engforge.problem_context.ProblemExitAtLevel.doctree deleted file mode 100644 index a0c61ef..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.problem_context.ProblemExitAtLevel.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.problem_context.doctree b/docs/_build/doctrees/_autosummary/engforge.problem_context.doctree deleted file mode 100644 index 06e9d3f..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.problem_context.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.properties.PropertyLog.doctree b/docs/_build/doctrees/_autosummary/engforge.properties.PropertyLog.doctree deleted file mode 100644 index 20c2bf1..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.properties.PropertyLog.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.properties.cache_prop.doctree b/docs/_build/doctrees/_autosummary/engforge.properties.cache_prop.doctree deleted file mode 100644 index bc30430..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.properties.cache_prop.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.properties.cached_sys_prop.doctree b/docs/_build/doctrees/_autosummary/engforge.properties.cached_sys_prop.doctree deleted file mode 100644 index 91e354b..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.properties.cached_sys_prop.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.properties.cached_system_prop.doctree b/docs/_build/doctrees/_autosummary/engforge.properties.cached_system_prop.doctree deleted file mode 100644 index 7c1c8fe..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.properties.cached_system_prop.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.properties.cached_system_property.doctree b/docs/_build/doctrees/_autosummary/engforge.properties.cached_system_property.doctree deleted file mode 100644 index 1216b59..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.properties.cached_system_property.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.properties.class_cache.doctree b/docs/_build/doctrees/_autosummary/engforge.properties.class_cache.doctree deleted file mode 100644 index 14bf04f..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.properties.class_cache.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.properties.doctree b/docs/_build/doctrees/_autosummary/engforge.properties.doctree deleted file mode 100644 index e496ce6..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.properties.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.properties.engforge_prop.doctree b/docs/_build/doctrees/_autosummary/engforge.properties.engforge_prop.doctree deleted file mode 100644 index 0ef8f76..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.properties.engforge_prop.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.properties.instance_cached.doctree b/docs/_build/doctrees/_autosummary/engforge.properties.instance_cached.doctree deleted file mode 100644 index 9ef5d32..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.properties.instance_cached.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.properties.solver_cached.doctree b/docs/_build/doctrees/_autosummary/engforge.properties.solver_cached.doctree deleted file mode 100644 index f88c043..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.properties.solver_cached.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.properties.sys_prop.doctree b/docs/_build/doctrees/_autosummary/engforge.properties.sys_prop.doctree deleted file mode 100644 index 9af6a96..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.properties.sys_prop.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.properties.system_prop.doctree b/docs/_build/doctrees/_autosummary/engforge.properties.system_prop.doctree deleted file mode 100644 index 170ee51..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.properties.system_prop.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.properties.system_property.doctree b/docs/_build/doctrees/_autosummary/engforge.properties.system_property.doctree deleted file mode 100644 index 97c0e35..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.properties.system_property.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.reporting.CSVReporter.doctree b/docs/_build/doctrees/_autosummary/engforge.reporting.CSVReporter.doctree deleted file mode 100644 index 35d1a8e..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.reporting.CSVReporter.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.reporting.DiskPlotReporter.doctree b/docs/_build/doctrees/_autosummary/engforge.reporting.DiskPlotReporter.doctree deleted file mode 100644 index 22dc8e9..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.reporting.DiskPlotReporter.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.reporting.DiskReporterMixin.doctree b/docs/_build/doctrees/_autosummary/engforge.reporting.DiskReporterMixin.doctree deleted file mode 100644 index a537910..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.reporting.DiskReporterMixin.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.reporting.ExcelReporter.doctree b/docs/_build/doctrees/_autosummary/engforge.reporting.ExcelReporter.doctree deleted file mode 100644 index 42a6fad..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.reporting.ExcelReporter.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.reporting.GdriveReporter.doctree b/docs/_build/doctrees/_autosummary/engforge.reporting.GdriveReporter.doctree deleted file mode 100644 index 7a9f1e9..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.reporting.GdriveReporter.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.reporting.GsheetsReporter.doctree b/docs/_build/doctrees/_autosummary/engforge.reporting.GsheetsReporter.doctree deleted file mode 100644 index 04bb591..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.reporting.GsheetsReporter.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.reporting.PlotReporter.doctree b/docs/_build/doctrees/_autosummary/engforge.reporting.PlotReporter.doctree deleted file mode 100644 index 145fd65..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.reporting.PlotReporter.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.reporting.Reporter.doctree b/docs/_build/doctrees/_autosummary/engforge.reporting.Reporter.doctree deleted file mode 100644 index 1025492..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.reporting.Reporter.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.reporting.TableReporter.doctree b/docs/_build/doctrees/_autosummary/engforge.reporting.TableReporter.doctree deleted file mode 100644 index b32434b..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.reporting.TableReporter.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.reporting.TemporalReporterMixin.doctree b/docs/_build/doctrees/_autosummary/engforge.reporting.TemporalReporterMixin.doctree deleted file mode 100644 index e547884..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.reporting.TemporalReporterMixin.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.reporting.doctree b/docs/_build/doctrees/_autosummary/engforge.reporting.doctree deleted file mode 100644 index d014fc3..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.reporting.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.reporting.path_exist_validator.doctree b/docs/_build/doctrees/_autosummary/engforge.reporting.path_exist_validator.doctree deleted file mode 100644 index db7560f..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.reporting.path_exist_validator.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solveable.SolvableLog.doctree b/docs/_build/doctrees/_autosummary/engforge.solveable.SolvableLog.doctree deleted file mode 100644 index 27a359a..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solveable.SolvableLog.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solveable.SolveableMixin.doctree b/docs/_build/doctrees/_autosummary/engforge.solveable.SolveableMixin.doctree deleted file mode 100644 index eac607f..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solveable.SolveableMixin.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solveable.doctree b/docs/_build/doctrees/_autosummary/engforge.solveable.doctree deleted file mode 100644 index 1eb07e3..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solveable.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solver.SolverLog.doctree b/docs/_build/doctrees/_autosummary/engforge.solver.SolverLog.doctree deleted file mode 100644 index 295edb1..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solver.SolverLog.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solver.SolverMixin.doctree b/docs/_build/doctrees/_autosummary/engforge.solver.SolverMixin.doctree deleted file mode 100644 index 17ad4f7..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solver.SolverMixin.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solver.doctree b/docs/_build/doctrees/_autosummary/engforge.solver.doctree deleted file mode 100644 index 6d7b3c7..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solver.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solver_utils.SolverUtilLog.doctree b/docs/_build/doctrees/_autosummary/engforge.solver_utils.SolverUtilLog.doctree deleted file mode 100644 index d56bc24..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solver_utils.SolverUtilLog.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solver_utils.arg_var_compare.doctree b/docs/_build/doctrees/_autosummary/engforge.solver_utils.arg_var_compare.doctree deleted file mode 100644 index e09908f..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solver_utils.arg_var_compare.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solver_utils.combo_filter.doctree b/docs/_build/doctrees/_autosummary/engforge.solver_utils.combo_filter.doctree deleted file mode 100644 index 8ed1e20..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solver_utils.combo_filter.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solver_utils.create_constraint.doctree b/docs/_build/doctrees/_autosummary/engforge.solver_utils.create_constraint.doctree deleted file mode 100644 index 480248d..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solver_utils.create_constraint.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solver_utils.doctree b/docs/_build/doctrees/_autosummary/engforge.solver_utils.doctree deleted file mode 100644 index 5b81894..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solver_utils.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solver_utils.ext_str_list.doctree b/docs/_build/doctrees/_autosummary/engforge.solver_utils.ext_str_list.doctree deleted file mode 100644 index 81b797e..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solver_utils.ext_str_list.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solver_utils.f_lin_min.doctree b/docs/_build/doctrees/_autosummary/engforge.solver_utils.f_lin_min.doctree deleted file mode 100644 index f0083a1..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solver_utils.f_lin_min.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solver_utils.filt_active.doctree b/docs/_build/doctrees/_autosummary/engforge.solver_utils.filt_active.doctree deleted file mode 100644 index c177923..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solver_utils.filt_active.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solver_utils.filter_combos.doctree b/docs/_build/doctrees/_autosummary/engforge.solver_utils.filter_combos.doctree deleted file mode 100644 index b1bea8a..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solver_utils.filter_combos.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solver_utils.filter_vals.doctree b/docs/_build/doctrees/_autosummary/engforge.solver_utils.filter_vals.doctree deleted file mode 100644 index 4f6bdcb..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solver_utils.filter_vals.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solver_utils.handle_normalize.doctree b/docs/_build/doctrees/_autosummary/engforge.solver_utils.handle_normalize.doctree deleted file mode 100644 index e1c46cd..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solver_utils.handle_normalize.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solver_utils.objectify.doctree b/docs/_build/doctrees/_autosummary/engforge.solver_utils.objectify.doctree deleted file mode 100644 index de59d2f..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solver_utils.objectify.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solver_utils.ref_to_val_constraint.doctree b/docs/_build/doctrees/_autosummary/engforge.solver_utils.ref_to_val_constraint.doctree deleted file mode 100644 index 0ff009d..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solver_utils.ref_to_val_constraint.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solver_utils.refmin_solve.doctree b/docs/_build/doctrees/_autosummary/engforge.solver_utils.refmin_solve.doctree deleted file mode 100644 index 374071e..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solver_utils.refmin_solve.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solver_utils.secondary_obj.doctree b/docs/_build/doctrees/_autosummary/engforge.solver_utils.secondary_obj.doctree deleted file mode 100644 index cedf604..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solver_utils.secondary_obj.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.solver_utils.str_list_f.doctree b/docs/_build/doctrees/_autosummary/engforge.solver_utils.str_list_f.doctree deleted file mode 100644 index ea1190e..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.solver_utils.str_list_f.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.system.System.doctree b/docs/_build/doctrees/_autosummary/engforge.system.System.doctree deleted file mode 100644 index b67dc1f..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.system.System.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.system.SystemsLog.doctree b/docs/_build/doctrees/_autosummary/engforge.system.SystemsLog.doctree deleted file mode 100644 index d7d933c..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.system.SystemsLog.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.system.doctree b/docs/_build/doctrees/_autosummary/engforge.system.doctree deleted file mode 100644 index 68fb75b..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.system.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.system_reference.Ref.doctree b/docs/_build/doctrees/_autosummary/engforge.system_reference.Ref.doctree deleted file mode 100644 index bdfdd2c..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.system_reference.Ref.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.system_reference.RefLog.doctree b/docs/_build/doctrees/_autosummary/engforge.system_reference.RefLog.doctree deleted file mode 100644 index c779d1e..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.system_reference.RefLog.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.system_reference.doctree b/docs/_build/doctrees/_autosummary/engforge.system_reference.doctree deleted file mode 100644 index 61465c7..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.system_reference.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.system_reference.eval_ref.doctree b/docs/_build/doctrees/_autosummary/engforge.system_reference.eval_ref.doctree deleted file mode 100644 index e6ca74e..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.system_reference.eval_ref.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.system_reference.maybe_attr_inst.doctree b/docs/_build/doctrees/_autosummary/engforge.system_reference.maybe_attr_inst.doctree deleted file mode 100644 index fbe0d53..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.system_reference.maybe_attr_inst.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.system_reference.maybe_ref.doctree b/docs/_build/doctrees/_autosummary/engforge.system_reference.maybe_ref.doctree deleted file mode 100644 index 4091571..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.system_reference.maybe_ref.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.system_reference.refset_get.doctree b/docs/_build/doctrees/_autosummary/engforge.system_reference.refset_get.doctree deleted file mode 100644 index bedad29..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.system_reference.refset_get.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.system_reference.refset_input.doctree b/docs/_build/doctrees/_autosummary/engforge.system_reference.refset_input.doctree deleted file mode 100644 index f18390f..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.system_reference.refset_input.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.system_reference.scale_val.doctree b/docs/_build/doctrees/_autosummary/engforge.system_reference.scale_val.doctree deleted file mode 100644 index 1484e1c..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.system_reference.scale_val.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.tabulation.TableLog.doctree b/docs/_build/doctrees/_autosummary/engforge.tabulation.TableLog.doctree deleted file mode 100644 index 30e50d2..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.tabulation.TableLog.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.tabulation.TabulationMixin.doctree b/docs/_build/doctrees/_autosummary/engforge.tabulation.TabulationMixin.doctree deleted file mode 100644 index a00a344..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.tabulation.TabulationMixin.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.tabulation.doctree b/docs/_build/doctrees/_autosummary/engforge.tabulation.doctree deleted file mode 100644 index b83d44d..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.tabulation.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.typing.NUMERIC_NAN_VALIDATOR.doctree b/docs/_build/doctrees/_autosummary/engforge.typing.NUMERIC_NAN_VALIDATOR.doctree deleted file mode 100644 index 2851e30..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.typing.NUMERIC_NAN_VALIDATOR.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.typing.NUMERIC_VALIDATOR.doctree b/docs/_build/doctrees/_autosummary/engforge.typing.NUMERIC_VALIDATOR.doctree deleted file mode 100644 index 1582341..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.typing.NUMERIC_VALIDATOR.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.typing.Options.doctree b/docs/_build/doctrees/_autosummary/engforge.typing.Options.doctree deleted file mode 100644 index 4d95ff6..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.typing.Options.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.typing.STR_VALIDATOR.doctree b/docs/_build/doctrees/_autosummary/engforge.typing.STR_VALIDATOR.doctree deleted file mode 100644 index c4d1df4..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.typing.STR_VALIDATOR.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/engforge.typing.doctree b/docs/_build/doctrees/_autosummary/engforge.typing.doctree deleted file mode 100644 index cd40de9..0000000 Binary files a/docs/_build/doctrees/_autosummary/engforge.typing.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/examples.air_filter.doctree b/docs/_build/doctrees/_autosummary/examples.air_filter.doctree deleted file mode 100644 index bb6a4fa..0000000 Binary files a/docs/_build/doctrees/_autosummary/examples.air_filter.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/examples.doctree b/docs/_build/doctrees/_autosummary/examples.doctree deleted file mode 100644 index 0f3e5a4..0000000 Binary files a/docs/_build/doctrees/_autosummary/examples.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/examples.spring_mass.doctree b/docs/_build/doctrees/_autosummary/examples.spring_mass.doctree deleted file mode 100644 index 8a9e488..0000000 Binary files a/docs/_build/doctrees/_autosummary/examples.spring_mass.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/test.doctree b/docs/_build/doctrees/_autosummary/test.doctree deleted file mode 100644 index 71aa24f..0000000 Binary files a/docs/_build/doctrees/_autosummary/test.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/test.test_airfilter.doctree b/docs/_build/doctrees/_autosummary/test.test_airfilter.doctree deleted file mode 100644 index f52d22e..0000000 Binary files a/docs/_build/doctrees/_autosummary/test.test_airfilter.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/test.test_comp_iter.doctree b/docs/_build/doctrees/_autosummary/test.test_comp_iter.doctree deleted file mode 100644 index f50c51c..0000000 Binary files a/docs/_build/doctrees/_autosummary/test.test_comp_iter.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/test.test_composition.doctree b/docs/_build/doctrees/_autosummary/test.test_composition.doctree deleted file mode 100644 index 6ae0342..0000000 Binary files a/docs/_build/doctrees/_autosummary/test.test_composition.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/test.test_costs.doctree b/docs/_build/doctrees/_autosummary/test.test_costs.doctree deleted file mode 100644 index d95d701..0000000 Binary files a/docs/_build/doctrees/_autosummary/test.test_costs.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/test.test_dynamics.doctree b/docs/_build/doctrees/_autosummary/test.test_dynamics.doctree deleted file mode 100644 index 5486af9..0000000 Binary files a/docs/_build/doctrees/_autosummary/test.test_dynamics.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/test.test_dynamics_spaces.doctree b/docs/_build/doctrees/_autosummary/test.test_dynamics_spaces.doctree deleted file mode 100644 index 6fc6f64..0000000 Binary files a/docs/_build/doctrees/_autosummary/test.test_dynamics_spaces.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/test.test_four_bar.doctree b/docs/_build/doctrees/_autosummary/test.test_four_bar.doctree deleted file mode 100644 index 70268a2..0000000 Binary files a/docs/_build/doctrees/_autosummary/test.test_four_bar.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/test.test_modules.doctree b/docs/_build/doctrees/_autosummary/test.test_modules.doctree deleted file mode 100644 index b92dcf2..0000000 Binary files a/docs/_build/doctrees/_autosummary/test.test_modules.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/test.test_performance.doctree b/docs/_build/doctrees/_autosummary/test.test_performance.doctree deleted file mode 100644 index 8ba1195..0000000 Binary files a/docs/_build/doctrees/_autosummary/test.test_performance.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/test.test_pipes.doctree b/docs/_build/doctrees/_autosummary/test.test_pipes.doctree deleted file mode 100644 index 129825f..0000000 Binary files a/docs/_build/doctrees/_autosummary/test.test_pipes.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/test.test_problem_deepscoping.doctree b/docs/_build/doctrees/_autosummary/test.test_problem_deepscoping.doctree deleted file mode 100644 index 6e8b5b5..0000000 Binary files a/docs/_build/doctrees/_autosummary/test.test_problem_deepscoping.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/test.test_slider_crank.doctree b/docs/_build/doctrees/_autosummary/test.test_slider_crank.doctree deleted file mode 100644 index a9817fc..0000000 Binary files a/docs/_build/doctrees/_autosummary/test.test_slider_crank.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/test.test_solver.doctree b/docs/_build/doctrees/_autosummary/test.test_solver.doctree deleted file mode 100644 index 07b5867..0000000 Binary files a/docs/_build/doctrees/_autosummary/test.test_solver.doctree and /dev/null differ diff --git a/docs/_build/doctrees/_autosummary/test.test_tabulation.doctree b/docs/_build/doctrees/_autosummary/test.test_tabulation.doctree deleted file mode 100644 index 6af3f3f..0000000 Binary files a/docs/_build/doctrees/_autosummary/test.test_tabulation.doctree and /dev/null differ diff --git a/docs/_build/doctrees/api.doctree b/docs/_build/doctrees/api.doctree deleted file mode 100644 index 782446f..0000000 Binary files a/docs/_build/doctrees/api.doctree and /dev/null differ diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle deleted file mode 100644 index 0336c88..0000000 Binary files a/docs/_build/doctrees/environment.pickle and /dev/null differ diff --git a/docs/_build/doctrees/examples.doctree b/docs/_build/doctrees/examples.doctree deleted file mode 100644 index 8e74301..0000000 Binary files a/docs/_build/doctrees/examples.doctree and /dev/null differ diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree deleted file mode 100644 index 2db2335..0000000 Binary files a/docs/_build/doctrees/index.doctree and /dev/null differ diff --git a/docs/_build/doctrees/tests.doctree b/docs/_build/doctrees/tests.doctree deleted file mode 100644 index 0b7aef1..0000000 Binary files a/docs/_build/doctrees/tests.doctree and /dev/null differ diff --git a/docs/_build/doctrees/tutorials.doctree b/docs/_build/doctrees/tutorials.doctree deleted file mode 100644 index 8321058..0000000 Binary files a/docs/_build/doctrees/tutorials.doctree and /dev/null differ diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo deleted file mode 100644 index bd52b16..0000000 --- a/docs/_build/html/.buildinfo +++ /dev/null @@ -1,4 +0,0 @@ -# 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: 2775d85dfe4893a50d0d0424f6349d2e -tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_build/html/_autosummary/engforge.analysis.Analysis.html b/docs/_build/html/_autosummary/engforge.analysis.Analysis.html deleted file mode 100644 index 0b07982..0000000 --- a/docs/_build/html/_autosummary/engforge.analysis.Analysis.html +++ /dev/null @@ -1,1109 +0,0 @@ - - - - - - - engforge.analysis.Analysis — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.analysis.Analysis

-
-
-class Analysis(*, name=NOTHING, system, table_reporters=NOTHING, plot_reporters=NOTHING, show_plots=True)[source]
-

Bases: Configuration, TabulationMixin, PlottingMixin, DataframeMixin

-

Analysis takes a system and many reporters, runs the system, adds its own system properties to the dataframe and post processes the results

-

make_plots() makes plots from the analysis, and stores figure -post_process() but can be overriden -report_results() writes to reporters

-

Method generated by attrs for class Analysis.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

make_plots

makes plots and traces of all on this instance, and if a system is subsystems.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_process

A user customizeable function

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

report_results

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

run

Analysis.run() passes inputs to the assigned system and saves data via the system.run(cb=callback), once complete Analysis.post_process() is run also being passed input arguments, then plots & reports are made

set_attr

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe

returns the dataframe

dataframe_constants

dataframe_variants

displayname

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

Returns the last context

log_fmt

log_level

log_on

log_silo

logger

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

stored_plots

system_id

returns an instance unique id based on id(self)

unique_hash

uploaded

system

table_reporters

plot_reporters

show_plots

name

parent

-
-
Parameters:
-
    -

  • name (str)

    • -

  • system (System)

    • -

  • table_reporters (list)

    • -

  • plot_reporters (list)

    • -

  • show_plots (bool)

    • -
-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-property dataframe
-

returns the dataframe

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

Returns the last context

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-make_plots(analysis=None, store_figures=True, pre=None)
-

makes plots and traces of all on this instance, and if a system is -subsystems. Analysis should call make plots however it can be called on a system as well -:type analysis: Analysis -:param analysis: the analysis that has triggered this plot -:param store_figure: a boolean or dict, if neither a dictionary will be created and returend from this function -:returns: the dictionary from store_figures logic

-
-
Parameters:
-
    -

  • analysis (Analysis)

    • -

  • store_figures (bool)

    • -
-
-
-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_process(*args, **kwargs)[source]
-

A user customizeable function

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-run(*args, **kwargs)[source]
-

Analysis.run() passes inputs to the assigned system and saves data via the system.run(cb=callback), once complete Analysis.post_process() is run also being passed input arguments, then plots & reports are made

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.analysis.html b/docs/_build/html/_autosummary/engforge.analysis.html deleted file mode 100644 index 4e1fab3..0000000 --- a/docs/_build/html/_autosummary/engforge.analysis.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - engforge.analysis — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.analysis
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.analysis

-

Functions

- - - - - - -

make_reporter_check

-

Classes

- - - - - - -

Analysis

Analysis takes a system and many reporters, runs the system, adds its own system properties to the dataframe and post processes the results

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.analysis.make_reporter_check.html b/docs/_build/html/_autosummary/engforge.analysis.make_reporter_check.html deleted file mode 100644 index a3a81c8..0000000 --- a/docs/_build/html/_autosummary/engforge.analysis.make_reporter_check.html +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - - engforge.analysis.make_reporter_check — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.analysis.make_reporter_check

-
-
-make_reporter_check(type_to_check)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_dynamics.IntegratorInstance.html b/docs/_build/html/_autosummary/engforge.attr_dynamics.IntegratorInstance.html deleted file mode 100644 index 2d59e1a..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_dynamics.IntegratorInstance.html +++ /dev/null @@ -1,247 +0,0 @@ - - - - - - - engforge.attr_dynamics.IntegratorInstance — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_dynamics.IntegratorInstance

-
-
-class IntegratorInstance(solver, system)[source]
-

Bases: AttributeInstance

-

A decoupled signal instance to perform operations on a system instance

-

Methods

- - - - - - - - - - - - - - - -

as_ref_dict

compile

get_alias

is_active

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

system

solver

var_ref

rate_ref

active

classname

combos

constraint_refs

constraints

current_rate

integrated

normalize

rate

rates

slvtype

var

class_attr

backref

-
-
Parameters:
-
-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_dynamics.TRANSIENT.html b/docs/_build/html/_autosummary/engforge.attr_dynamics.TRANSIENT.html deleted file mode 100644 index 3ef9c20..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_dynamics.TRANSIENT.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - engforge.attr_dynamics.TRANSIENT — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_dynamics.TRANSIENT

-
-
-TRANSIENT
-

alias of Time

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_dynamics.Time.html b/docs/_build/html/_autosummary/engforge.attr_dynamics.Time.html deleted file mode 100644 index a3db3ce..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_dynamics.Time.html +++ /dev/null @@ -1,458 +0,0 @@ - - - - - - - engforge.attr_dynamics.Time — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_dynamics.Time

-
-
-class Time(name, default, validator, repr, cmp, hash, init, inherited, metadata=None, type=None, converter=None, kw_only=False, eq=None, eq_key=None, order=None, order_key=None, on_setattr=None, alias=None)[source]
-

Bases: ATTR_BASE

-

Transient is a base class for integrators over time

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_var_constraint

adds a type constraint to the solver.

class_validate

validates onetime A method to validate the kwargs passed to the define method

collect_attr_inst

collects all the attribute instances for a system

collect_cls

collects all the attributes for a system

configure_for_system

add the config class, and perform checks with `class_validate) :returns: [optional] a dictionary of options to be used in the make_attribute method

configure_instance

validates the instance given attr's init routine

constraint_exists

check constraints on the system, return its index position if found, else None.

create_instance

Create an instance of the instance_class

define

taking a component or system class as possible input valid input is later validated as an instance of that class or subclass

define_validate

A method to validate the kwargs passed to the define method

evolve

Copy self and apply changes.

from_counting_attr

handle_instance

handles the instance, override as you wish

integrate

Defines an ODE like integrator that will be integrated over time with the defined integration rule.

make_attribute

makes an attrs.Attribute for the class

make_factory

process_combos

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

unpack_atrs

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

name

default

validator

repr

eq

eq_key

order

order_key

hash

init

metadata

type

converter

kw_only

inherited

on_setattr

alias

allow_constraint_override

attr_prefix

default_options

none_ok

template_class

mode

var

rate

constraints

config_cls

active

combos

-
-
-classmethod add_var_constraint(value, kind='min', **kwargs)[source]
-

adds a type constraint to the solver. If value is numeric it is used as a bound with scipy optimize.

-
-
Parameters:
-

type – str, must be either min or max with var value comparison, or with a function additionally eq,ineq (same as max(0)) can be used

-
-
Value:
-

either a numeric (int,float), or a function, f(system)

-
-
-
- -
-
-classmethod class_validate(instance, **kwargs)[source]
-

validates onetime A method to validate the kwargs passed to the define method

-
- -
-
-classmethod collect_attr_inst(system, handle_inst=True)
-

collects all the attribute instances for a system

-
-
Return type:
-

dict

-
-
-
- -
-
-classmethod collect_cls(system)
-

collects all the attributes for a system

-
-
Return type:
-

dict

-
-
-
- -
-
-classmethod configure_for_system(name, config_class, cb=None, **kwargs)
-

add the config class, and perform checks with `class_validate) -:returns: [optional] a dictionary of options to be used in the make_attribute method

-
- -
-
-classmethod configure_instance(instance, attribute, value)
-

validates the instance given attr’s init routine

-
- -
-
-classmethod constraint_exists(**kw)[source]
-

check constraints on the system, return its index position if found, else None.

-
- -
-
-classmethod create_instance(instance)
-

Create an instance of the instance_class

-
-
Return type:
-

AttributeInstance

-
-
Parameters:
-

instance (Configuration)

-
-
-
- -
-
-classmethod define(**kwargs)
-

taking a component or system class as possible input valid input is later validated as an instance of that class or subclass

-
- -
-
-classmethod define_validate(**kwargs)
-

A method to validate the kwargs passed to the define method

-
- -
-
-evolve(**changes)
-

Copy self and apply changes.

-

This works similarly to attrs.evolve but that function does not work -with Attribute.

-

It is mainly meant to be used for transform-fields.

-
-

Added in version 20.3.0.

-
-
- -
-
-classmethod handle_instance(canidate)
-

handles the instance, override as you wish

-
- -
-
-instance_class
-

alias of IntegratorInstance

-
- -
-
-classmethod integrate(var, rate, mode='euler', active=True, combos='default')[source]
-

Defines an ODE like integrator that will be integrated over time with the defined integration rule.

-

Input should be of strings to look up the particular property or field

-
-
Parameters:
-
-
-
-
- -
-
-classmethod make_attribute(name, comp_class, **kwargs)
-

makes an attrs.Attribute for the class

-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_dynamics.html b/docs/_build/html/_autosummary/engforge.attr_dynamics.html deleted file mode 100644 index 0ea1ae6..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_dynamics.html +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - - engforge.attr_dynamics — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.attr_dynamics
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.attr_dynamics

-

Classes

- - - - - - - - - - - - -

IntegratorInstance

A decoupled signal instance to perform operations on a system instance

TRANSIENT

alias of Time

Time

Transient is a base class for integrators over time

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_plotting.PLOT.html b/docs/_build/html/_autosummary/engforge.attr_plotting.PLOT.html deleted file mode 100644 index 2484d43..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_plotting.PLOT.html +++ /dev/null @@ -1,495 +0,0 @@ - - - - - - - engforge.attr_plotting.Plot — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_plotting.Plot

-
-
-class Plot(name, default, validator, repr, cmp, hash, init, inherited, metadata=None, type=None, converter=None, kw_only=False, eq=None, eq_key=None, order=None, order_key=None, on_setattr=None, alias=None)[source]
-

Bases: PlotBase

-

Plot is a conveinence method

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

class_validate

validates onetime A method to validate the kwargs passed to the define method

collect_attr_inst

collects all the attribute instances for a system

collect_cls

collects all the attributes for a system

configure_for_system

add the config class, and perform checks with `class_validate) :returns: [optional] a dictionary of options to be used in the make_attribute method

configure_instance

validates the instance given attr's init routine

create_instance

Create an instance of the instance_class

define

Defines a plot that will be rendered in seaborn, with validation happening as much as possible in the define method

define_validate

A method to validate the kwargs passed to the define method

evolve

Copy self and apply changes.

from_counting_attr

handle_instance

no interacion with system, reporing only

make_attribute

makes an attrs.Attribute for the class

make_factory

plot_extra

plot_vars

gathers seaborn plot vars that will scope from system.dataframe

process_combos

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

unpack_atrs

validate_plot_args

Checks system.system_references that cls.plot_vars exists

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

name

default

validator

repr

eq

eq_key

order

order_key

hash

init

metadata

type

converter

kw_only

inherited

on_setattr

alias

attr_prefix

cls_vars

default_options

none_ok

std_fields

template_class

title

type_var_options

types

kind

x

y

hue

col

row

plot_func

plot_args

config_cls

active

combos

-
-
-classmethod class_validate(instance, **kwargs)
-

validates onetime A method to validate the kwargs passed to the define method

-
- -
-
-classmethod collect_attr_inst(system, handle_inst=True)
-

collects all the attribute instances for a system

-
-
Return type:
-

dict

-
-
-
- -
-
-classmethod collect_cls(system)
-

collects all the attributes for a system

-
-
Return type:
-

dict

-
-
-
- -
-
-classmethod configure_for_system(name, config_class, cb=None, **kwargs)
-

add the config class, and perform checks with `class_validate) -:returns: [optional] a dictionary of options to be used in the make_attribute method

-
- -
-
-classmethod configure_instance(instance, attribute, value)
-

validates the instance given attr’s init routine

-
- -
-
-classmethod create_instance(system)
-

Create an instance of the instance_class

-
-
Return type:
-

PlotInstance

-
-
Parameters:
-

system (System)

-
-
-
- -
-
-classmethod define(x, y, _type='relplot', kind='scatterplot', row=None, col=None, hue=None, **kwargs)[source]
-

Defines a plot that will be rendered in seaborn, with validation happening as much as possible in the define method

-

#Plot Choice -:type _type: -:param _type: the type of seaborn plot (relplot,displot,catplot) -:type kind: -:param kind: specify the kind of type of plot (ie. scatterplot of relplot)

-

# Dependents & Independents: -:type x: -:param x: the x var for each plot -:type y: -:param y: the y var for each plot

-

# Additional Parameters: -:type row: -:param row: create a grid of data with row var -:type col: -:param col: create a grid of data with column var -:type hue: -:param hue: provide an additional dimension of color based on this var -:param title: this title will be applied to the figure.suptitle()

-
- -
-
-classmethod define_validate(**kwargs)
-

A method to validate the kwargs passed to the define method

-
- -
-
-evolve(**changes)
-

Copy self and apply changes.

-

This works similarly to attrs.evolve but that function does not work -with Attribute.

-

It is mainly meant to be used for transform-fields.

-
-

Added in version 20.3.0.

-
-
- -
-
-classmethod handle_instance(canidate)
-

no interacion with system, reporing only

-
- -
-
-instance_class
-

alias of PlotInstance

-
- -
-
-classmethod make_attribute(name, comp_class, **kwargs)
-

makes an attrs.Attribute for the class

-
- -
-
-classmethod plot_vars()[source]
-

gathers seaborn plot vars that will scope from system.dataframe

-
-
Return type:
-

dict

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod validate_plot_args(system)
-

Checks system.system_references that cls.plot_vars exists

-
-
Parameters:
-

system (System)

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_plotting.PlotBase.html b/docs/_build/html/_autosummary/engforge.attr_plotting.PlotBase.html deleted file mode 100644 index 0e555aa..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_plotting.PlotBase.html +++ /dev/null @@ -1,447 +0,0 @@ - - - - - - - engforge.attr_plotting.PlotBase — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_plotting.PlotBase

-
-
-class PlotBase(name, default, validator, repr, cmp, hash, init, inherited, metadata=None, type=None, converter=None, kw_only=False, eq=None, eq_key=None, order=None, order_key=None, on_setattr=None, alias=None)[source]
-

Bases: ATTR_BASE

-

base class for plot attributes

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

class_validate

validates onetime A method to validate the kwargs passed to the define method

collect_attr_inst

collects all the attribute instances for a system

collect_cls

collects all the attributes for a system

configure_for_system

add the config class, and perform checks with `class_validate) :returns: [optional] a dictionary of options to be used in the make_attribute method

configure_instance

validates the instance given attr's init routine

create_instance

Create an instance of the instance_class

define

taking a component or system class as possible input valid input is later validated as an instance of that class or subclass

define_validate

A method to validate the kwargs passed to the define method

evolve

Copy self and apply changes.

from_counting_attr

handle_instance

no interacion with system, reporing only

make_attribute

makes an attrs.Attribute for the class

make_factory

plot_extra

plot_vars

gathers seaborn plot vars that will scope from system.dataframe

process_combos

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

unpack_atrs

validate_plot_args

Checks system.system_references that cls.plot_vars exists

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

name

default

validator

repr

eq

eq_key

order

order_key

hash

init

metadata

type

converter

kw_only

inherited

on_setattr

alias

attr_prefix

cls_vars

default_options

none_ok

template_class

title

config_cls

kind

active

combos

-
-
-classmethod class_validate(instance, **kwargs)
-

validates onetime A method to validate the kwargs passed to the define method

-
- -
-
-classmethod collect_attr_inst(system, handle_inst=True)
-

collects all the attribute instances for a system

-
-
Return type:
-

dict

-
-
-
- -
-
-classmethod collect_cls(system)
-

collects all the attributes for a system

-
-
Return type:
-

dict

-
-
-
- -
-
-classmethod configure_for_system(name, config_class, cb=None, **kwargs)
-

add the config class, and perform checks with `class_validate) -:returns: [optional] a dictionary of options to be used in the make_attribute method

-
- -
-
-classmethod configure_instance(instance, attribute, value)
-

validates the instance given attr’s init routine

-
- -
-
-classmethod create_instance(system)[source]
-

Create an instance of the instance_class

-
-
Return type:
-

PlotInstance

-
-
Parameters:
-

system (System)

-
-
-
- -
-
-classmethod define(**kwargs)
-

taking a component or system class as possible input valid input is later validated as an instance of that class or subclass

-
- -
-
-classmethod define_validate(**kwargs)
-

A method to validate the kwargs passed to the define method

-
- -
-
-evolve(**changes)
-

Copy self and apply changes.

-

This works similarly to attrs.evolve but that function does not work -with Attribute.

-

It is mainly meant to be used for transform-fields.

-
-

Added in version 20.3.0.

-
-
- -
-
-classmethod handle_instance(canidate)[source]
-

no interacion with system, reporing only

-
- -
-
-instance_class
-

alias of PlotInstance

-
- -
-
-classmethod make_attribute(name, comp_class, **kwargs)
-

makes an attrs.Attribute for the class

-
- -
-
-classmethod plot_vars()[source]
-

gathers seaborn plot vars that will scope from system.dataframe

-
-
Return type:
-

dict

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod validate_plot_args(system)[source]
-

Checks system.system_references that cls.plot_vars exists

-
-
Parameters:
-

system (System)

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_plotting.PlotInstance.html b/docs/_build/html/_autosummary/engforge.attr_plotting.PlotInstance.html deleted file mode 100644 index 845c10a..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_plotting.PlotInstance.html +++ /dev/null @@ -1,248 +0,0 @@ - - - - - - - engforge.attr_plotting.PlotInstance — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_plotting.PlotInstance

-
-
-class PlotInstance(system, plot_cls)[source]
-

Bases: AttributeInstance

-

combine plotclass vars with system info

-

Methods

- - - - - - - - - - - - - - - - - - - - - -

as_ref_dict

compile

get_alias

is_active

plot

applies the system dataframe to the plot

process_fig

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

active

classname

combos

identity

refs

plot_cls

system

class_attr

backref

-
-
Parameters:
-
-
-
-
-
-__call__(**override_kw)[source]
-

method allowing a similar type.kind(**override_kw,**default) (ie. relplot.scatterplot(x=different var)) -#TODO: override strategy

-
- -
-
-plot(**kwargs)[source]
-

applies the system dataframe to the plot

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_plotting.PlotLog.html b/docs/_build/html/_autosummary/engforge.attr_plotting.PlotLog.html deleted file mode 100644 index 2474ad4..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_plotting.PlotLog.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - engforge.attr_plotting.PlotLog — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_plotting.PlotLog

-
-
-class PlotLog(name='')[source]
-

Bases: LoggingMixin

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_plotting.PlottingMixin.html b/docs/_build/html/_autosummary/engforge.attr_plotting.PlottingMixin.html deleted file mode 100644 index e9bfb0e..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_plotting.PlottingMixin.html +++ /dev/null @@ -1,207 +0,0 @@ - - - - - - - engforge.attr_plotting.PlottingMixin — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_plotting.PlottingMixin

-
-
-class PlottingMixin[source]
-

Bases: object

-

Inherited by Systems and Analyses to provide common interface for plotting

-

Methods

- - - - - - -

make_plots

makes plots and traces of all on this instance, and if a system is subsystems.

-

Attributes

- - - - - - -

stored_plots

-
-
-make_plots(analysis=None, store_figures=True, pre=None)[source]
-

makes plots and traces of all on this instance, and if a system is -subsystems. Analysis should call make plots however it can be called on a system as well -:type analysis: Analysis -:param analysis: the analysis that has triggered this plot -:param store_figure: a boolean or dict, if neither a dictionary will be created and returend from this function -:returns: the dictionary from store_figures logic

-
-
Parameters:
-
    -

  • analysis (Analysis)

    • -

  • store_figures (bool)

    • -
-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_plotting.Trace.html b/docs/_build/html/_autosummary/engforge.attr_plotting.Trace.html deleted file mode 100644 index 8bcdc9f..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_plotting.Trace.html +++ /dev/null @@ -1,503 +0,0 @@ - - - - - - - engforge.attr_plotting.Trace — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_plotting.Trace

-
-
-class Trace(name, default, validator, repr, cmp, hash, init, inherited, metadata=None, type=None, converter=None, kw_only=False, eq=None, eq_key=None, order=None, order_key=None, on_setattr=None, alias=None)[source]
-

Bases: PlotBase

-

trace is a plot for transients, with y and y2 axes which can have multiple vars each

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

class_validate

validates onetime A method to validate the kwargs passed to the define method

collect_attr_inst

collects all the attribute instances for a system

collect_cls

collects all the attributes for a system

configure_for_system

add the config class, and perform checks with `class_validate) :returns: [optional] a dictionary of options to be used in the make_attribute method

configure_instance

validates the instance given attr's init routine

create_instance

Create an instance of the instance_class

define

Defines a plot that will be matplotlib, with validation happening as much as possible in the define method

define_validate

A method to validate the kwargs passed to the define method

evolve

Copy self and apply changes.

from_counting_attr

handle_instance

no interacion with system, reporing only

make_attribute

makes an attrs.Attribute for the class

make_factory

plot_extra

plot_vars

gathers seaborn plot vars that will scope from system.dataframe

process_combos

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

unpack_atrs

valid_non_vars

valid_vars_options

validate_plot_args

Checks system.system_references that cls.plot_vars exists

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

name

default

validator

repr

eq

eq_key

order

order_key

hash

init

metadata

type

converter

kw_only

inherited

on_setattr

alias

all_options

always

attr_prefix

cls_vars

default_options

none_ok

template_class

title

type_options

type_var_options

types

y2

y

x

plot_args

extra_args

config_cls

kind

active

combos

-
-
-classmethod class_validate(instance, **kwargs)
-

validates onetime A method to validate the kwargs passed to the define method

-
- -
-
-classmethod collect_attr_inst(system, handle_inst=True)
-

collects all the attribute instances for a system

-
-
Return type:
-

dict

-
-
-
- -
-
-classmethod collect_cls(system)
-

collects all the attributes for a system

-
-
Return type:
-

dict

-
-
-
- -
-
-classmethod configure_for_system(name, config_class, cb=None, **kwargs)
-

add the config class, and perform checks with `class_validate) -:returns: [optional] a dictionary of options to be used in the make_attribute method

-
- -
-
-classmethod configure_instance(instance, attribute, value)
-

validates the instance given attr’s init routine

-
- -
-
-classmethod create_instance(system)
-

Create an instance of the instance_class

-
-
Return type:
-

PlotInstance

-
-
Parameters:
-

system (System)

-
-
-
- -
-
-classmethod define(x='time', y=None, y2=None, kind='line', **kwargs)[source]
-

Defines a plot that will be matplotlib, with validation happening as much as possible in the define method

-

#Plot Choice -:type kind: -:param kind: specify the kind of type of plot scatter or line, with the default being line

-

# Dependents & Independents: -:type x: -:param x: the x var for each plot, by default ‘time’ -:type y: Union[str, list, None] -:param y: the y var for each plot, required -:type y2: -:param y2: the y2 var for each plot, optional

-

# Additional Parameters: -:param title: this title will be applied to the figure.suptitle() -:param xlabel: the x label, by default the capitalized var -:param ylabel: the x label, by default the capitalized var -:param y2label: the x label, by default the capitalized var

-
-
Parameters:
-

y (str | list | None)

-
-
-
- -
-
-classmethod define_validate(**kwargs)
-

A method to validate the kwargs passed to the define method

-
- -
-
-evolve(**changes)
-

Copy self and apply changes.

-

This works similarly to attrs.evolve but that function does not work -with Attribute.

-

It is mainly meant to be used for transform-fields.

-
-

Added in version 20.3.0.

-
-
- -
-
-classmethod handle_instance(canidate)
-

no interacion with system, reporing only

-
- -
-
-instance_class
-

alias of TraceInstance

-
- -
-
-classmethod make_attribute(name, comp_class, **kwargs)
-

makes an attrs.Attribute for the class

-
- -
-
-classmethod plot_vars()[source]
-

gathers seaborn plot vars that will scope from system.dataframe

-
-
Return type:
-

set

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod validate_plot_args(system)
-

Checks system.system_references that cls.plot_vars exists

-
-
Parameters:
-

system (System)

-
-
-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_plotting.TraceInstance.html b/docs/_build/html/_autosummary/engforge.attr_plotting.TraceInstance.html deleted file mode 100644 index 3b08bde..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_plotting.TraceInstance.html +++ /dev/null @@ -1,250 +0,0 @@ - - - - - - - engforge.attr_plotting.TraceInstance — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_plotting.TraceInstance

-
-
-class TraceInstance(system, plot_cls)[source]
-

Bases: PlotInstance

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - -

as_ref_dict

compile

get_alias

is_active

plot

applies the system dataframe to the plot

plot_extra

process_fig

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

active

classname

combos

identity

refs

plot_cls

system

class_attr

backref

-
-
Parameters:
-
-
-
-
-
-__call__(**override_kw)[source]
-

method allowing a similar type.kind(**override_kw,**default) (ie. relplot.scatterplot(x=different var)) -#TODO: override strategy

-
- -
-
-plot(**kwargs)
-

applies the system dataframe to the plot

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_plotting.conv_ctx.html b/docs/_build/html/_autosummary/engforge.attr_plotting.conv_ctx.html deleted file mode 100644 index 19dc77a..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_plotting.conv_ctx.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - engforge.attr_plotting.conv_ctx — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_plotting.conv_ctx

-
-
-conv_ctx(ctx)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_plotting.conv_maps.html b/docs/_build/html/_autosummary/engforge.attr_plotting.conv_maps.html deleted file mode 100644 index 46cf75d..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_plotting.conv_maps.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - engforge.attr_plotting.conv_maps — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_plotting.conv_maps

-
-
-conv_maps(map)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_plotting.conv_theme.html b/docs/_build/html/_autosummary/engforge.attr_plotting.conv_theme.html deleted file mode 100644 index f7baf10..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_plotting.conv_theme.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - engforge.attr_plotting.conv_theme — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_plotting.conv_theme

-
-
-conv_theme(theme)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_plotting.html b/docs/_build/html/_autosummary/engforge.attr_plotting.html deleted file mode 100644 index 91edd24..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_plotting.html +++ /dev/null @@ -1,211 +0,0 @@ - - - - - - - engforge.attr_plotting — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.attr_plotting
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.attr_plotting

-

This module defines Plot and Trace methods that allow the plotting of Statistical & Transient relationships of data in each system

-

Functions

- - - - - - - - - - - - - - - - - - -

conv_ctx

conv_maps

conv_theme

install_seaborn

save_all_figures_to_pdf

Save all figures to a PDF file.

-

Classes

- - - - - - - - - - - - - - - - - - - - - - - - - - - -

PLOT

alias of Plot

Plot

Plot is a conveinence method

PlotBase

base class for plot attributes

PlotInstance

combine plotclass vars with system info

PlotLog

Initialize a filter.

PlottingMixin

Inherited by Systems and Analyses to provide common interface for plotting

Trace

trace is a plot for transients, with y and y2 axes which can have multiple vars each

TraceInstance

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_plotting.install_seaborn.html b/docs/_build/html/_autosummary/engforge.attr_plotting.install_seaborn.html deleted file mode 100644 index 4a33ae3..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_plotting.install_seaborn.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - engforge.attr_plotting.install_seaborn — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_plotting.install_seaborn

-
-
-install_seaborn(rc_override=None, **kwargs)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_plotting.save_all_figures_to_pdf.html b/docs/_build/html/_autosummary/engforge.attr_plotting.save_all_figures_to_pdf.html deleted file mode 100644 index c38d80c..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_plotting.save_all_figures_to_pdf.html +++ /dev/null @@ -1,189 +0,0 @@ - - - - - - - engforge.attr_plotting.save_all_figures_to_pdf — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_plotting.save_all_figures_to_pdf

-
-
-save_all_figures_to_pdf(filename, figs=None, dpi=200, close=True, pdf=None, return_pdf=False)[source]
-

Save all figures to a PDF file.

-
-
Parameters:
-
    -

  • filename – The name of the PDF file to save.

    • -

  • figs – List of figures to save. If None, all open figures will be saved.

    • -

  • dpi – The resolution of the saved figures in dots per inch.

    • -

  • close – Whether to close all figures after saving.

    • -

  • pdf – An existing PdfPages object to append the figures to. If None, a new PdfPages object will be created.

    • -

  • return_pdf – Whether to return the PdfPages object after saving.

    • -
-
-
Returns:
-

The PdfPages object if return_pdf is True, else None.

-
-
Return type:
-

PdfPages or None

-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_signals.Signal.html b/docs/_build/html/_autosummary/engforge.attr_signals.Signal.html deleted file mode 100644 index 606e2ba..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_signals.Signal.html +++ /dev/null @@ -1,414 +0,0 @@ - - - - - - - engforge.attr_signals.Signal — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_signals.Signal

-
-
-class Signal(name, default, validator, repr, cmp, hash, init, inherited, metadata=None, type=None, converter=None, kw_only=False, eq=None, eq_key=None, order=None, order_key=None, on_setattr=None, alias=None)[source]
-

Bases: ATTR_BASE

-

A base class that handles initalization in the attrs meta class scheme by ultimately createing a SignalInstance

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

class_validate

validates onetime A method to validate the kwargs passed to the define method

collect_attr_inst

collects all the attribute instances for a system

collect_cls

collects all the attributes for a system

configure_for_system

add the config class, and perform checks with `class_validate) :returns: [optional] a dictionary of options to be used in the make_attribute method

configure_instance

validates the instance given attr's init routine

create_instance

Create an instance of the instance_class

define

taking a component or system class as possible input valid input is later validated as an instance of that class or subclass

define_validate

A method to validate the kwargs passed to the define method

evolve

Copy self and apply changes.

from_counting_attr

handle_instance

handles the instance, override as you wish

make_attribute

makes an attrs.Attribute for the class

make_factory

process_combos

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

unpack_atrs

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

name

default

validator

repr

eq

eq_key

order

order_key

hash

init

metadata

type

converter

kw_only

inherited

on_setattr

alias

attr_prefix

default_options

none_ok

template_class

mode

target

source

config_cls

active

combos

-
-
-classmethod class_validate(instance, **kwargs)[source]
-

validates onetime A method to validate the kwargs passed to the define method

-
- -
-
-classmethod collect_attr_inst(system, handle_inst=True)
-

collects all the attribute instances for a system

-
-
Return type:
-

dict

-
-
-
- -
-
-classmethod collect_cls(system)
-

collects all the attributes for a system

-
-
Return type:
-

dict

-
-
-
- -
-
-classmethod configure_for_system(name, config_class, cb=None, **kwargs)
-

add the config class, and perform checks with `class_validate) -:returns: [optional] a dictionary of options to be used in the make_attribute method

-
- -
-
-classmethod configure_instance(instance, attribute, value)
-

validates the instance given attr’s init routine

-
- -
-
-classmethod create_instance(instance)
-

Create an instance of the instance_class

-
-
Return type:
-

AttributeInstance

-
-
Parameters:
-

instance (Configuration)

-
-
-
- -
-
-classmethod define(target, source, mode='pre', **kw)[source]
-

taking a component or system class as possible input valid input is later validated as an instance of that class or subclass

-
-
Parameters:
-
    -

  • target (str)

    • -

  • source (str)

    • -
-
-
-
- -
-
-classmethod define_validate(**kwargs)
-

A method to validate the kwargs passed to the define method

-
- -
-
-evolve(**changes)
-

Copy self and apply changes.

-

This works similarly to attrs.evolve but that function does not work -with Attribute.

-

It is mainly meant to be used for transform-fields.

-
-

Added in version 20.3.0.

-
-
- -
-
-classmethod handle_instance(canidate)
-

handles the instance, override as you wish

-
- -
-
-instance_class
-

alias of SignalInstance

-
- -
-
-classmethod make_attribute(name, comp_class, **kwargs)
-

makes an attrs.Attribute for the class

-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_signals.SignalInstance.html b/docs/_build/html/_autosummary/engforge.attr_signals.SignalInstance.html deleted file mode 100644 index ea1ecac..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_signals.SignalInstance.html +++ /dev/null @@ -1,225 +0,0 @@ - - - - - - - engforge.attr_signals.SignalInstance — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_signals.SignalInstance

-
-
-class SignalInstance(signal, system)[source]
-

Bases: AttributeInstance

-

A decoupled signal instance to perform operations on a system instance

-

Methods

- - - - - - - - - - - - - - - - - - -

apply

sets target from source

as_ref_dict

compile

get_alias

is_active

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

active

classname

combos

mode

system

signal

target

source

class_attr

backref

-
-
-
-
-apply()[source]
-

sets target from source

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_signals.html b/docs/_build/html/_autosummary/engforge.attr_signals.html deleted file mode 100644 index 0ef2a72..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_signals.html +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - - engforge.attr_signals — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.attr_signals
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.attr_signals

-

This module defines the slot attrs attribute to define the update behavior of a component or between components in an analysis

-

Classes

- - - - - - - - - -

Signal

A base class that handles initalization in the attrs meta class scheme by ultimately createing a SignalInstance

SignalInstance

A decoupled signal instance to perform operations on a system instance

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_slots.Slot.html b/docs/_build/html/_autosummary/engforge.attr_slots.Slot.html deleted file mode 100644 index c78ec8d..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_slots.Slot.html +++ /dev/null @@ -1,444 +0,0 @@ - - - - - - - engforge.attr_slots.Slot — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_slots.Slot

-
-
-class Slot(name, default, validator, repr, cmp, hash, init, inherited, metadata=None, type=None, converter=None, kw_only=False, eq=None, eq_key=None, order=None, order_key=None, on_setattr=None, alias=None)[source]
-

Bases: ATTR_BASE

-

Slot defines a way to accept different components or systems in a system

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

class_validate

validates onetime A method to validate the kwargs passed to the define method

collect_attr_inst

collects all the attribute instances for a system

collect_cls

collects all the attributes for a system

configure_for_system

add the config class, and perform checks with `class_validate) :returns: [optional] a dictionary of options to be used in the make_attribute method

configure_instance

validates the instance given attr's init routine

create_instance

Create an instance of the instance_class

define

taking a component or system class as possible input valid input is later validated as an instance of that class or subclass

define_iterator

taking a type of component iterator, defines an interface that can be 'wide' where all items are executed in the same row on System.run().

define_validate

A method to validate the kwargs passed to the define method

evolve

Copy self and apply changes.

from_counting_attr

handle_instance

a passthrough

make_accepted

make_attribute

makes an attrs.Attribute for the class

make_factory

process_combos

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

unpack_atrs

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

name

default

validator

repr

eq

eq_key

order

order_key

hash

init

metadata

type

converter

kw_only

inherited

on_setattr

alias

attr_prefix

default_ok

default_options

dflt_kw

instance_class

none_ok

template_class

accepted

config_cls

is_iter

wide

active

combos

-
-
-classmethod class_validate(instance, **kwargs)
-

validates onetime A method to validate the kwargs passed to the define method

-
- -
-
-classmethod collect_attr_inst(system, handle_inst=True)
-

collects all the attribute instances for a system

-
-
Return type:
-

dict

-
-
-
- -
-
-classmethod collect_cls(system)
-

collects all the attributes for a system

-
-
Return type:
-

dict

-
-
-
- -
-
-classmethod configure_for_system(name, config_class, cb=None, **kwargs)
-

add the config class, and perform checks with `class_validate) -:returns: [optional] a dictionary of options to be used in the make_attribute method

-
- -
-
-classmethod configure_instance(instance, attribute, value)[source]
-

validates the instance given attr’s init routine

-
- -
-
-classmethod create_instance(instance)
-

Create an instance of the instance_class

-
-
Return type:
-

AttributeInstance

-
-
Parameters:
-

instance (Configuration)

-
-
-
- -
-
-classmethod define(*component_or_systems, none_ok=False, default_ok=True, dflt_kw=None)[source]
-

taking a component or system class as possible input valid input is later validated as an instance of that class or subclass

-
-
Parameters:
-
    -

  • none_ok – will allow no component on that item, oterwise will fail

    • -

  • default_ok – will create the slot class with no input if true

    • -

  • dflt_kw (dict) – a dictionary of input in factory for custom inits overrides defaults_ok

    • -

  • component_or_systems (Component | System)

    • -
-
-
-

#TODO: add default_args,default_kwargs

-
- -
-
-classmethod define_iterator(*component_or_systems, none_ok=False, default_ok=True, wide=True, dflt_kw=None)[source]
-

taking a type of component iterator, defines an interface that can be ‘wide’ where all items are executed in the same row on System.run().

-

Conversely if wide is false the system will loop over each item as if it was included in System.run(). Multiple ComponentIterators with wide=False will result in a outer join of the items.

-
-
Parameters:
-
    -

  • none_ok (bool) – will allow no component on that item, otherwise will fail

    • -

  • default_ok (bool) – will create the slot class with no input if true

    • -

  • dflt_kw (dict) – a dictionary of input in factory for custom inits

    • -

  • wide (bool) – default is true, will determine if wide dataframe format, or outerproduct format when System.run() is called

    • -

  • component_or_systems (ComponentIterator)

    • -
-
-
-
- -
-
-classmethod define_validate(**kwargs)
-

A method to validate the kwargs passed to the define method

-
- -
-
-evolve(**changes)
-

Copy self and apply changes.

-

This works similarly to attrs.evolve but that function does not work -with Attribute.

-

It is mainly meant to be used for transform-fields.

-
-

Added in version 20.3.0.

-
-
- -
-
-classmethod handle_instance(canidate)[source]
-

a passthrough

-
- -
-
-classmethod make_attribute(name, comp_class, **kwargs)
-

makes an attrs.Attribute for the class

-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_slots.SlotLog.html b/docs/_build/html/_autosummary/engforge.attr_slots.SlotLog.html deleted file mode 100644 index ecbefc8..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_slots.SlotLog.html +++ /dev/null @@ -1,322 +0,0 @@ - - - - - - - engforge.attr_slots.SlotLog — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_slots.SlotLog

-
-
-class SlotLog(name='')[source]
-

Bases: LoggingMixin

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_slots.html b/docs/_build/html/_autosummary/engforge.attr_slots.html deleted file mode 100644 index d15bdf8..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_slots.html +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - - engforge.attr_slots — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.attr_slots
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.attr_slots

-

This module defines the slot attrs attribute to ensure the type of component added is correct and to define behavior,defaults and argument passing behavio

-

Classes

- - - - - - - - - -

Slot

Slot defines a way to accept different components or systems in a system

SlotLog

Initialize a filter.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_solver.AttrSolverLog.html b/docs/_build/html/_autosummary/engforge.attr_solver.AttrSolverLog.html deleted file mode 100644 index 2e01fbe..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_solver.AttrSolverLog.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - - - - engforge.attr_solver.AttrSolverLog — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_solver.AttrSolverLog

-
-
-class AttrSolverLog(name='')[source]
-

Bases: LoggingMixin

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_solver.Solver.html b/docs/_build/html/_autosummary/engforge.attr_solver.Solver.html deleted file mode 100644 index bb91a7e..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_solver.Solver.html +++ /dev/null @@ -1,584 +0,0 @@ - - - - - - - engforge.attr_solver.Solver — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_solver.Solver

-
-
-class Solver(name, default, validator, repr, cmp, hash, init, inherited, metadata=None, type=None, converter=None, kw_only=False, eq=None, eq_key=None, order=None, order_key=None, on_setattr=None, alias=None)[source]
-

Bases: ATTR_BASE

-

solver creates subclasses per solver balance

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_var_constraint

adds a type constraint to the solver.

class_validate

validates onetime A method to validate the kwargs passed to the define method

collect_attr_inst

collects all the attribute instances for a system

collect_cls

collects all the attributes for a system

con_eq

Defines an equality constraint based on a required lhs of equation, and an optional rhs, the difference of which will be driven to zero

con_ineq

Defines an inequality constraint

configure_for_system

add the config class, and perform checks with `class_validate) :returns: [optional] a dictionary of options to be used in the make_attribute method

configure_instance

validates the instance given attr's init routine

constraint_equality

Defines an equality constraint based on a required lhs of equation, and an optional rhs, the difference of which will be driven to zero

constraint_exists

check constraints on the system, return its index position if found, else None.

constraint_inequality

Defines an inequality constraint

create_instance

Create an instance of the instance_class

declare_var

Defines a solver variable for optimization in the class, constraints defined on this solver will correspond to the limits of that variable :type var: str :param var: The var attribute for the solver variable.

define_validate

A method to validate the kwargs passed to the define method

evolve

Copy self and apply changes.

from_counting_attr

handle_instance

handles the instance, override as you wish

make_attribute

makes an attrs.Attribute for the class

make_factory

obj

Defines a solver variable for optimization in the class, constraints defined on this solver will correspond to the limits of that variable

objective

Defines a solver variable for optimization in the class, constraints defined on this solver will correspond to the limits of that variable

process_combos

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

unpack_atrs

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

name

default

validator

repr

eq

eq_key

order

order_key

hash

init

metadata

type

converter

kw_only

inherited

on_setattr

alias

allow_constraint_override

attr_prefix

combos

default_options

define

lhs

none_ok

rhs

template_class

var

slvtype

constraints

normalize

active

config_cls

-
-
-classmethod add_var_constraint(value, kind='min', **kwargs)[source]
-

adds a type constraint to the solver. If value is numeric it is used as a bound with scipy optimize.

-
-
If value is a function it should be of the form value(Xarray) and will establish an inequality constraint that var var must be:
    -

  1. less than for max

    2. -

  2. more than for min

    3. -
-
-
-

During the evaluation of the limit function system.X should be set, and pre_execute() have already run.

-
-
Parameters:
-

type – str, must be either min or max with var value comparison, or with a function additionally eq,ineq (same as max(0)) can be used

-
-
Value:
-

either a numeric (int,float), or a function, f(system)

-
-
-
- -
-
-classmethod class_validate(instance, **kwargs)[source]
-

validates onetime A method to validate the kwargs passed to the define method

-
- -
-
-classmethod collect_attr_inst(system, handle_inst=True)
-

collects all the attribute instances for a system

-
-
Return type:
-

dict

-
-
-
- -
-
-classmethod collect_cls(system)
-

collects all the attributes for a system

-
-
Return type:
-

dict

-
-
-
- -
-
-classmethod con_eq(lhs, rhs=0, **kwargs)
-

Defines an equality constraint based on a required lhs of equation, and an optional rhs, the difference of which will be driven to zero

-
-
Parameters:
-
-
-
-
- -
-
-classmethod con_ineq(lhs, rhs=0, **kwargs)
-

Defines an inequality constraint

-
-
Parameters:
-
-
-
-
- -
-
-classmethod configure_for_system(name, config_class, cb=None, **kwargs)[source]
-

add the config class, and perform checks with `class_validate) -:returns: [optional] a dictionary of options to be used in the make_attribute method

-
- -
-
-classmethod configure_instance(instance, attribute, value)
-

validates the instance given attr’s init routine

-
- -
-
-classmethod constraint_equality(lhs, rhs=0, **kwargs)[source]
-

Defines an equality constraint based on a required lhs of equation, and an optional rhs, the difference of which will be driven to zero

-
-
Parameters:
-
-
-
-
- -
-
-classmethod constraint_exists(**kw)[source]
-

check constraints on the system, return its index position if found, else None.

-
- -
-
-classmethod constraint_inequality(lhs, rhs=0, **kwargs)[source]
-

Defines an inequality constraint

-
-
Parameters:
-
-
-
-
- -
-
-classmethod create_instance(system)[source]
-

Create an instance of the instance_class

-
-
Return type:
-

SolverInstance

-
-
Parameters:
-

system (System)

-
-
-
- -
-
-classmethod declare_var(var, **kwargs)[source]
-

Defines a solver variable for optimization in the class, constraints defined on this solver will correspond to the limits of that variable -:type var: str -:param var: The var attribute for the solver variable. -:param combos: The combinations of the solver variable. -:return: The setup class for the solver variable.

-
-
Parameters:
-

var (str)

-
-
-
- -
-
-define = None
-
- -
-
-classmethod define_validate(**kwargs)
-

A method to validate the kwargs passed to the define method

-
- -
-
-evolve(**changes)
-

Copy self and apply changes.

-

This works similarly to attrs.evolve but that function does not work -with Attribute.

-

It is mainly meant to be used for transform-fields.

-
-

Added in version 20.3.0.

-
-
- -
-
-classmethod handle_instance(canidate)
-

handles the instance, override as you wish

-
- -
-
-instance_class
-

alias of SolverInstance

-
- -
-
-classmethod make_attribute(name, comp_class, **kwargs)
-

makes an attrs.Attribute for the class

-
- -
-
-classmethod obj(obj, **kwargs)
-

Defines a solver variable for optimization in the class, constraints defined on this solver will correspond to the limits of that variable

-
-
Parameters:
-
    -

  • obj (str) – The var attribute for the solver variable.

    • -

  • combos – The combinations of the solver variable.

    • -
-
-
Vara kind:
-

the kind of optimization, either min or max

-
-
Returns:
-

The setup class for the solver variable.

-
-
-
- -
-
-classmethod objective(obj, **kwargs)[source]
-

Defines a solver variable for optimization in the class, constraints defined on this solver will correspond to the limits of that variable

-
-
Parameters:
-
    -

  • obj (str) – The var attribute for the solver variable.

    • -

  • combos – The combinations of the solver variable.

    • -
-
-
Vara kind:
-

the kind of optimization, either min or max

-
-
Returns:
-

The setup class for the solver variable.

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_solver.SolverInstance.html b/docs/_build/html/_autosummary/engforge.attr_solver.SolverInstance.html deleted file mode 100644 index 5985649..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_solver.SolverInstance.html +++ /dev/null @@ -1,245 +0,0 @@ - - - - - - - engforge.attr_solver.SolverInstance — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attr_solver.SolverInstance

-
-
-class SolverInstance(solver, system, **kw)[source]
-

Bases: AttributeInstance

-

A decoupled signal instance to perform operations on a system instance

-

kwargs passed to compile

-

Methods

- - - - - - - - - - - - - - - -

as_ref_dict

compile

establishes the references for the solver to use directly

get_alias

is_active

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

active

classname

combos

constraints

normalize

slvtype

system

solver

obj

var

lhs

rhs

const_f

class_attr

backref

-
-
Parameters:
-
-
-
-
-
-compile(**kwargs)[source]
-

establishes the references for the solver to use directly

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attr_solver.html b/docs/_build/html/_autosummary/engforge.attr_solver.html deleted file mode 100644 index c568447..0000000 --- a/docs/_build/html/_autosummary/engforge.attr_solver.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - - engforge.attr_solver — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.attr_solver
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.attr_solver

-

solver defines a SolverMixin for use by System.

-

Additionally the Solver attribute is defined to add complex behavior to a system as well as add constraints and transient integration.

-

Classes

- - - - - - - - - - - - -

AttrSolverLog

Initialize a filter.

Solver

solver creates subclasses per solver balance

SolverInstance

A decoupled signal instance to perform operations on a system instance

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attributes.ATTRLog.html b/docs/_build/html/_autosummary/engforge.attributes.ATTRLog.html deleted file mode 100644 index 9ef11d9..0000000 --- a/docs/_build/html/_autosummary/engforge.attributes.ATTRLog.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - - - - engforge.attributes.ATTRLog — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attributes.ATTRLog

-
-
-class ATTRLog(name='')[source]
-

Bases: LoggingMixin

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attributes.ATTR_BASE.html b/docs/_build/html/_autosummary/engforge.attributes.ATTR_BASE.html deleted file mode 100644 index 3d466dd..0000000 --- a/docs/_build/html/_autosummary/engforge.attributes.ATTR_BASE.html +++ /dev/null @@ -1,392 +0,0 @@ - - - - - - - engforge.attributes.ATTR_BASE — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attributes.ATTR_BASE

-
-
-class ATTR_BASE(name, default, validator, repr, cmp, hash, init, inherited, metadata=None, type=None, converter=None, kw_only=False, eq=None, eq_key=None, order=None, order_key=None, on_setattr=None, alias=None)[source]
-

Bases: Attribute

-

A base class that handles initalization in the attrs meta class scheme by ultimately createing an Instance

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

class_validate

validates onetime A method to validate the kwargs passed to the define method

collect_attr_inst

collects all the attribute instances for a system

collect_cls

collects all the attributes for a system

configure_for_system

add the config class, and perform checks with `class_validate) :returns: [optional] a dictionary of options to be used in the make_attribute method

configure_instance

validates the instance given attr's init routine

create_instance

Create an instance of the instance_class

define

taking a component or system class as possible input valid input is later validated as an instance of that class or subclass

define_validate

A method to validate the kwargs passed to the define method

evolve

Copy self and apply changes.

from_counting_attr

handle_instance

handles the instance, override as you wish

make_attribute

makes an attrs.Attribute for the class

make_factory

process_combos

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

unpack_atrs

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

name

default

validator

repr

eq

eq_key

order

order_key

hash

init

metadata

type

converter

kw_only

inherited

on_setattr

alias

attr_prefix

default_options

none_ok

template_class

config_cls

active

combos

-
-
-classmethod class_validate(instance, **kwargs)[source]
-

validates onetime A method to validate the kwargs passed to the define method

-
- -
-
-classmethod collect_attr_inst(system, handle_inst=True)[source]
-

collects all the attribute instances for a system

-
-
Return type:
-

dict

-
-
-
- -
-
-classmethod collect_cls(system)[source]
-

collects all the attributes for a system

-
-
Return type:
-

dict

-
-
-
- -
-
-classmethod configure_for_system(name, config_class, cb=None, **kwargs)[source]
-

add the config class, and perform checks with `class_validate) -:returns: [optional] a dictionary of options to be used in the make_attribute method

-
- -
-
-classmethod configure_instance(instance, attribute, value)[source]
-

validates the instance given attr’s init routine

-
- -
-
-classmethod create_instance(instance)[source]
-

Create an instance of the instance_class

-
-
Return type:
-

AttributeInstance

-
-
Parameters:
-

instance (Configuration)

-
-
-
- -
-
-classmethod define(**kwargs)[source]
-

taking a component or system class as possible input valid input is later validated as an instance of that class or subclass

-
- -
-
-classmethod define_validate(**kwargs)[source]
-

A method to validate the kwargs passed to the define method

-
- -
-
-evolve(**changes)
-

Copy self and apply changes.

-

This works similarly to attrs.evolve but that function does not work -with Attribute.

-

It is mainly meant to be used for transform-fields.

-
-

Added in version 20.3.0.

-
-
- -
-
-classmethod handle_instance(canidate)[source]
-

handles the instance, override as you wish

-
- -
-
-classmethod make_attribute(name, comp_class, **kwargs)[source]
-

makes an attrs.Attribute for the class

-
- -
-
-classmethod subclasses(out=None)[source]
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attributes.AttributeInstance.html b/docs/_build/html/_autosummary/engforge.attributes.AttributeInstance.html deleted file mode 100644 index da486ad..0000000 --- a/docs/_build/html/_autosummary/engforge.attributes.AttributeInstance.html +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - engforge.attributes.AttributeInstance — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.attributes.AttributeInstance

-
-
-class AttributeInstance(class_attr, system, **kwargs)[source]
-

Bases: object

-

Methods

- - - - - - - - - - - - - - - -

as_ref_dict

compile

get_alias

is_active

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

active

classname

combos

class_attr

system

backref

-
-
Parameters:
-
    -

  • class_attr (CLASS_ATTR)

    • -

  • system (System)

    • -
-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.attributes.html b/docs/_build/html/_autosummary/engforge.attributes.html deleted file mode 100644 index 7b65175..0000000 --- a/docs/_build/html/_autosummary/engforge.attributes.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - - engforge.attributes — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.attributes
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.attributes

-

Defines a customizeable attrs attribute that is handled in configuration,

-

on init an instance of Instance type for any ATTR_BASE subclass is created

-

Classes

- - - - - - - - - - - - -

ATTRLog

Initialize a filter.

ATTR_BASE

A base class that handles initalization in the attrs meta class scheme by ultimately createing an Instance

AttributeInstance

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.common.ForgeLog.html b/docs/_build/html/_autosummary/engforge.common.ForgeLog.html deleted file mode 100644 index a363da5..0000000 --- a/docs/_build/html/_autosummary/engforge.common.ForgeLog.html +++ /dev/null @@ -1,325 +0,0 @@ - - - - - - - engforge.common.ForgeLog — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.common.ForgeLog

-
-
-class ForgeLog(name='')[source]
-

Bases: LoggingMixin

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.common.chunks.html b/docs/_build/html/_autosummary/engforge.common.chunks.html deleted file mode 100644 index 251b3a0..0000000 --- a/docs/_build/html/_autosummary/engforge.common.chunks.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - - engforge.common.chunks — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.common.chunks

-
-
-chunks(lst, n)[source]
-

Yield successive n-sized chunks from lst.

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.common.get_size.html b/docs/_build/html/_autosummary/engforge.common.get_size.html deleted file mode 100644 index 6a947dd..0000000 --- a/docs/_build/html/_autosummary/engforge.common.get_size.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - - engforge.common.get_size — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.common.get_size

-
-
-get_size(obj, seen=None)[source]
-

Recursively finds size of objects

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.common.html b/docs/_build/html/_autosummary/engforge.common.html deleted file mode 100644 index 19eab54..0000000 --- a/docs/_build/html/_autosummary/engforge.common.html +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - - engforge.common — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.common

-

A set of common values and functions that are globaly available.

-

Functions

- - - - - - - - - - - - -

chunks

Yield successive n-sized chunks from lst.

get_size

Recursively finds size of objects

is_ec2_instance

Check if an instance is running on AWS.

-

Classes

- - - - - - - - - -

ForgeLog

Initialize a filter.

inst_vectorize

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.common.inst_vectorize.html b/docs/_build/html/_autosummary/engforge.common.inst_vectorize.html deleted file mode 100644 index 9acb1cd..0000000 --- a/docs/_build/html/_autosummary/engforge.common.inst_vectorize.html +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - - engforge.common.inst_vectorize — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.common.inst_vectorize

-
-
-class inst_vectorize(pyfunc, otypes=None, doc=None, excluded=None, cache=False, signature=None)[source]
-

Bases: vectorize

-

Methods

- - - -
-
-
-__call__(*args, **kwargs)
-

Return arrays with the results of pyfunc broadcast (vectorized) over -args and kwargs not in excluded.

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.common.is_ec2_instance.html b/docs/_build/html/_autosummary/engforge.common.is_ec2_instance.html deleted file mode 100644 index 36fdf02..0000000 --- a/docs/_build/html/_autosummary/engforge.common.is_ec2_instance.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - - engforge.common.is_ec2_instance — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.common.is_ec2_instance

-
-
-is_ec2_instance()[source]
-

Check if an instance is running on AWS.

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.component_collections.ComponentDict.html b/docs/_build/html/_autosummary/engforge.component_collections.ComponentDict.html deleted file mode 100644 index 0d40af3..0000000 --- a/docs/_build/html/_autosummary/engforge.component_collections.ComponentDict.html +++ /dev/null @@ -1,1581 +0,0 @@ - - - - - - - engforge.component_collections.ComponentDict — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.component_collections.ComponentDict

-
-
-class ComponentDict(*, name=NOTHING, parent=None, current_item=NOTHING, component_type)[source]
-

Bases: ComponentIter, UserDict

-

Stores components by name, and allows tabulation of them

-

Method generated by attrs for class ComponentDict.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

clear

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

Returns this components global references

compile_classes

compiles all subclass functionality

copy

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

fromkeys

get

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

lists the this_name.comp_key.<attr/prop key>: Ref format to override data_dict

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

items

keys

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

pop

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem

as a 2-tuple; but raise KeyError if D is empty.

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

reset

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

setdefault

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

values

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

current

returns all data in wide format and the active key in _current_item

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

wide

component_type

data

current_item

parent

name

dataframe

-
-
Parameters:
-
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-clear() → None.  Remove all items from D.
-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(**kw)
-

Returns this components global references

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property current
-

returns all data in wide format and the active key in _current_item

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get(k[, d]) → D[k] if k in D, else d.  d defaults to None.
-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

lists the this_name.comp_key.<attr/prop key>: Ref format to override data_dict

-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-items() → a set-like object providing a view on D's items
-
- -
-
-keys() → a set-like object providing a view on D's keys
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-pop(k[, d]) → v, remove specified key and return the corresponding value.
-

If key is not found, d is returned if given, otherwise KeyError is raised.

-
- -
-
-popitem() → (k, v), remove and return some (key, value) pair
-

as a 2-tuple; but raise KeyError if D is empty.

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D
-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-values() → an object providing a view on D's values
-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.component_collections.ComponentIter.html b/docs/_build/html/_autosummary/engforge.component_collections.ComponentIter.html deleted file mode 100644 index 35a3622..0000000 --- a/docs/_build/html/_autosummary/engforge.component_collections.ComponentIter.html +++ /dev/null @@ -1,1505 +0,0 @@ - - - - - - - engforge.component_collections.ComponentIter — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.component_collections.ComponentIter

-
-
-class ComponentIter(*, name=NOTHING, parent=None, current_item=NOTHING)[source]
-

Bases: Component

-

Iterable components are designed to eval a large selection of components either one-by-one or all at once at the system level depending on if wide property is set.

-

Method generated by attrs for class ComponentIter.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

Returns this components global references

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

lists the this_name.comp_key.<attr/prop key>: Ref format to override data_dict

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

reset

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

current

returns all data in wide format and the active key in _current_item

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

wide

data

current_item

parent

name

dataframe

-
-
Parameters:
-
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(**kw)[source]
-

Returns this components global references

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property current
-

returns all data in wide format and the active key in _current_item

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)[source]
-

lists the this_name.comp_key.<attr/prop key>: Ref format to override data_dict

-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.component_collections.ComponentIterator.html b/docs/_build/html/_autosummary/engforge.component_collections.ComponentIterator.html deleted file mode 100644 index d761b46..0000000 --- a/docs/_build/html/_autosummary/engforge.component_collections.ComponentIterator.html +++ /dev/null @@ -1,1597 +0,0 @@ - - - - - - - engforge.component_collections.ComponentIterator — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.component_collections.ComponentIterator

-
-
-class ComponentIterator(*, name=NOTHING, parent=None, current_item=NOTHING, component_type)[source]
-

Bases: ComponentIter, UserList

-

Stores components by name, and allows tabulation of them

-

Method generated by attrs for class ComponentIterator.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

append

S.append(value) -- append value to the end of the sequence

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

clear

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

Returns this components global references

compile_classes

compiles all subclass functionality

copy

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

count

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extend

S.extend(iterable) -- extend sequence by appending elements from the iterable

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

index

Raises ValueError if the value is not present.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

insert

S.insert(index, value) -- insert value before index

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

lists the this_name.comp_key.<attr/prop key>: Ref format to override data_dict

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

pop

Raise IndexError if list is empty or index is out of range.

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

remove

S.remove(value) -- remove first occurrence of value.

reset

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

reverse

S.reverse() -- reverse IN PLACE

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

sort

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

current

returns all data in wide format and the active key in _current_item

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

wide

component_type

data

current_item

parent

name

dataframe

-
-
Parameters:
-
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-append(item)
-

S.append(value) – append value to the end of the sequence

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-clear() → None -- remove all items from S
-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(**kw)
-

Returns this components global references

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-count(value) → integer -- return number of occurrences of value
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property current
-

returns all data in wide format and the active key in _current_item

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-extend(other)
-

S.extend(iterable) – extend sequence by appending elements from the iterable

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-index(value[, start[, stop]]) → integer -- return first index of value.
-

Raises ValueError if the value is not present.

-

Supporting start and stop arguments is optional, but -recommended.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-insert(i, item)
-

S.insert(index, value) – insert value before index

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

lists the this_name.comp_key.<attr/prop key>: Ref format to override data_dict

-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-pop([index]) → item -- remove and return item at index (default last).
-

Raise IndexError if list is empty or index is out of range.

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-remove(item)
-

S.remove(value) – remove first occurrence of value. -Raise ValueError if the value is not present.

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-reverse()
-

S.reverse() – reverse IN PLACE

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.component_collections.check_comp_type.html b/docs/_build/html/_autosummary/engforge.component_collections.check_comp_type.html deleted file mode 100644 index 54be6db..0000000 --- a/docs/_build/html/_autosummary/engforge.component_collections.check_comp_type.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - - engforge.component_collections.check_comp_type — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.component_collections.check_comp_type

-
-
-check_comp_type(instance, attr, value)[source]
-

ensures the input component type is a Component

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.component_collections.html b/docs/_build/html/_autosummary/engforge.component_collections.html deleted file mode 100644 index c2ea156..0000000 --- a/docs/_build/html/_autosummary/engforge.component_collections.html +++ /dev/null @@ -1,187 +0,0 @@ - - - - - - - engforge.component_collections — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.component_collections
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.component_collections

-

define a collection of components that will propigate to its parents dataframe

-

When wide is set each component’s references are reported to the system’s table, otherwise only one component’s references are reported, however the system will iterate over the components by calling system.iterable_components

-

Define a Iterable Component slot in a system by calling Slot.define_iterable(…,wide=True/False)

-

CostModel isonly supported in wide mode at this time.

-

Types: -1. ComponentList, ordered by index -2. ComponentDict, ordered by key -3. ComponentGraph, ?#TODO:

-

Functions

- - - - - - -

check_comp_type

ensures the input component type is a Component

-

Classes

- - - - - - - - - - - - - - - -

ComponentDict

Stores components by name, and allows tabulation of them

ComponentIter

Iterable components are designed to eval a large selection of components either one-by-one or all at once at the system level depending on if wide property is set.

ComponentIterator

Stores components by name, and allows tabulation of them

iter_tkn

ambigious type to keep track of iterable position form system reference

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.component_collections.iter_tkn.html b/docs/_build/html/_autosummary/engforge.component_collections.iter_tkn.html deleted file mode 100644 index c0c6efa..0000000 --- a/docs/_build/html/_autosummary/engforge.component_collections.iter_tkn.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - engforge.component_collections.iter_tkn — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.component_collections.iter_tkn

-
-
-class iter_tkn[source]
-

Bases: object

-

ambigious type to keep track of iterable position form system reference

-

Methods

- - - -
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.components.Component.html b/docs/_build/html/_autosummary/engforge.components.Component.html deleted file mode 100644 index 250939b..0000000 --- a/docs/_build/html/_autosummary/engforge.components.Component.html +++ /dev/null @@ -1,1486 +0,0 @@ - - - - - - - engforge.components.Component — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.components.Component

-
-
-class Component(*, name=NOTHING, parent=None)[source]
-

Bases: SolveableInterface, DynamicsMixin

-

Component is an Evaluatable configuration with tabulation, and solvable functionality

-

Method generated by attrs for class Component.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

parent

name

dataframe

-
-
Parameters:
-
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.components.SolveableInterface.html b/docs/_build/html/_autosummary/engforge.components.SolveableInterface.html deleted file mode 100644 index fd96cc7..0000000 --- a/docs/_build/html/_autosummary/engforge.components.SolveableInterface.html +++ /dev/null @@ -1,1036 +0,0 @@ - - - - - - - engforge.components.SolveableInterface — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.components.SolveableInterface

-
-
-class SolveableInterface(*, name=NOTHING, parent=None)[source]
-

Bases: Configuration, TabulationMixin, SolveableMixin

-

common base betwewn solvable and system

-

Method generated by attrs for class SolveableInterface.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

displayname

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

system_id

returns an instance unique id based on id(self)

unique_hash

parent

name

dataframe

-
-
Parameters:
-
-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.components.html b/docs/_build/html/_autosummary/engforge.components.html deleted file mode 100644 index ff13c6e..0000000 --- a/docs/_build/html/_autosummary/engforge.components.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - engforge.components — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.components
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.components

-

Classes

- - - - - - - - - -

Component

Component is an Evaluatable configuration with tabulation, and solvable functionality

SolveableInterface

common base betwewn solvable and system

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.configuration.ConfigLog.html b/docs/_build/html/_autosummary/engforge.configuration.ConfigLog.html deleted file mode 100644 index 984c6e6..0000000 --- a/docs/_build/html/_autosummary/engforge.configuration.ConfigLog.html +++ /dev/null @@ -1,329 +0,0 @@ - - - - - - - engforge.configuration.ConfigLog — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.configuration.ConfigLog

-
-
-class ConfigLog(name='')[source]
-

Bases: LoggingMixin

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.configuration.Configuration.html b/docs/_build/html/_autosummary/engforge.configuration.Configuration.html deleted file mode 100644 index 386a568..0000000 --- a/docs/_build/html/_autosummary/engforge.configuration.Configuration.html +++ /dev/null @@ -1,698 +0,0 @@ - - - - - - - engforge.configuration.Configuration — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.configuration.Configuration

-
-
-class Configuration(*, name=NOTHING)[source]
-

Bases: AttributedBaseMixin

-

Configuration is a pattern for storing attributes that might change frequently, and proivdes the core functionality for a host of different applications.

-

Configuration is able to go through itself and its objects and map all included Configurations, just to a specific level.

-

Common functionality includes an __on_init__ wrapper for attrs post-init method

-

Method generated by attrs for class Configuration.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_inst_attributes

collects all the attributes for a system

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

plot_attributes

Lists all plot attributes for class

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

displayname

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

log_silo

logger

numeric_as_dict

numeric_hash

slack_webhook_url

unique_hash

name

-
-
Parameters:
-

name (str)

-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()[source]
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-classmethod compile_classes()[source]
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)[source]
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)[source]
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)[source]
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-classmethod parent_configurations_cls()[source]
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod pre_compile()[source]
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)[source]
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()[source]
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod validate_class()[source]
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.configuration.comp_transform.html b/docs/_build/html/_autosummary/engforge.configuration.comp_transform.html deleted file mode 100644 index 02cca27..0000000 --- a/docs/_build/html/_autosummary/engforge.configuration.comp_transform.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - engforge.configuration.comp_transform — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.configuration.comp_transform

-
-
-comp_transform(c, f)
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.configuration.conv_nms.html b/docs/_build/html/_autosummary/engforge.configuration.conv_nms.html deleted file mode 100644 index 686db8e..0000000 --- a/docs/_build/html/_autosummary/engforge.configuration.conv_nms.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - engforge.configuration.conv_nms — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.configuration.conv_nms

-
-
-conv_nms(v)
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.configuration.forge.html b/docs/_build/html/_autosummary/engforge.configuration.forge.html deleted file mode 100644 index b4c6496..0000000 --- a/docs/_build/html/_autosummary/engforge.configuration.forge.html +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - - engforge.configuration.forge — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.configuration.forge

-
-
-forge(cls=None, **kwargs)[source]
-

Wrap all Configurations with this decorator with the following behavior -1) we use the callback when any property changes -2) repr is default -3) hash is by object identity

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.configuration.html b/docs/_build/html/_autosummary/engforge.configuration.html deleted file mode 100644 index 61a9be7..0000000 --- a/docs/_build/html/_autosummary/engforge.configuration.html +++ /dev/null @@ -1,195 +0,0 @@ - - - - - - - engforge.configuration — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.configuration
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.configuration

-

Functions

- - - - - - - - - - - - - - - - - - - - - - - - -

comp_transform

conv_nms

forge

Wrap all Configurations with this decorator with the following behavior 1) we use the callback when any property changes 2) repr is default 3) hash is by object identity

meta

a convienience wrapper to add metadata to attr.ib :type title: :param title: a title that gets formatted for column headers :type desc: :param desc: a description of the property

name_generator

a name generator for the instance

property_changed

a callback for when a property changes, this will set the _anything_changed flag to True, and change value when appropriate

signals_slots_handler

creates attributes as per the attrs.define field_transformer use case.

-

Classes

- - - - - - - - - -

ConfigLog

Initialize a filter.

Configuration

Configuration is a pattern for storing attributes that might change frequently, and proivdes the core functionality for a host of different applications.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.configuration.meta.html b/docs/_build/html/_autosummary/engforge.configuration.meta.html deleted file mode 100644 index f422868..0000000 --- a/docs/_build/html/_autosummary/engforge.configuration.meta.html +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - - engforge.configuration.meta — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.configuration.meta

-
-
-meta(title, desc=None, **kwargs)[source]
-

a convienience wrapper to add metadata to attr.ib -:type title: -:param title: a title that gets formatted for column headers -:type desc: -:param desc: a description of the property

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.configuration.name_generator.html b/docs/_build/html/_autosummary/engforge.configuration.name_generator.html deleted file mode 100644 index ca1ed58..0000000 --- a/docs/_build/html/_autosummary/engforge.configuration.name_generator.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - - engforge.configuration.name_generator — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.configuration.name_generator

-
-
-name_generator(instance)[source]
-

a name generator for the instance

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.configuration.property_changed.html b/docs/_build/html/_autosummary/engforge.configuration.property_changed.html deleted file mode 100644 index ae2322f..0000000 --- a/docs/_build/html/_autosummary/engforge.configuration.property_changed.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - - engforge.configuration.property_changed — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.configuration.property_changed

-
-
-property_changed(instance, variable, value)[source]
-

a callback for when a property changes, this will set the _anything_changed flag to True, and change value when appropriate

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.configuration.signals_slots_handler.html b/docs/_build/html/_autosummary/engforge.configuration.signals_slots_handler.html deleted file mode 100644 index b36f061..0000000 --- a/docs/_build/html/_autosummary/engforge.configuration.signals_slots_handler.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - - engforge.configuration.signals_slots_handler — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.configuration.signals_slots_handler

-
-
-signals_slots_handler(cls, fields, slots=True, signals=True, solvers=True, sys=True, plots=True)[source]
-

creates attributes as per the attrs.define field_transformer use case.

-

Customize initalization with slots,signals,solvers and sys flags.

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.dataframe.DataFrameLog.html b/docs/_build/html/_autosummary/engforge.dataframe.DataFrameLog.html deleted file mode 100644 index ea8b350..0000000 --- a/docs/_build/html/_autosummary/engforge.dataframe.DataFrameLog.html +++ /dev/null @@ -1,329 +0,0 @@ - - - - - - - engforge.dataframe.DataFrameLog — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.dataframe.DataFrameLog

-
-
-class DataFrameLog(name='')[source]
-

Bases: LoggingMixin

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.dataframe.DataframeMixin.html b/docs/_build/html/_autosummary/engforge.dataframe.DataframeMixin.html deleted file mode 100644 index c402fb0..0000000 --- a/docs/_build/html/_autosummary/engforge.dataframe.DataframeMixin.html +++ /dev/null @@ -1,214 +0,0 @@ - - - - - - - engforge.dataframe.DataframeMixin — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.dataframe.DataframeMixin

-
-
-class DataframeMixin[source]
-

Bases: object

-

Methods

- - - - - - - - - -

format_columns

smart_split_dataframe

splits dataframe between constant values and variants

-

Attributes

- - - - - - - - - - - - - - - -

dataframe

returns the dataframe

dataframe_constants

dataframe_variants

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

-
-
-property dataframe
-

returns the dataframe

-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)[source]
-

splits dataframe between constant values and variants

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.dataframe.dataframe_prop.html b/docs/_build/html/_autosummary/engforge.dataframe.dataframe_prop.html deleted file mode 100644 index 21bf396..0000000 --- a/docs/_build/html/_autosummary/engforge.dataframe.dataframe_prop.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - - engforge.dataframe.dataframe_prop — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.dataframe.dataframe_prop

-
-
-dataframe_prop
-

alias of dataframe_property

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.dataframe.dataframe_property.html b/docs/_build/html/_autosummary/engforge.dataframe.dataframe_property.html deleted file mode 100644 index b4d9439..0000000 --- a/docs/_build/html/_autosummary/engforge.dataframe.dataframe_property.html +++ /dev/null @@ -1,205 +0,0 @@ - - - - - - - engforge.dataframe.dataframe_property — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.dataframe.dataframe_property

-
-
-class dataframe_property(fget=None, fset=None, fdel=None, *args, **kwargs)[source]
-

Bases: engforge_prop

-

Methods

- - - - - - - - - - - - - - - -

deleter

get_func_return

ensures that the function has a return annotation, and that return annotation is in valid sort types

getter

setter

-

Attributes

- - - - - - -

must_return

-
-
-__call__(fget=None, fset=None, fdel=None, doc=None, *args, **kwargs)
-

this will be called when input is provided before property is set

-
- -
-
-get_func_return(func)
-

ensures that the function has a return annotation, and that return annotation is in valid sort types

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.dataframe.determine_split.html b/docs/_build/html/_autosummary/engforge.dataframe.determine_split.html deleted file mode 100644 index 3c3b444..0000000 --- a/docs/_build/html/_autosummary/engforge.dataframe.determine_split.html +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - - engforge.dataframe.determine_split — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.dataframe.determine_split

-
-
-determine_split(raw, top=1, key_f=<function <lambda>>)[source]
-
-
Parameters:
-

top (int)

-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.dataframe.df_prop.html b/docs/_build/html/_autosummary/engforge.dataframe.df_prop.html deleted file mode 100644 index 98c0cd7..0000000 --- a/docs/_build/html/_autosummary/engforge.dataframe.df_prop.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - - engforge.dataframe.df_prop — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.dataframe.df_prop

-
-
-df_prop
-

alias of dataframe_property

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.dataframe.html b/docs/_build/html/_autosummary/engforge.dataframe.html deleted file mode 100644 index 01778d0..0000000 --- a/docs/_build/html/_autosummary/engforge.dataframe.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - - - engforge.dataframe — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.dataframe
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.dataframe

-

Dataframe Module:

-

Store data in dataframes and provide a simple interface to manipulate it.

-

Functions

- - - - - - - - - - - - - - - -

determine_split

is_uniform

key_func

split_dataframe

split dataframe into a dictionary of invariants and a dataframe of variable values

-

Classes

- - - - - - - - - - - - - - - - - - -

DataFrameLog

Initialize a filter.

DataframeMixin

dataframe_prop

alias of dataframe_property

dataframe_property

df_prop

alias of dataframe_property

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.dataframe.is_uniform.html b/docs/_build/html/_autosummary/engforge.dataframe.is_uniform.html deleted file mode 100644 index 229fc85..0000000 --- a/docs/_build/html/_autosummary/engforge.dataframe.is_uniform.html +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - - engforge.dataframe.is_uniform — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.dataframe.is_uniform

-
-
-is_uniform(s)[source]
-
-
Parameters:
-

s (Series)

-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.dataframe.key_func.html b/docs/_build/html/_autosummary/engforge.dataframe.key_func.html deleted file mode 100644 index b0511f8..0000000 --- a/docs/_build/html/_autosummary/engforge.dataframe.key_func.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - engforge.dataframe.key_func — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.dataframe.key_func

-
-
-key_func(kv)
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.dataframe.split_dataframe.html b/docs/_build/html/_autosummary/engforge.dataframe.split_dataframe.html deleted file mode 100644 index 437a448..0000000 --- a/docs/_build/html/_autosummary/engforge.dataframe.split_dataframe.html +++ /dev/null @@ -1,179 +0,0 @@ - - - - - - - engforge.dataframe.split_dataframe — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.dataframe.split_dataframe

-
-
-split_dataframe(df)[source]
-

split dataframe into a dictionary of invariants and a dataframe of variable values

-
-
Returns tuple:
-

constants,dataframe

-
-
Return type:
-

tuple

-
-
Parameters:
-

df (DataFrame)

-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.datastores.data.DBConnection.html b/docs/_build/html/_autosummary/engforge.datastores.data.DBConnection.html deleted file mode 100644 index 8d9c332..0000000 --- a/docs/_build/html/_autosummary/engforge.datastores.data.DBConnection.html +++ /dev/null @@ -1,423 +0,0 @@ - - - - - - - engforge.datastores.data.DBConnection — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.datastores.data.DBConnection

-
-
-class DBConnection(*args, **kwargs)[source]
-

Bases: LoggingMixin

-

A database singleton that is thread safe and pickleable (serializable) -to get the active instance use DBConnection.instance(**non_default_connection_args)

-

On the Singleton DBconnection.instance(): __init__(*args,**kwargs) will get called, technically you -could do it this way but won’t be thread safe, or a single instance -:type database_name: -:param database_name: the name for the database inside the db server -:type host: -:param host: hostname -:type user: -:param user: username -:type passd: -:param passd: password -:param port: hostname -:param echo: if the engine echos or not

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

cleanup_sessions

configure

A boilerplate configure method

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

ensure_database_exists

Check if database exists, if not create it and tables

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

rebuild_database

Rebuild database on confirmation, create the database if nessicary

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

session_scope

Provide a transactional scope around a series of operations.

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Session

connect_args

connection_string

dbname

echo

engine

host

identity

log_fmt

log_level

log_on

logger

max_overflow

passd

pool_size

port

scopefunc

session_factory

slack_webhook_url

user

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-configure()[source]
-

A boilerplate configure method

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-ensure_database_exists(create_meta=True)[source]
-

Check if database exists, if not create it and tables

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-rebuild_database(confirm=True)[source]
-

Rebuild database on confirmation, create the database if nessicary

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-session_scope()[source]
-

Provide a transactional scope around a series of operations.

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.datastores.data.DiskCacheStore.html b/docs/_build/html/_autosummary/engforge.datastores.data.DiskCacheStore.html deleted file mode 100644 index 1ac23ae..0000000 --- a/docs/_build/html/_autosummary/engforge.datastores.data.DiskCacheStore.html +++ /dev/null @@ -1,405 +0,0 @@ - - - - - - - engforge.datastores.data.DiskCacheStore — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.datastores.data.DiskCacheStore

-
-
-class DiskCacheStore(*args, **kwargs)[source]
-

Bases: LoggingMixin

-

A singleton object with safe methods for file access, -Aims to prevent large number of file pointers open

-

These should be subclassed for each cache location you want

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

expire

wrapper for diskcache expire method that only permits expiration on a certain interval :return: bool, True if expired called

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

get

Helper method to get an item, return None it doesn't exist and warn.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set

Passes default arguments to set the key:data relationship :param expire: time in seconds to expire the data

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

alt_path

cache

cache_init_kwargs

cache_root

current_keys

expire_threshold

identity

last_expire

log_fmt

log_level

log_on

logger

retries

size_limit

slack_webhook_url

sleep_time

timeout

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-cache_class
-

alias of Cache

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-expire()[source]
-

wrapper for diskcache expire method that only permits expiration on a certain interval -:return: bool, True if expired called

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get(key=None, on_missing=None, retry=True, ttl=None)[source]
-

Helper method to get an item, return None it doesn’t exist and warn. -:type on_missing: -:param on_missing: a callback to use if the data is missing, which will set the data at the key, and return it

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set(key=None, data=None, retry=True, ttl=None, **kwargs)[source]
-

Passes default arguments to set the key:data relationship -:param expire: time in seconds to expire the data

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.datastores.data.addapt_numpy_array.html b/docs/_build/html/_autosummary/engforge.datastores.data.addapt_numpy_array.html deleted file mode 100644 index ab0f4f8..0000000 --- a/docs/_build/html/_autosummary/engforge.datastores.data.addapt_numpy_array.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - engforge.datastores.data.addapt_numpy_array — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.datastores.data.addapt_numpy_array

-
-
-addapt_numpy_array(numpy_array)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.datastores.data.addapt_numpy_float32.html b/docs/_build/html/_autosummary/engforge.datastores.data.addapt_numpy_float32.html deleted file mode 100644 index 9a82f93..0000000 --- a/docs/_build/html/_autosummary/engforge.datastores.data.addapt_numpy_float32.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - engforge.datastores.data.addapt_numpy_float32 — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.datastores.data.addapt_numpy_float32

-
-
-addapt_numpy_float32(numpy_float32)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.datastores.data.addapt_numpy_float64.html b/docs/_build/html/_autosummary/engforge.datastores.data.addapt_numpy_float64.html deleted file mode 100644 index 53b9b16..0000000 --- a/docs/_build/html/_autosummary/engforge.datastores.data.addapt_numpy_float64.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - engforge.datastores.data.addapt_numpy_float64 — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.datastores.data.addapt_numpy_float64

-
-
-addapt_numpy_float64(numpy_float64)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.datastores.data.addapt_numpy_int32.html b/docs/_build/html/_autosummary/engforge.datastores.data.addapt_numpy_int32.html deleted file mode 100644 index 6db2d9b..0000000 --- a/docs/_build/html/_autosummary/engforge.datastores.data.addapt_numpy_int32.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - engforge.datastores.data.addapt_numpy_int32 — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.datastores.data.addapt_numpy_int32

-
-
-addapt_numpy_int32(numpy_int32)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.datastores.data.addapt_numpy_int64.html b/docs/_build/html/_autosummary/engforge.datastores.data.addapt_numpy_int64.html deleted file mode 100644 index 05bd6bc..0000000 --- a/docs/_build/html/_autosummary/engforge.datastores.data.addapt_numpy_int64.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - engforge.datastores.data.addapt_numpy_int64 — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.datastores.data.addapt_numpy_int64

-
-
-addapt_numpy_int64(numpy_int64)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.datastores.data.autocorrelation_direct.html b/docs/_build/html/_autosummary/engforge.datastores.data.autocorrelation_direct.html deleted file mode 100644 index 5526b6d..0000000 --- a/docs/_build/html/_autosummary/engforge.datastores.data.autocorrelation_direct.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - engforge.datastores.data.autocorrelation_direct — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.datastores.data.autocorrelation_direct

-
-
-autocorrelation_direct(x)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.datastores.data.autocorrelation_fft.html b/docs/_build/html/_autosummary/engforge.datastores.data.autocorrelation_fft.html deleted file mode 100644 index bd04bde..0000000 --- a/docs/_build/html/_autosummary/engforge.datastores.data.autocorrelation_fft.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - engforge.datastores.data.autocorrelation_fft — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.datastores.data.autocorrelation_fft

-
-
-autocorrelation_fft(x)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.datastores.data.autocorrelation_numpy.html b/docs/_build/html/_autosummary/engforge.datastores.data.autocorrelation_numpy.html deleted file mode 100644 index 9f97f2c..0000000 --- a/docs/_build/html/_autosummary/engforge.datastores.data.autocorrelation_numpy.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - engforge.datastores.data.autocorrelation_numpy — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.datastores.data.autocorrelation_numpy

-
-
-autocorrelation_numpy(x)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.datastores.data.html b/docs/_build/html/_autosummary/engforge.datastores.data.html deleted file mode 100644 index 47623d1..0000000 --- a/docs/_build/html/_autosummary/engforge.datastores.data.html +++ /dev/null @@ -1,207 +0,0 @@ - - - - - - - engforge.datastores.data — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.datastores.data

-

Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

addapt_numpy_array

addapt_numpy_float32

addapt_numpy_float64

addapt_numpy_int32

addapt_numpy_int64

autocorrelation_direct

autocorrelation_fft

autocorrelation_numpy

nan_to_null

-

Classes

- - - - - - - - - -

DBConnection

A database singleton that is thread safe and pickleable (serializable) to get the active instance use DBConnection.instance(**non_default_connection_args)

DiskCacheStore

A singleton object with safe methods for file access, Aims to prevent large number of file pointers open

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.datastores.data.nan_to_null.html b/docs/_build/html/_autosummary/engforge.datastores.data.nan_to_null.html deleted file mode 100644 index 3948f68..0000000 --- a/docs/_build/html/_autosummary/engforge.datastores.data.nan_to_null.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - engforge.datastores.data.nan_to_null — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.datastores.data.nan_to_null

-
-
-nan_to_null(f)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.datastores.html b/docs/_build/html/_autosummary/engforge.datastores.html deleted file mode 100644 index aea24c4..0000000 --- a/docs/_build/html/_autosummary/engforge.datastores.html +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - - engforge.datastores — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.datastores
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.datastores

- - - - - - - - - -

data

secrets

Generate cryptographically strong pseudo-random numbers suitable for managing secrets such as account authentication, tokens, and similar.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.dynamics.DynamicsMixin.html b/docs/_build/html/_autosummary/engforge.dynamics.DynamicsMixin.html deleted file mode 100644 index f7de189..0000000 --- a/docs/_build/html/_autosummary/engforge.dynamics.DynamicsMixin.html +++ /dev/null @@ -1,1385 +0,0 @@ - - - - - - - engforge.dynamics.DynamicsMixin — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.dynamics.DynamicsMixin

-
-
-class DynamicsMixin(*, name=NOTHING)[source]
-

Bases: Configuration, SolveableMixin

-

dynamic mixin for components and systems that have dynamics, such as state space models, while allowing nonlinear dynamics via matrix modification. This mixin is intended to work alongside the solver module and the Time integrating attributes, and will raise an error if a conflict is detected #TODO.

-

Method generated by attrs for class DynamicsMixin.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

time

unique_hash

update_interval

name

parent

-
-
Parameters:
-

name (str)

-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)[source]
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)[source]
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)[source]
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)[source]
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)[source]
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)[source]
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)[source]
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)[source]
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-linear_output(t, dt, X, U=None)[source]
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)[source]
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)[source]
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)[source]
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)[source]
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)[source]
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)[source]
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)[source]
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)[source]
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)[source]
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)[source]
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)[source]
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)[source]
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)[source]
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)[source]
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)[source]
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.dynamics.GlobalDynamics.html b/docs/_build/html/_autosummary/engforge.dynamics.GlobalDynamics.html deleted file mode 100644 index c8e8fce..0000000 --- a/docs/_build/html/_autosummary/engforge.dynamics.GlobalDynamics.html +++ /dev/null @@ -1,1421 +0,0 @@ - - - - - - - engforge.dynamics.GlobalDynamics — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.dynamics.GlobalDynamics

-
-
-class GlobalDynamics(*, name=NOTHING)[source]
-

Bases: DynamicsMixin

-

This object is inherited by configurations that collect other dynamicMixins and orchestrates their simulation, and steady state analysis

-

#TODO: establish bounds in solver

-

Method generated by attrs for class GlobalDynamics.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

setup_global_dynamics

recursively creates numeric matricies for the simulation

signals_attributes

Lists all signals attributes for class

sim_matrix

simulate the system over the course of time.

simulate

runs a simulation over the course of time, and returns a dataframe of the results.

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

time

unique_hash

update_interval

name

parent

-
-
Parameters:
-

name (str)

-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-setup_global_dynamics(**kwargs)[source]
-

recursively creates numeric matricies for the simulation

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-sim_matrix(eval_kw=None, sys_kw=None, **kwargs)[source]
-

simulate the system over the course of time. -return a dictionary of dataframes

-
- -
-
-simulate(dt, endtime, X0=None, cb=None, eval_kw=None, sys_kw=None, min_kw=None, run_solver=False, return_system=False, return_data=False, return_all=False, debug_fail=False, **kwargs)[source]
-

runs a simulation over the course of time, and returns a dataframe of the results.

-

A copy of this system is made, and the simulation is run on the copy, so as to not affect the state of the original system.

-

#TODO:

-
-
Return type:
-

DataFrame

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.dynamics.INDEX_MAP.html b/docs/_build/html/_autosummary/engforge.dynamics.INDEX_MAP.html deleted file mode 100644 index e914e49..0000000 --- a/docs/_build/html/_autosummary/engforge.dynamics.INDEX_MAP.html +++ /dev/null @@ -1,196 +0,0 @@ - - - - - - - engforge.dynamics.INDEX_MAP — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.dynamics.INDEX_MAP

-
-
-class INDEX_MAP(datas)[source]
-

Bases: object

-

Methods

- - - - - - - - - - - - -

get

indify

remap_indexes_to

-

Attributes

- - - - - - -

oppo

-
-
Parameters:
-

datas (list)

-
-
-
-
-__call__(key)[source]
-

Call self as a function.

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.dynamics.html b/docs/_build/html/_autosummary/engforge.dynamics.html deleted file mode 100644 index 40a729c..0000000 --- a/docs/_build/html/_autosummary/engforge.dynamics.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - - engforge.dynamics — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.dynamics
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.dynamics

-

Combines the tabulation and component mixins to create a mixin for systems and components that have dynamics, such as state space models, while allowing nonlinear dynamics via matrix modification

-

This module is intended to work alongside the solver module and the Time integrating attributes, and will raise an error if a conflict is detected.

-

The DynamicsMixin works by establishing a state matricies A, B, C, and D, which are used to define the dynamics of the system. The state matrix A is the primary matrix, and is used to define the state dynamics of the system. The input matrix B is used to define the input dynamics of the system. The output matrix C is used to define the output dynamics of the system. The feedthrough matrix D is used to define the feedthrough dynamics of the system.

-

As opposed to the Time attribute, which modifies the state of the system, the DynamicsMixin copies the initial values of the state and input which then are integrated over time. At predefined intervals the control and output will stored in the tabulation.

-

#TODO: The top level system will collect the underlying dynamical systems and combine them to an index and overall state space model. This will allow for the creation of a system of systems, and the ability to create a system of systems with a single state space model.

-

#TODO: integration is done by the solver, where DynamicSystems have individual solver control, solver control is set for a smart default scipy

-

Functions

- - - - - - -

valid_mtx

-

Classes

- - - - - - - - - - - - -

DynamicsMixin

dynamic mixin for components and systems that have dynamics, such as state space models, while allowing nonlinear dynamics via matrix modification.

GlobalDynamics

This object is inherited by configurations that collect other dynamicMixins and orchestrates their simulation, and steady state analysis

INDEX_MAP

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.dynamics.valid_mtx.html b/docs/_build/html/_autosummary/engforge.dynamics.valid_mtx.html deleted file mode 100644 index 1e36e1c..0000000 --- a/docs/_build/html/_autosummary/engforge.dynamics.valid_mtx.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - engforge.dynamics.valid_mtx — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.dynamics.valid_mtx

-
-
-valid_mtx(arr)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.costs.CostLog.html b/docs/_build/html/_autosummary/engforge.eng.costs.CostLog.html deleted file mode 100644 index bc06604..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.costs.CostLog.html +++ /dev/null @@ -1,334 +0,0 @@ - - - - - - - engforge.eng.costs.CostLog — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.costs.CostLog

-
-
-class CostLog(name='')[source]
-

Bases: LoggingMixin

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.costs.CostModel.html b/docs/_build/html/_autosummary/engforge.eng.costs.CostModel.html deleted file mode 100644 index 7126a1b..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.costs.CostModel.html +++ /dev/null @@ -1,1231 +0,0 @@ - - - - - - - engforge.eng.costs.CostModel — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.costs.CostModel

-
-
-class CostModel(*, name=NOTHING, cost_per_item=nan)[source]
-

Bases: Configuration, TabulationMixin

-

CostModel is a mixin for components or systems that reports its costs through the cost system property, which by default sums the item_cost and sub_items_cost.

-

item_cost is determined by calculate_item_cost() which by default uses: cost_per_item field to return the item cost, which defaults to numpy.nan if not set. Nan values are ignored and replaced with 0.

-

sub_items_cost system_property summarizes the costs of any component in a Slot that has a CostModel or for SlotS which CostModel.declare_cost(slot,default=numeric|CostModelInst|dict[str,float])

-

Method generated by attrs for class CostModel.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

all_categories

calculate_item_cost

override this with a parametric model related to this systems attributes and properties

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

class_cost_properties

returns cost_property objects from this class & subclasses

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

cost_categories_at_term

costs_at_term

returns a dictionary of all costs at term i, with zero if the mode function returns False at that term

critical

A routine to communicate to the root of the server network that there is an issue

custom_cost

Takes class costs set, and creates a copy of the class costs, then applies the cost numeric or CostMethod in the same way but only for that instance of

debug

Writes at a low level to the log file.

default_cost

Provide a default cost for Slot items that are not CostModel's.

dict_itemized_costs

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

reset_cls_costs

set_attr

set_default_costs

set default costs if no costs are set

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

sub_costs

gets items from CostModel's defined in a Slot attribute or in a slot default, tolerrant to nan's in cost definitions

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

sum_costs

sums costs of cost_property's in this item that are present at term=0, and by category if define as input

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dflt_costs

updates internal default slot costs if the current component doesn't exist or isn't a cost model, this is really a component method but we will use it never the less.

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

combine_cost([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

cost_categories

returns itemized costs grouped by category

cost_properties

returns the current values of the current properties

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

displayname

filename

A nice to have, good to override

future_costs([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

item_cost([fget, fset, fdel, doc])

A thin wrapper over system_property that will be accounted by Economics Components and apply term & categorization

itemized_costs([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

last_context

Returns the last context

log_fmt

log_level

log_on

log_silo

logger

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

sub_items_cost([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

system_id

returns an instance unique id based on id(self)

unique_hash

cost_per_item

name

parent

dataframe

-
-
Parameters:
-
    -

  • name (str)

    • -

  • cost_per_item (float)

    • -
-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-calculate_item_cost()[source]
-

override this with a parametric model related to this systems attributes and properties

-
-
Return type:
-

float

-
-
-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-classmethod class_cost_properties()[source]
-

returns cost_property objects from this class & subclasses

-
-
Return type:
-

dict

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-property cost_categories
-

returns itemized costs grouped by category

-
- -
-
-property cost_properties: dict
-

returns the current values of the current properties

-
- -
-
-costs_at_term(term, test_val=True)[source]
-

returns a dictionary of all costs at term i, with zero if the mode -function returns False at that term

-
-
Return type:
-

dict

-
-
Parameters:
-

term (int)

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-custom_cost(slot_name, cost, warn_on_non_costmodel=True)[source]
-

Takes class costs set, and creates a copy of the class costs, then applies the cost numeric or CostMethod in the same way but only for that instance of

-
-
Parameters:
-
    -

  • slot_name (str)

    • -

  • cost (float | CostModel)

    • -
-
-
-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-classmethod default_cost(slot_name, cost, warn_on_non_costmodel=True)[source]
-

Provide a default cost for Slot items that are not CostModel’s. Cost is applied class wide, but can be overriden with custom_cost per instance

-
-
Parameters:
-
    -

  • slot_name (str)

    • -

  • cost (float | CostModel)

    • -
-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

Returns the last context

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_default_costs()[source]
-

set default costs if no costs are set

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-sub_costs(saved=None, categories=None, term=0)[source]
-

gets items from CostModel’s defined in a Slot attribute or in a slot default, tolerrant to nan’s in cost definitions

-
-
Parameters:
-
    -

  • saved (set | None)

    • -

  • categories (tuple | None)

    • -
-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()[source]
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-sum_costs(saved=None, categories=None, term=0)[source]
-

sums costs of cost_property’s in this item that are present at term=0, and by category if define as input

-
-
Parameters:
-
    -

  • saved (set | None)

    • -

  • categories (tuple | None)

    • -
-
-
-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dflt_costs()[source]
-

updates internal default slot costs if the current component doesn’t exist or isn’t a cost model, this is really a component method but we will use it never the less.

-

This should be called from Component.update() if default costs are used

-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.costs.Economics.html b/docs/_build/html/_autosummary/engforge.eng.costs.Economics.html deleted file mode 100644 index 8edaaef..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.costs.Economics.html +++ /dev/null @@ -1,1588 +0,0 @@ - - - - - - - engforge.eng.costs.Economics — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.costs.Economics

-
-
-class Economics(*, name=NOTHING, parent=None, term_length=0, discount_rate=0.0, fixed_output=nan, output_type='generic', terms_per_year=1)[source]
-

Bases: Component

-

Economics is a component that summarizes costs and reports the economics of a system and its components in a recursive format

-

Method generated by attrs for class Economics.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

calculate_costs

recursively accounts for costs in the parent, its children recursively.

calculate_production

must override this function and set economic_output

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_prop

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

standard component references are

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

sum_cost_references

sum_references

sum_term_fgen

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

term_fgen

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

combine_cost([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

cost_references

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

lifecycle_dataframe

simulates the economics lifecycle and stores the results in a term based dataframe

lifecycle_output

return lifecycle calculations for lcoe

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

output([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

term_length

discount_rate

fixed_output

output_type

terms_per_year

parent

name

dataframe

-
-
Parameters:
-
    -

  • name (str)

    • -

  • parent (Component | System)

    • -

  • term_length (int)

    • -

  • discount_rate (float)

    • -

  • fixed_output (float)

    • -

  • output_type (str)

    • -

  • terms_per_year (int)

    • -
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-calculate_costs(parent)[source]
-

recursively accounts for costs in the parent, its children recursively.

-
-
Return type:
-

float

-
-
-
- -
-
-calculate_production(parent, term)[source]
-

must override this function and set economic_output

-
-
Return type:
-

float

-
-
-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=True, numeric_only=False)[source]
-

standard component references are

-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-property lifecycle_dataframe: DataFrame
-

simulates the economics lifecycle and stores the results in a term based dataframe

-
- -
-
-property lifecycle_output: dict
-

return lifecycle calculations for lcoe

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent)[source]
-

Kwargs comes from eval_kw in solver

-
-
Parameters:
-

parent (Component | System)

-
-
-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.costs.cost_property.html b/docs/_build/html/_autosummary/engforge.eng.costs.cost_property.html deleted file mode 100644 index ba0ce4a..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.costs.cost_property.html +++ /dev/null @@ -1,249 +0,0 @@ - - - - - - - engforge.eng.costs.cost_property — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.costs.cost_property

-
-
-class cost_property(fget=None, fset=None, fdel=None, doc=None, desc=None, label=None, stochastic=False, mode='initial', category=None)[source]
-

Bases: system_property

-

A thin wrapper over system_property that will be accounted by Economics Components and apply term & categorization

-

cost_property should return a float/int always and will raise an error if the return annotation is different, although annotations are not required and will default to float.

-

#Terms: -Terms start counting at 0 and can be evald by the Economic.term_length -cost_properties will return their value as system_properties do without regard for the term state, however a CostModel’s costs at a term can be retrived by costs_at_term. The default mode is for initial cost

-

#Categories: -Categories are a way to report cost categories and multiple can be applied to a cost. Categories are grouped by the Economics system at reported in bulk by term and over the term_length

-

extends system_property interface with mode & category keywords -:type mode: str -:param mode: can be one of initial,`maintenance`,`always` or a function with signature f(inst,term) as an integer and returning a boolean True if it is to be applied durring that term.

-

Methods

- - - - - - - - - - - - - - - - - - -

apply_at_term

deleter

get_func_return

ensures that the function has a return annotation, and that return annotation is in valid sort types

getter

setter

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - -

cost_categories

desc

label

must_return

return_type

stochastic

term_mode

-
-
Parameters:
-
    -

  • mode (str)

    • -

  • category (str | list)

    • -
-
-
-
-
-__call__(fget=None, fset=None, fdel=None, doc=None)
-

this will be called when input is provided before property is set

-
- -
-
-get_func_return(func)[source]
-

ensures that the function has a return annotation, and that return annotation is in valid sort types

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.costs.eval_slot_cost.html b/docs/_build/html/_autosummary/engforge.eng.costs.eval_slot_cost.html deleted file mode 100644 index b8bae33..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.costs.eval_slot_cost.html +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - - engforge.eng.costs.eval_slot_cost — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.costs.eval_slot_cost

-
-
-eval_slot_cost(slot_item, saved=None)[source]
-
-
Parameters:
-
    -

  • slot_item (float | int | CostModel | dict)

    • -

  • saved (set | None)

    • -
-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.costs.gend.html b/docs/_build/html/_autosummary/engforge.eng.costs.gend.html deleted file mode 100644 index 370b36b..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.costs.gend.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - - engforge.eng.costs.gend — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.costs.gend

-
-
-gend(deect)[source]
-
-
Parameters:
-

deect (dict)

-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.costs.html b/docs/_build/html/_autosummary/engforge.eng.costs.html deleted file mode 100644 index 9518c55..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.costs.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - - - engforge.eng.costs — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.costs

-

Defines a CostModel & Economics Component that define & orchestrate cost accounting respectively.

-

CostModels can have a cost_per_item and additionally calculate a cumulative_cost from internally defined `CostModel`s.

-

CostModel’s can have cost_property’s which detail how and when a cost should be applied & grouped. By default each CostModel has a cost_per_item which is reflected in item_cost cost_property set on the initial term as a unit category. Multiple categories of cost are also able to be set on cost_properties as follows

-

``` -@forge -class Widget(Component,CostModel):

-
-

@cost_property(mode=’initial’,category=’capex,manufacturing’) -def cost_of_XYZ(self):

-
-

return …

-
-
-

```

-

Economics models sum CostModel.cost_properties recursively on the parent they are defined. Economics computes the grouped category costs for each item recursively as well as summary properties like annualized values and levalized cost. Economic output is determined by a fixed_output or overriding calculate_production(self,parent) to dynamically calculate changing economics based on factors in the parent.

-

Default costs can be set on any CostModel.Slot attribute, by using default_cost(<slot_name>,<cost>) on the class, this will provide a default cost for the slot if no cost is set on the instance. Custom costs can be set on the instance with custom_cost(<slot_name>,<cost>). If cost is a CostModel, it will be assigned to the slot if it is not already assigned.

-

The economics term_length applies costs over the term, using the cost_property.mode to determine at which terms a cost should be applied.

-

@forge -class Parent(System,CostModel)

-
-

econ = Slot.define(Economics) #will calculate parent costs as well -cost = Slot.define(Widget) #slots automatically set to none if no input provided

-
-

Parent(econ=Economics(term_length=25,discount_rate=0.05,fixed_output=1000))

-

Functions

- - - - - - - - - -

eval_slot_cost

gend

-

Classes

- - - - - - - - - - - - - - - -

CostLog

Initialize a filter.

CostModel

CostModel is a mixin for components or systems that reports its costs through the cost system property, which by default sums the item_cost and sub_items_cost.

Economics

Economics is a component that summarizes costs and reports the economics of a system and its components in a recursive format

cost_property

A thin wrapper over system_property that will be accounted by Economics Components and apply term & categorization

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.fluid_material.Air.html b/docs/_build/html/_autosummary/engforge.eng.fluid_material.Air.html deleted file mode 100644 index 2b433a3..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.fluid_material.Air.html +++ /dev/null @@ -1,1544 +0,0 @@ - - - - - - - engforge.eng.fluid_material.Air — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.fluid_material.Air

-
-
-class Air(*, name=NOTHING, parent=None, P=100000.0, T=288)
-

Bases: CoolPropMaterial

-

Method generated by attrs for class CoolPropMaterial.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Psat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Tsat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

density([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

enthalpy([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

material

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

specific_heat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

state

static_A

static_B

static_C

static_D

static_F

static_K

surface_tension([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

system_id

returns an instance unique id based on id(self)

thermal_conductivity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

time

unique_hash

update_interval

viscosity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

parent

name

dataframe

-
-
Parameters:
-
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-__call__(*args, **kwargs)
-

calls coolprop module with args adding the material

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.fluid_material.AirWaterMix.html b/docs/_build/html/_autosummary/engforge.eng.fluid_material.AirWaterMix.html deleted file mode 100644 index baf5503..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.fluid_material.AirWaterMix.html +++ /dev/null @@ -1,1568 +0,0 @@ - - - - - - - engforge.eng.fluid_material.AirWaterMix — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.fluid_material.AirWaterMix

-
-
-class AirWaterMix(*, name=NOTHING, parent=None, P=100000.0, T=288)
-

Bases: CoolPropMixture

-

Method generated by attrs for class CoolPropMixture.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

setup

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_mass_ratios

add masses or massrates and molar ratio will be updated

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Mmass1([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Mmass2([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Psat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Tsat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

density([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

enthalpy([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

materail2

material([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

material1

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

specific_heat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

state

static_A

static_B

static_C

static_D

static_F

static_K

surface_tension([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

system_id

returns an instance unique id based on id(self)

thermal_conductivity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

time

unique_hash

update_interval

viscosity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

parent

name

dataframe

-
-
Parameters:
-
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-__call__(*args, **kwargs)
-

calls coolprop module with args adding the material

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_mass_ratios(m1, m2)
-

add masses or massrates and molar ratio will be updated

-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.fluid_material.CoolPropMaterial.html b/docs/_build/html/_autosummary/engforge.eng.fluid_material.CoolPropMaterial.html deleted file mode 100644 index 1f5c1e0..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.fluid_material.CoolPropMaterial.html +++ /dev/null @@ -1,1545 +0,0 @@ - - - - - - - engforge.eng.fluid_material.CoolPropMaterial — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.fluid_material.CoolPropMaterial

-
-
-class CoolPropMaterial(*, name=NOTHING, parent=None, P=100000.0, T=288)[source]
-

Bases: FluidMaterial

-

Uses coolprop equation of state

-

Method generated by attrs for class CoolPropMaterial.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Psat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Tsat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

density([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

enthalpy([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

specific_heat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

state

static_A

static_B

static_C

static_D

static_F

static_K

surface_tension([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

system_id

returns an instance unique id based on id(self)

thermal_conductivity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

time

unique_hash

update_interval

viscosity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

material

parent

name

dataframe

-
-
Parameters:
-
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-__call__(*args, **kwargs)[source]
-

calls coolprop module with args adding the material

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.fluid_material.CoolPropMixture.html b/docs/_build/html/_autosummary/engforge.eng.fluid_material.CoolPropMixture.html deleted file mode 100644 index 361d9fb..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.fluid_material.CoolPropMixture.html +++ /dev/null @@ -1,1569 +0,0 @@ - - - - - - - engforge.eng.fluid_material.CoolPropMixture — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.fluid_material.CoolPropMixture

-
-
-class CoolPropMixture(*, name=NOTHING, parent=None, P=100000.0, T=288)[source]
-

Bases: CoolPropMaterial

-

coolprop mixture of two elements… can only use T/Q, P/Q, T/P calls to coolprop

-

Method generated by attrs for class CoolPropMixture.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

setup

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_mass_ratios

add masses or massrates and molar ratio will be updated

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Mmass1([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Mmass2([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Psat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Tsat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

density([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

enthalpy([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

materail2

material([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

material1

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

specific_heat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

state

static_A

static_B

static_C

static_D

static_F

static_K

surface_tension([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

system_id

returns an instance unique id based on id(self)

thermal_conductivity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

time

unique_hash

update_interval

viscosity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

parent

name

dataframe

-
-
Parameters:
-
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-__call__(*args, **kwargs)
-

calls coolprop module with args adding the material

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_mass_ratios(m1, m2)[source]
-

add masses or massrates and molar ratio will be updated

-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.fluid_material.FluidMaterial.html b/docs/_build/html/_autosummary/engforge.eng.fluid_material.FluidMaterial.html deleted file mode 100644 index 2d85d6f..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.fluid_material.FluidMaterial.html +++ /dev/null @@ -1,1530 +0,0 @@ - - - - - - - engforge.eng.fluid_material.FluidMaterial — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.fluid_material.FluidMaterial

-
-
-class FluidMaterial(*, name=NOTHING, parent=None, P=100000.0, T=288)[source]
-

Bases: Component

-

Placeholder for pressure dependent material, defaults to ideal water

-

Method generated by attrs for class FluidMaterial.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

density

default functionality, assumed gas with eq-state= gas constant

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

surface_tension

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

viscosity

ideal fluid has no viscosity

parent

name

dataframe

-
-
Parameters:
-
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-abstract property density
-

default functionality, assumed gas with eq-state= gas constant

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-abstract property viscosity
-

ideal fluid has no viscosity

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.fluid_material.Hydrogen.html b/docs/_build/html/_autosummary/engforge.eng.fluid_material.Hydrogen.html deleted file mode 100644 index 3099c22..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.fluid_material.Hydrogen.html +++ /dev/null @@ -1,1544 +0,0 @@ - - - - - - - engforge.eng.fluid_material.Hydrogen — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.fluid_material.Hydrogen

-
-
-class Hydrogen(*, name=NOTHING, parent=None, P=100000.0, T=288)
-

Bases: CoolPropMaterial

-

Method generated by attrs for class CoolPropMaterial.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Psat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Tsat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

density([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

enthalpy([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

material

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

specific_heat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

state

static_A

static_B

static_C

static_D

static_F

static_K

surface_tension([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

system_id

returns an instance unique id based on id(self)

thermal_conductivity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

time

unique_hash

update_interval

viscosity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

parent

name

dataframe

-
-
Parameters:
-
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-__call__(*args, **kwargs)
-

calls coolprop module with args adding the material

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.fluid_material.IdealAir.html b/docs/_build/html/_autosummary/engforge.eng.fluid_material.IdealAir.html deleted file mode 100644 index fb1570c..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.fluid_material.IdealAir.html +++ /dev/null @@ -1,1521 +0,0 @@ - - - - - - - engforge.eng.fluid_material.IdealAir — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.fluid_material.IdealAir

-
-
-class IdealAir(*, name=NOTHING, parent=None, P=100000.0, T=288, gas_constant=287.0)
-

Bases: IdealGas

-

Method generated by attrs for class IdealGas.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

density([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

gas_constant

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

surface_tension

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

viscosity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

parent

name

dataframe

-
-
Parameters:
-
    -

  • name (str)

    • -

  • parent (Component | System)

    • -

  • P (float)

    • -

  • T (float)

    • -

  • gas_constant (float)

    • -
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.fluid_material.IdealGas.html b/docs/_build/html/_autosummary/engforge.eng.fluid_material.IdealGas.html deleted file mode 100644 index 14899ab..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.fluid_material.IdealGas.html +++ /dev/null @@ -1,1519 +0,0 @@ - - - - - - - engforge.eng.fluid_material.IdealGas — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.fluid_material.IdealGas

-
-
-class IdealGas(*, name=NOTHING, parent=None, P=100000.0, T=288, gas_constant=287.0)[source]
-

Bases: FluidMaterial

-

Material Defaults To Gas Properties, so eq_of_state is just Rgas, no viscosity, defaults to air

-

Method generated by attrs for class IdealGas.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

density([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

surface_tension

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

viscosity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

parent

name

dataframe

-
-
Parameters:
-
    -

  • name (str)

    • -

  • parent (Component | System)

    • -

  • P (float)

    • -

  • T (float)

    • -

  • gas_constant (float)

    • -
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.fluid_material.IdealH2.html b/docs/_build/html/_autosummary/engforge.eng.fluid_material.IdealH2.html deleted file mode 100644 index d375a97..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.fluid_material.IdealH2.html +++ /dev/null @@ -1,1521 +0,0 @@ - - - - - - - engforge.eng.fluid_material.IdealH2 — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.fluid_material.IdealH2

-
-
-class IdealH2(*, name=NOTHING, parent=None, P=100000.0, T=288, gas_constant=287.0)
-

Bases: IdealGas

-

Method generated by attrs for class IdealGas.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

density([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

gas_constant

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

surface_tension

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

viscosity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

parent

name

dataframe

-
-
Parameters:
-
    -

  • name (str)

    • -

  • parent (Component | System)

    • -

  • P (float)

    • -

  • T (float)

    • -

  • gas_constant (float)

    • -
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.fluid_material.IdealOxygen.html b/docs/_build/html/_autosummary/engforge.eng.fluid_material.IdealOxygen.html deleted file mode 100644 index 33f29dd..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.fluid_material.IdealOxygen.html +++ /dev/null @@ -1,1521 +0,0 @@ - - - - - - - engforge.eng.fluid_material.IdealOxygen — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.fluid_material.IdealOxygen

-
-
-class IdealOxygen(*, name=NOTHING, parent=None, P=100000.0, T=288, gas_constant=287.0)
-

Bases: IdealGas

-

Method generated by attrs for class IdealGas.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

density([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

gas_constant

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

surface_tension

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

viscosity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

parent

name

dataframe

-
-
Parameters:
-
    -

  • name (str)

    • -

  • parent (Component | System)

    • -

  • P (float)

    • -

  • T (float)

    • -

  • gas_constant (float)

    • -
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.fluid_material.IdealSteam.html b/docs/_build/html/_autosummary/engforge.eng.fluid_material.IdealSteam.html deleted file mode 100644 index c172cb4..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.fluid_material.IdealSteam.html +++ /dev/null @@ -1,1521 +0,0 @@ - - - - - - - engforge.eng.fluid_material.IdealSteam — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.fluid_material.IdealSteam

-
-
-class IdealSteam(*, name=NOTHING, parent=None, P=100000.0, T=288, gas_constant=287.0)
-

Bases: IdealGas

-

Method generated by attrs for class IdealGas.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

density([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

gas_constant

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

surface_tension

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

viscosity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

parent

name

dataframe

-
-
Parameters:
-
    -

  • name (str)

    • -

  • parent (Component | System)

    • -

  • P (float)

    • -

  • T (float)

    • -

  • gas_constant (float)

    • -
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.fluid_material.Oxygen.html b/docs/_build/html/_autosummary/engforge.eng.fluid_material.Oxygen.html deleted file mode 100644 index 227323f..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.fluid_material.Oxygen.html +++ /dev/null @@ -1,1544 +0,0 @@ - - - - - - - engforge.eng.fluid_material.Oxygen — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.fluid_material.Oxygen

-
-
-class Oxygen(*, name=NOTHING, parent=None, P=100000.0, T=288)
-

Bases: CoolPropMaterial

-

Method generated by attrs for class CoolPropMaterial.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Psat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Tsat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

density([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

enthalpy([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

material

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

specific_heat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

state

static_A

static_B

static_C

static_D

static_F

static_K

surface_tension([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

system_id

returns an instance unique id based on id(self)

thermal_conductivity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

time

unique_hash

update_interval

viscosity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

parent

name

dataframe

-
-
Parameters:
-
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-__call__(*args, **kwargs)
-

calls coolprop module with args adding the material

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.fluid_material.SeaWater.html b/docs/_build/html/_autosummary/engforge.eng.fluid_material.SeaWater.html deleted file mode 100644 index 02f3c9b..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.fluid_material.SeaWater.html +++ /dev/null @@ -1,1544 +0,0 @@ - - - - - - - engforge.eng.fluid_material.SeaWater — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.fluid_material.SeaWater

-
-
-class SeaWater(*, name=NOTHING, parent=None, P=100000.0, T=288)
-

Bases: CoolPropMaterial

-

Method generated by attrs for class CoolPropMaterial.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Psat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Tsat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

density([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

enthalpy([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

material

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

specific_heat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

state

static_A

static_B

static_C

static_D

static_F

static_K

surface_tension([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

system_id

returns an instance unique id based on id(self)

thermal_conductivity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

time

unique_hash

update_interval

viscosity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

parent

name

dataframe

-
-
Parameters:
-
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-__call__(*args, **kwargs)
-

calls coolprop module with args adding the material

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.fluid_material.Steam.html b/docs/_build/html/_autosummary/engforge.eng.fluid_material.Steam.html deleted file mode 100644 index 788b318..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.fluid_material.Steam.html +++ /dev/null @@ -1,1544 +0,0 @@ - - - - - - - engforge.eng.fluid_material.Steam — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.fluid_material.Steam

-
-
-class Steam(*, name=NOTHING, parent=None, P=100000.0, T=288)
-

Bases: CoolPropMaterial

-

Method generated by attrs for class CoolPropMaterial.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Psat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Tsat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

density([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

enthalpy([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

material

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

specific_heat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

state

static_A

static_B

static_C

static_D

static_F

static_K

surface_tension([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

system_id

returns an instance unique id based on id(self)

thermal_conductivity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

time

unique_hash

update_interval

viscosity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

parent

name

dataframe

-
-
Parameters:
-
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-__call__(*args, **kwargs)
-

calls coolprop module with args adding the material

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.fluid_material.Water.html b/docs/_build/html/_autosummary/engforge.eng.fluid_material.Water.html deleted file mode 100644 index f0bea50..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.fluid_material.Water.html +++ /dev/null @@ -1,1544 +0,0 @@ - - - - - - - engforge.eng.fluid_material.Water — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.fluid_material.Water

-
-
-class Water(*, name=NOTHING, parent=None, P=100000.0, T=288)
-

Bases: CoolPropMaterial

-

Method generated by attrs for class CoolPropMaterial.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Psat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Tsat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

density([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

enthalpy([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

material

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

specific_heat([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

state

static_A

static_B

static_C

static_D

static_F

static_K

surface_tension([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

system_id

returns an instance unique id based on id(self)

thermal_conductivity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

time

unique_hash

update_interval

viscosity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

parent

name

dataframe

-
-
Parameters:
-
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-__call__(*args, **kwargs)
-

calls coolprop module with args adding the material

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.fluid_material.html b/docs/_build/html/_autosummary/engforge.eng.fluid_material.html deleted file mode 100644 index 722e10c..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.fluid_material.html +++ /dev/null @@ -1,225 +0,0 @@ - - - - - - - engforge.eng.fluid_material — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.fluid_material

-

Classes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Air

Method generated by attrs for class CoolPropMaterial.

AirWaterMix

Method generated by attrs for class CoolPropMixture.

CoolPropMaterial

Uses coolprop equation of state

CoolPropMixture

coolprop mixture of two elements.

FluidMaterial

Placeholder for pressure dependent material, defaults to ideal water

Hydrogen

Method generated by attrs for class CoolPropMaterial.

IdealAir

Method generated by attrs for class IdealGas.

IdealGas

Material Defaults To Gas Properties, so eq_of_state is just Rgas, no viscosity, defaults to air

IdealH2

Method generated by attrs for class IdealGas.

IdealOxygen

Method generated by attrs for class IdealGas.

IdealSteam

Method generated by attrs for class IdealGas.

Oxygen

Method generated by attrs for class CoolPropMaterial.

SeaWater

Method generated by attrs for class CoolPropMaterial.

Steam

Method generated by attrs for class CoolPropMaterial.

Water

Method generated by attrs for class CoolPropMaterial.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.geometry.Circle.html b/docs/_build/html/_autosummary/engforge.eng.geometry.Circle.html deleted file mode 100644 index af467c3..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.geometry.Circle.html +++ /dev/null @@ -1,852 +0,0 @@ - - - - - - - engforge.eng.geometry.Circle — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.geometry.Circle

-
-
-class Circle(*, name='rectangular section', d)[source]
-

Bases: Profile2D

-

models a solid circle with diameter d

-

Method generated by attrs for class Circle.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

add_prediction_record

adds a record to the prediction records, and calcultes the average and variance of the data :type record: :param record: a dict of the record :type extra_add: :param extra_add: if true, the record is added to the prediction records even if the data is inbounds :returns: a boolean indicating if the record was out of bounds of current data (therefor should be added)

calculate_stress

change_all_log_lvl

check_and_retrain

Checks if more data than threshold to train or if error is sufficiently low to ignore retraining, or if more data already exists than window size (no training)

check_out_of_domain

checks if the record is in bounds of the current data

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_inst_attributes

collects all the attributes for a system

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

display_results

error

Writes to log as a error

estimate_stress

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

observe_and_predict

uses the existing models to predict the row and measure the error

parent_configurations_cls

returns all subclasses that are a Configuration

plot_attributes

Lists all plot attributes for class

plot_mesh

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

prediction_dataframe

prediction_weights

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

score_data

scores a dataframe

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

table_fields

trace_attributes

Lists all trace attributes for class

train_compare

Use the dataframe to train the models, and compare the results to the current models using train_frac to divide total samples into training and testing sets, unless train_full is set.

training_callback

override to provide a callback when training is complete, such as saving the models

transients_attributes

Lists all signals attributes for class

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

A

Ao

outside area, over ride for hallow sections

Ixx

Iyy

J

as_dict

returns values as they are in the class instance

attrs_fields

basis

classname

Shorthand for the classname

displayname

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

log_silo

logger

numeric_as_dict

numeric_hash

prediction_goal_error

prediction_records

slack_webhook_url

train_window

trained

unique_hash

x_bounds

y_bounds

d

name

-
-
Parameters:
-
    -

  • name (str)

    • -

  • d (float)

    • -
-
-
-
-
-property Ao
-

outside area, over ride for hallow sections

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-add_prediction_record(record, extra_add=True, mult_sigma=1, target_items=1000)
-

adds a record to the prediction records, and calcultes the average and variance of the data -:type record: -:param record: a dict of the record -:type extra_add: -:param extra_add: if true, the record is added to the prediction records even if the data is inbounds -:returns: a boolean indicating if the record was out of bounds of current data (therefor should be added)

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-check_and_retrain(records, min_rec=None)
-

Checks if more data than threshold to train or if error is sufficiently low to ignore retraining, or if more data already exists than window size (no training)

-
- -
-
-check_out_of_domain(record, extra_margin=1, target_items=1000)
-

checks if the record is in bounds of the current data

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-observe_and_predict(row)
-

uses the existing models to predict the row and measure the error

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-score_data(df)
-

scores a dataframe

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-train_compare(df, test_frac=2, train_full=False, min_rec=250)
-

Use the dataframe to train the models, and compare the results to the current models using train_frac to divide total samples into training and testing sets, unless train_full is set.

-
-
Parameters:
-
    -

  • df – dataframe to train with

    • -

  • test_frac – N/train_frac will be size of the training window

    • -

  • train_full – boolean to use full training data

    • -
-
-
Returns:
-

trained models

-
-
-
- -
-
-training_callback(models)
-

override to provide a callback when training is complete, such as saving the models

-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.geometry.GeometryLog.html b/docs/_build/html/_autosummary/engforge.eng.geometry.GeometryLog.html deleted file mode 100644 index ebe9568..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.geometry.GeometryLog.html +++ /dev/null @@ -1,339 +0,0 @@ - - - - - - - engforge.eng.geometry.GeometryLog — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.geometry.GeometryLog

-
-
-class GeometryLog(name='')[source]
-

Bases: LoggingMixin

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.geometry.HollowCircle.html b/docs/_build/html/_autosummary/engforge.eng.geometry.HollowCircle.html deleted file mode 100644 index b880046..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.geometry.HollowCircle.html +++ /dev/null @@ -1,859 +0,0 @@ - - - - - - - engforge.eng.geometry.HollowCircle — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.geometry.HollowCircle

-
-
-class HollowCircle(*, name='rectangular section', d, t)[source]
-

Bases: Profile2D

-

models a hollow circle with diameter d and thickness t

-

Method generated by attrs for class HollowCircle.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

add_prediction_record

adds a record to the prediction records, and calcultes the average and variance of the data :type record: :param record: a dict of the record :type extra_add: :param extra_add: if true, the record is added to the prediction records even if the data is inbounds :returns: a boolean indicating if the record was out of bounds of current data (therefor should be added)

calculate_stress

change_all_log_lvl

check_and_retrain

Checks if more data than threshold to train or if error is sufficiently low to ignore retraining, or if more data already exists than window size (no training)

check_out_of_domain

checks if the record is in bounds of the current data

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_inst_attributes

collects all the attributes for a system

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

display_results

error

Writes to log as a error

estimate_stress

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

observe_and_predict

uses the existing models to predict the row and measure the error

parent_configurations_cls

returns all subclasses that are a Configuration

plot_attributes

Lists all plot attributes for class

plot_mesh

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

prediction_dataframe

prediction_weights

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

score_data

scores a dataframe

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

table_fields

trace_attributes

Lists all trace attributes for class

train_compare

Use the dataframe to train the models, and compare the results to the current models using train_frac to divide total samples into training and testing sets, unless train_full is set.

training_callback

override to provide a callback when training is complete, such as saving the models

transients_attributes

Lists all signals attributes for class

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

A

Ao

outside area, over ride for hallow sections

Ixx

Iyy

J

as_dict

returns values as they are in the class instance

attrs_fields

basis

classname

Shorthand for the classname

di

displayname

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

log_silo

logger

numeric_as_dict

numeric_hash

prediction_goal_error

prediction_records

slack_webhook_url

train_window

trained

unique_hash

x_bounds

y_bounds

d

t

name

-
-
Parameters:
-
    -

  • name (str)

    • -

  • d (float)

    • -

  • t (float)

    • -
-
-
-
-
-property Ao
-

outside area, over ride for hallow sections

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-add_prediction_record(record, extra_add=True, mult_sigma=1, target_items=1000)
-

adds a record to the prediction records, and calcultes the average and variance of the data -:type record: -:param record: a dict of the record -:type extra_add: -:param extra_add: if true, the record is added to the prediction records even if the data is inbounds -:returns: a boolean indicating if the record was out of bounds of current data (therefor should be added)

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-check_and_retrain(records, min_rec=None)
-

Checks if more data than threshold to train or if error is sufficiently low to ignore retraining, or if more data already exists than window size (no training)

-
- -
-
-check_out_of_domain(record, extra_margin=1, target_items=1000)
-

checks if the record is in bounds of the current data

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-observe_and_predict(row)
-

uses the existing models to predict the row and measure the error

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-score_data(df)
-

scores a dataframe

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-train_compare(df, test_frac=2, train_full=False, min_rec=250)
-

Use the dataframe to train the models, and compare the results to the current models using train_frac to divide total samples into training and testing sets, unless train_full is set.

-
-
Parameters:
-
    -

  • df – dataframe to train with

    • -

  • test_frac – N/train_frac will be size of the training window

    • -

  • train_full – boolean to use full training data

    • -
-
-
Returns:
-

trained models

-
-
-
- -
-
-training_callback(models)
-

override to provide a callback when training is complete, such as saving the models

-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.geometry.ParametricSpline.html b/docs/_build/html/_autosummary/engforge.eng.geometry.ParametricSpline.html deleted file mode 100644 index 9eb7042..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.geometry.ParametricSpline.html +++ /dev/null @@ -1,207 +0,0 @@ - - - - - - - engforge.eng.geometry.ParametricSpline — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.geometry.ParametricSpline

-
-
-class ParametricSpline(P1, P2, P1ds, P2ds)[source]
-

Bases: object

-

a multivariate spline defined by uniform length vector input, with points P1,P2 and their slopes P1ds,P2ds

-

Method generated by attrs for class ParametricSpline.

-

Methods

- - - - - - -

coords

-

Attributes

- - - - - - - - - - - - - - - -

a0

a1

a2

a3

-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.geometry.Profile2D.html b/docs/_build/html/_autosummary/engforge.eng.geometry.Profile2D.html deleted file mode 100644 index 0bbb39b..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.geometry.Profile2D.html +++ /dev/null @@ -1,845 +0,0 @@ - - - - - - - engforge.eng.geometry.Profile2D — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.geometry.Profile2D

-
-
-class Profile2D(*, name='generic cross section')[source]
-

Bases: Configuration, PredictionMixin

-

Method generated by attrs for class Profile2D.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

add_prediction_record

adds a record to the prediction records, and calcultes the average and variance of the data :type record: :param record: a dict of the record :type extra_add: :param extra_add: if true, the record is added to the prediction records even if the data is inbounds :returns: a boolean indicating if the record was out of bounds of current data (therefor should be added)

calculate_stress

change_all_log_lvl

check_and_retrain

Checks if more data than threshold to train or if error is sufficiently low to ignore retraining, or if more data already exists than window size (no training)

check_out_of_domain

checks if the record is in bounds of the current data

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_inst_attributes

collects all the attributes for a system

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

display_results

error

Writes to log as a error

estimate_stress

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

observe_and_predict

uses the existing models to predict the row and measure the error

parent_configurations_cls

returns all subclasses that are a Configuration

plot_attributes

Lists all plot attributes for class

plot_mesh

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

prediction_dataframe

prediction_weights

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

score_data

scores a dataframe

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

table_fields

trace_attributes

Lists all trace attributes for class

train_compare

Use the dataframe to train the models, and compare the results to the current models using train_frac to divide total samples into training and testing sets, unless train_full is set.

training_callback

override to provide a callback when training is complete, such as saving the models

transients_attributes

Lists all signals attributes for class

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

A

Ao

outside area, over ride for hallow sections

Ixx

Iyy

J

as_dict

returns values as they are in the class instance

attrs_fields

basis

classname

Shorthand for the classname

displayname

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

log_silo

logger

numeric_as_dict

numeric_hash

prediction_goal_error

prediction_records

slack_webhook_url

train_window

trained

unique_hash

x_bounds

y_bounds

name

-
-
Parameters:
-

name (str)

-
-
-
-
-property Ao
-

outside area, over ride for hallow sections

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-add_prediction_record(record, extra_add=True, mult_sigma=1, target_items=1000)
-

adds a record to the prediction records, and calcultes the average and variance of the data -:type record: -:param record: a dict of the record -:type extra_add: -:param extra_add: if true, the record is added to the prediction records even if the data is inbounds -:returns: a boolean indicating if the record was out of bounds of current data (therefor should be added)

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-check_and_retrain(records, min_rec=None)
-

Checks if more data than threshold to train or if error is sufficiently low to ignore retraining, or if more data already exists than window size (no training)

-
- -
-
-check_out_of_domain(record, extra_margin=1, target_items=1000)
-

checks if the record is in bounds of the current data

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-observe_and_predict(row)
-

uses the existing models to predict the row and measure the error

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-score_data(df)
-

scores a dataframe

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-train_compare(df, test_frac=2, train_full=False, min_rec=250)
-

Use the dataframe to train the models, and compare the results to the current models using train_frac to divide total samples into training and testing sets, unless train_full is set.

-
-
Parameters:
-
    -

  • df – dataframe to train with

    • -

  • test_frac – N/train_frac will be size of the training window

    • -

  • train_full – boolean to use full training data

    • -
-
-
Returns:
-

trained models

-
-
-
- -
-
-training_callback(models)
-

override to provide a callback when training is complete, such as saving the models

-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.geometry.Rectangle.html b/docs/_build/html/_autosummary/engforge.eng.geometry.Rectangle.html deleted file mode 100644 index b8f8d0a..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.geometry.Rectangle.html +++ /dev/null @@ -1,856 +0,0 @@ - - - - - - - engforge.eng.geometry.Rectangle — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.geometry.Rectangle

-
-
-class Rectangle(*, name='rectangular section', b, h)[source]
-

Bases: Profile2D

-

models rectangle with base b, and height h

-

Method generated by attrs for class Rectangle.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

add_prediction_record

adds a record to the prediction records, and calcultes the average and variance of the data :type record: :param record: a dict of the record :type extra_add: :param extra_add: if true, the record is added to the prediction records even if the data is inbounds :returns: a boolean indicating if the record was out of bounds of current data (therefor should be added)

calculate_stress

change_all_log_lvl

check_and_retrain

Checks if more data than threshold to train or if error is sufficiently low to ignore retraining, or if more data already exists than window size (no training)

check_out_of_domain

checks if the record is in bounds of the current data

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_inst_attributes

collects all the attributes for a system

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

display_results

error

Writes to log as a error

estimate_stress

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

observe_and_predict

uses the existing models to predict the row and measure the error

parent_configurations_cls

returns all subclasses that are a Configuration

plot_attributes

Lists all plot attributes for class

plot_mesh

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

prediction_dataframe

prediction_weights

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

score_data

scores a dataframe

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

table_fields

trace_attributes

Lists all trace attributes for class

train_compare

Use the dataframe to train the models, and compare the results to the current models using train_frac to divide total samples into training and testing sets, unless train_full is set.

training_callback

override to provide a callback when training is complete, such as saving the models

transients_attributes

Lists all signals attributes for class

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

A

Ao

outside area, over ride for hallow sections

Ixx

Iyy

J

as_dict

returns values as they are in the class instance

attrs_fields

basis

classname

Shorthand for the classname

displayname

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

log_silo

logger

numeric_as_dict

numeric_hash

prediction_goal_error

prediction_records

slack_webhook_url

train_window

trained

unique_hash

x_bounds

y_bounds

b

h

name

-
-
Parameters:
-
    -

  • name (str)

    • -

  • b (float)

    • -

  • h (float)

    • -
-
-
-
-
-property Ao
-

outside area, over ride for hallow sections

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-add_prediction_record(record, extra_add=True, mult_sigma=1, target_items=1000)
-

adds a record to the prediction records, and calcultes the average and variance of the data -:type record: -:param record: a dict of the record -:type extra_add: -:param extra_add: if true, the record is added to the prediction records even if the data is inbounds -:returns: a boolean indicating if the record was out of bounds of current data (therefor should be added)

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-check_and_retrain(records, min_rec=None)
-

Checks if more data than threshold to train or if error is sufficiently low to ignore retraining, or if more data already exists than window size (no training)

-
- -
-
-check_out_of_domain(record, extra_margin=1, target_items=1000)
-

checks if the record is in bounds of the current data

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-observe_and_predict(row)
-

uses the existing models to predict the row and measure the error

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-score_data(df)
-

scores a dataframe

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-train_compare(df, test_frac=2, train_full=False, min_rec=250)
-

Use the dataframe to train the models, and compare the results to the current models using train_frac to divide total samples into training and testing sets, unless train_full is set.

-
-
Parameters:
-
    -

  • df – dataframe to train with

    • -

  • test_frac – N/train_frac will be size of the training window

    • -

  • train_full – boolean to use full training data

    • -
-
-
Returns:
-

trained models

-
-
-
- -
-
-training_callback(models)
-

override to provide a callback when training is complete, such as saving the models

-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.geometry.ShapelySection.html b/docs/_build/html/_autosummary/engforge.eng.geometry.ShapelySection.html deleted file mode 100644 index c02ccf6..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.geometry.ShapelySection.html +++ /dev/null @@ -1,1047 +0,0 @@ - - - - - - - engforge.eng.geometry.ShapelySection — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.geometry.ShapelySection

-
-
-class ShapelySection(*, name='shapely section', shape, coarse=False, mesh_extent_decimation=100, min_mesh_angle=20, min_mesh_size=1e-05, goal_elements=1000, material=None, failure_mode='von_mises', prediction=False, prediction_goal_error=0.025, max_records=10000)[source]
-

Bases: Profile2D

-

a 2D profile that takes a shapely section to calculate section properties, use a sectionproperties section with hidden variable _geo to bypass shape calculation

-

Method generated by attrs for class ShapelySection.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

add_prediction_record

adds a record to the prediction records, and calcultes the average and variance of the data :type record: :param record: a dict of the record :type extra_add: :param extra_add: if true, the record is added to the prediction records even if the data is inbounds :returns: a boolean indicating if the record was out of bounds of current data (therefor should be added)

basis_expand

run combinations of parameters and permutations of weights against the basis values to populate the stress records, by default using estimation logic to speed up the process

calculate_bounds

calculate_mesh_size

calculate_stress

change_all_log_lvl

check_and_retrain

Checks if more data than threshold to train or if error is sufficiently low to ignore retraining, or if more data already exists than window size (no training)

check_out_of_domain

checks if the record is in bounds of the current data

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

check_symmetric

checks if the section is symmetric about the x and y axis, by finding the intersection of

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_inst_attributes

collects all the attributes for a system

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_failure_front

determine_failure_stress

uses the failure mode to compare to allowable stress

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

display_results

error

Writes to log as a error

estimate_failure

uses a support vector machine to estimate stresses and returns a number zero or one to indicate failure, if prediction is set to True, otherwise calculates stress

estimate_stress

uses a support vector machine to estimate stresses and returns the ratio of the allowable stress, also known as the failure fracion if prediction is set to True, otherwise calculates stress

extract_message

fail_frac_criteria

fail_learning

optimizes stress until failure, given base_kw arguments for extra parameters

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

from_cache

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

hash_id

string for saving to persisting

info

Writes to log but with info category, these are important typically and inform about progress of process in general

init_with_material

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

mesh_section

caches section properties and mesh

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

observe_and_predict

uses the existing models to predict the row and measure the error

parent_configurations_cls

returns all subclasses that are a Configuration

plot_attributes

Lists all plot attributes for class

plot_mesh

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

prediction_dataframe

prediction_weights

random_force_input

record_stress

determines if stress record should be added to prediction_records

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

reset_prediction

score_data

scores a dataframe

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solve_fail

solvers_attributes

Lists all signals attributes for class

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

table_fields

trace_attributes

Lists all trace attributes for class

train_compare

Use the dataframe to train the models, and compare the results to the current models using train_frac to divide total samples into training and testing sets, unless train_full is set.

train_until_valid

trains the prediction models until the error is below the goal error

training_callback

when training is complete save the model to a pickle with ShapelySection_<hash>.pkl

transients_attributes

Lists all signals attributes for class

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

A

Ao

outside area, over ride for hallow sections

Ixx

Ixy

Iyy

J

as_dict

returns values as they are in the class instance

attrs_fields

basis

cache_name

cache_path

classname

Shorthand for the classname

displayname

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

log_silo

logger

max_margin

max_rec_parm

mesh_size

meta_name

meta_path

min_mesh_area

near_margin

numeric_as_dict

numeric_hash

prediction_goal_error

prediction_records

save_threshold

section_cache

slack_webhook_url

train_window

trained

unique_hash

x_bounds

y_bounds

name

shape

coarse

min_mesh_angle

min_mesh_size

goal_elements

material

prediction

max_records

-
-
Parameters:
-
    -

  • name (str)

    • -

  • shape (Polygon)

    • -

  • coarse (bool)

    • -

  • min_mesh_angle (float)

    • -

  • min_mesh_size (float)

    • -

  • goal_elements (float)

    • -

  • material (Material)

    • -

  • failure_mode (str)

    • -

  • prediction (bool)

    • -

  • prediction_goal_error (float)

    • -

  • max_records (list)

    • -
-
-
-
-
-property Ao
-

outside area, over ride for hallow sections

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-add_prediction_record(record, extra_add=True, mult_sigma=1, target_items=1000)
-

adds a record to the prediction records, and calcultes the average and variance of the data -:type record: -:param record: a dict of the record -:type extra_add: -:param extra_add: if true, the record is added to the prediction records even if the data is inbounds -:returns: a boolean indicating if the record was out of bounds of current data (therefor should be added)

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-basis_expand(expand_values=[0.9, 0.75, 0.5, 0.1, 0.01], Nparm=4, est=True, normalize=True)[source]
-

run combinations of parameters and permutations of weights against the basis values to populate the stress records, by default using estimation logic to speed up the process

-
- -
-
-check_and_retrain(records, min_rec=None)
-

Checks if more data than threshold to train or if error is sufficiently low to ignore retraining, or if more data already exists than window size (no training)

-
- -
-
-check_out_of_domain(record, extra_margin=1, target_items=1000)
-

checks if the record is in bounds of the current data

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-check_symmetric(precision=3, Nincr=180)[source]
-

checks if the section is symmetric about the x and y axis, by finding the intersection of

-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_failure_stress(stress_obj)[source]
-

uses the failure mode to compare to allowable stress

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-estimate_failure(n=0, vx=0, vy=0, mxx=0, myy=0, mzz=0)[source]
-

uses a support vector machine to estimate stresses and returns a number zero or one to indicate failure, if prediction is set to True, otherwise calculates stress

-
-
Return type:
-

float

-
-
-
- -
-
-estimate_stress(n=0, vx=0, vy=0, mxx=0, myy=0, mzz=0, value=False, calc_margin=2, min_est_records=100, calc_every=25, pre_train_margin=2, force_calc=False)[source]
-

uses a support vector machine to estimate stresses and returns the ratio of the allowable stress, also known as the failure fracion if prediction is set to True, otherwise calculates stress

-
-
Return type:
-

float

-
-
-
- -
-
-fail_learning(X, parm, base_kw, mult=1)[source]
-

optimizes stress until failure, given base_kw arguments for extra parameters

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-hash_id()[source]
-

string for saving to persisting

-
-
Return type:
-

str

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-mesh_section()[source]
-

caches section properties and mesh

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-observe_and_predict(row)
-

uses the existing models to predict the row and measure the error

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-record_stress(stress_dict)[source]
-

determines if stress record should be added to prediction_records

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-score_data(df)
-

scores a dataframe

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-train_compare(df, test_frac=2, train_full=False, min_rec=250)
-

Use the dataframe to train the models, and compare the results to the current models using train_frac to divide total samples into training and testing sets, unless train_full is set.

-
-
Parameters:
-
    -

  • df – dataframe to train with

    • -

  • test_frac – N/train_frac will be size of the training window

    • -

  • train_full – boolean to use full training data

    • -
-
-
Returns:
-

trained models

-
-
-
- -
-
-train_until_valid(print_interval=50, max_iter=1000, est=False)[source]
-

trains the prediction models until the error is below the goal error

-
- -
-
-training_callback(models)[source]
-

when training is complete save the model to a pickle with ShapelySection_<hash>.pkl

-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.geometry.Triangle.html b/docs/_build/html/_autosummary/engforge.eng.geometry.Triangle.html deleted file mode 100644 index 2a323fd..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.geometry.Triangle.html +++ /dev/null @@ -1,856 +0,0 @@ - - - - - - - engforge.eng.geometry.Triangle — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.geometry.Triangle

-
-
-class Triangle(*, name='rectangular section', b, h)[source]
-

Bases: Profile2D

-

models a triangle with base, b and height h

-

Method generated by attrs for class Triangle.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

add_prediction_record

adds a record to the prediction records, and calcultes the average and variance of the data :type record: :param record: a dict of the record :type extra_add: :param extra_add: if true, the record is added to the prediction records even if the data is inbounds :returns: a boolean indicating if the record was out of bounds of current data (therefor should be added)

calculate_stress

change_all_log_lvl

check_and_retrain

Checks if more data than threshold to train or if error is sufficiently low to ignore retraining, or if more data already exists than window size (no training)

check_out_of_domain

checks if the record is in bounds of the current data

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_inst_attributes

collects all the attributes for a system

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

display_results

error

Writes to log as a error

estimate_stress

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

observe_and_predict

uses the existing models to predict the row and measure the error

parent_configurations_cls

returns all subclasses that are a Configuration

plot_attributes

Lists all plot attributes for class

plot_mesh

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

prediction_dataframe

prediction_weights

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

score_data

scores a dataframe

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

table_fields

trace_attributes

Lists all trace attributes for class

train_compare

Use the dataframe to train the models, and compare the results to the current models using train_frac to divide total samples into training and testing sets, unless train_full is set.

training_callback

override to provide a callback when training is complete, such as saving the models

transients_attributes

Lists all signals attributes for class

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

A

Ao

outside area, over ride for hallow sections

Ixx

Iyy

J

as_dict

returns values as they are in the class instance

attrs_fields

basis

classname

Shorthand for the classname

displayname

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

log_silo

logger

numeric_as_dict

numeric_hash

prediction_goal_error

prediction_records

slack_webhook_url

train_window

trained

unique_hash

x_bounds

y_bounds

b

h

name

-
-
Parameters:
-
    -

  • name (str)

    • -

  • b (float)

    • -

  • h (float)

    • -
-
-
-
-
-property Ao
-

outside area, over ride for hallow sections

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-add_prediction_record(record, extra_add=True, mult_sigma=1, target_items=1000)
-

adds a record to the prediction records, and calcultes the average and variance of the data -:type record: -:param record: a dict of the record -:type extra_add: -:param extra_add: if true, the record is added to the prediction records even if the data is inbounds -:returns: a boolean indicating if the record was out of bounds of current data (therefor should be added)

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-check_and_retrain(records, min_rec=None)
-

Checks if more data than threshold to train or if error is sufficiently low to ignore retraining, or if more data already exists than window size (no training)

-
- -
-
-check_out_of_domain(record, extra_margin=1, target_items=1000)
-

checks if the record is in bounds of the current data

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-observe_and_predict(row)
-

uses the existing models to predict the row and measure the error

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-score_data(df)
-

scores a dataframe

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-train_compare(df, test_frac=2, train_full=False, min_rec=250)
-

Use the dataframe to train the models, and compare the results to the current models using train_frac to divide total samples into training and testing sets, unless train_full is set.

-
-
Parameters:
-
    -

  • df – dataframe to train with

    • -

  • test_frac – N/train_frac will be size of the training window

    • -

  • train_full – boolean to use full training data

    • -
-
-
Returns:
-

trained models

-
-
-
- -
-
-training_callback(models)
-

override to provide a callback when training is complete, such as saving the models

-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.geometry.calculate_stress.html b/docs/_build/html/_autosummary/engforge.eng.geometry.calculate_stress.html deleted file mode 100644 index 351620f..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.geometry.calculate_stress.html +++ /dev/null @@ -1,185 +0,0 @@ - - - - - - - engforge.eng.geometry.calculate_stress — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.geometry.calculate_stress

-
-
-calculate_stress(section, n=0, vx=0, vy=0, mxx=0, myy=0, mzz=0, raw=False, row=False, record=True, value=True)[source]
-

returns the maximum vonmises stress in the section and returns the ratio of the allowable stress, also known as the failure fracion -:type raw: -:param raw: if raw is true, the stress object is returned, otherwise the failure fraction is returned

-
-
Return type:
-

float

-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.geometry.conver_np.html b/docs/_build/html/_autosummary/engforge.eng.geometry.conver_np.html deleted file mode 100644 index b8a75b5..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.geometry.conver_np.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - - engforge.eng.geometry.conver_np — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.geometry.conver_np

-
-
-conver_np(inpt)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.geometry.get_mesh_size.html b/docs/_build/html/_autosummary/engforge.eng.geometry.get_mesh_size.html deleted file mode 100644 index 538e2c4..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.geometry.get_mesh_size.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - - engforge.eng.geometry.get_mesh_size — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.geometry.get_mesh_size

-
-
-get_mesh_size(inst)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.geometry.html b/docs/_build/html/_autosummary/engforge.eng.geometry.html deleted file mode 100644 index a41035e..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.geometry.html +++ /dev/null @@ -1,215 +0,0 @@ - - - - - - - engforge.eng.geometry — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.geometry

-

These exist as in interface to sectionproperties from PyNite

-

Functions

- - - - - - - - - - - - -

calculate_stress

returns the maximum vonmises stress in the section and returns the ratio of the allowable stress, also known as the failure fracion :type raw: :param raw: if raw is true, the stress object is returned, otherwise the failure fraction is returned

conver_np

get_mesh_size

-

Classes

- - - - - - - - - - - - - - - - - - - - - - - - - - - -

Circle

models a solid circle with diameter d

GeometryLog

Initialize a filter.

HollowCircle

models a hollow circle with diameter d and thickness t

ParametricSpline

a multivariate spline defined by uniform length vector input, with points P1,P2 and their slopes P1ds,P2ds

Profile2D

Method generated by attrs for class Profile2D.

Rectangle

models rectangle with base b, and height h

ShapelySection

a 2D profile that takes a shapely section to calculate section properties, use a sectionproperties section with hidden variable _geo to bypass shape calculation

Triangle

models a triangle with base, b and height h

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.html b/docs/_build/html/_autosummary/engforge.eng.html deleted file mode 100644 index 09af96a..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.html +++ /dev/null @@ -1,185 +0,0 @@ - - - - - - - engforge.eng — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng

- - - - - - - - - - - - - - - - - - - - - - - - - - - -

costs

Defines a CostModel & Economics Component that define & orchestrate cost accounting respectively.

fluid_material

geometry

These exist as in interface to sectionproperties from PyNite

pipes

We'll use the QP formulation to develop a fluid analysis system for fluids start with single phase and move to others

prediction

a module that defines PredictionMixin which uses sklearn to make predictions about results

solid_materials

structure_beams

thermodynamics

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.pipes.FlowInput.html b/docs/_build/html/_autosummary/engforge.eng.pipes.FlowInput.html deleted file mode 100644 index 1437815..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.pipes.FlowInput.html +++ /dev/null @@ -1,1534 +0,0 @@ - - - - - - - engforge.eng.pipes.FlowInput — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.pipes.FlowInput

-
-
-class FlowInput(*, name=NOTHING, parent=None, x, y, z, flow_in=0.0)[source]
-

Bases: FlowNode

-

Method generated by attrs for class FlowInput.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

add_segment

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dP_f([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

dP_p([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

dP_tot([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

segments

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

sum_of_flows([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

flow_in

x

y

z

parent

name

dataframe

-
-
Parameters:
-
    -

  • name (str)

    • -

  • parent (Component | System)

    • -

  • x (float)

    • -

  • y (float)

    • -

  • z (float)

    • -

  • flow_in (float)

    • -
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.pipes.FlowNode.html b/docs/_build/html/_autosummary/engforge.eng.pipes.FlowNode.html deleted file mode 100644 index 56c8707..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.pipes.FlowNode.html +++ /dev/null @@ -1,1531 +0,0 @@ - - - - - - - engforge.eng.pipes.FlowNode — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.pipes.FlowNode

-
-
-class FlowNode(*, name=NOTHING, parent=None, x, y, z)[source]
-

Bases: PipeNode

-

Base For Boundary Condition Nodes of

-

Method generated by attrs for class PipeNode.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

add_segment

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dP_f([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

dP_p([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

dP_tot([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

segments

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

sum_of_flows([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

x

y

z

parent

name

dataframe

-
-
Parameters:
-
    -

  • name (str)

    • -

  • parent (Component | System)

    • -

  • x (float)

    • -

  • y (float)

    • -

  • z (float)

    • -
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.pipes.Pipe.html b/docs/_build/html/_autosummary/engforge.eng.pipes.Pipe.html deleted file mode 100644 index 0e624b3..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.pipes.Pipe.html +++ /dev/null @@ -1,1614 +0,0 @@ - - - - - - - engforge.eng.pipes.Pipe — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.pipes.Pipe

-
-
-class Pipe(*, name=NOTHING, node_s=None, node_e=None, material=NOTHING, parent=None, D, v=0, roughness=0.0, bend_radius=None)[source]
-

Bases: PipeFlow, Component

-

Method generated by attrs for class Pipe.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_flow

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

A([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

C([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Fvec

1

Kpipe([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

L([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Lhz([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Lx([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ly([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Lz([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Mf([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

P([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Q([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

T([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dP_f([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

dP_p([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

dP_tot([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

density([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

enthalpy([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

filename

A nice to have, good to override

friction_factor([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

identity

A customizeable property that will be in the log by default

inclination([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

laminar_method

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

reynoldsNumber([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

sign([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

straight_method

system_id

returns an instance unique id based on id(self)

time

turbulent_method

unique_hash

update_interval

viscosity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

roughness

bend_radius

D

v

parent

name

dataframe

-
-
Parameters:
-
    -

  • name (str)

    • -

  • node_s (Slot__a25909281b144bca)

    • -

  • node_e (Slot__7b164a55fd5440bf)

    • -

  • material (Slot__7081d854a38b4a7e)

    • -

  • parent (Component | System)

    • -

  • D (float)

    • -

  • v (float)

    • -

  • roughness (float)

    • -

  • bend_radius (float)

    • -
-
-
-
-
-property Fvec
-

1

-
-
Type:
-

returns the fluidized vector for 1D CFD for continuity

-
-
Type:
-

0, and momentum

-
-
-
- -
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.pipes.PipeFitting.html b/docs/_build/html/_autosummary/engforge.eng.pipes.PipeFitting.html deleted file mode 100644 index b2d046f..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.pipes.PipeFitting.html +++ /dev/null @@ -1,1590 +0,0 @@ - - - - - - - engforge.eng.pipes.PipeFitting — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.pipes.PipeFitting

-
-
-class PipeFitting(*, name=NOTHING, parent=None, x, y, z, material=NOTHING, D, v=0, Kfitting=0.1)[source]
-

Bases: FlowNode, PipeFlow

-

Method generated by attrs for class PipeFitting.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

add_segment

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_flow

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

A([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

C([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Fvec

1

Mf([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

P([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Q([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

T([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dP_f([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

dP_p([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

dP_tot([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

density([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

enthalpy([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

reynoldsNumber([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

segments

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

sum_of_flows([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

viscosity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

x

y

z

D

v

parent

name

dataframe

-
-
Parameters:
-
    -

  • name (str)

    • -

  • parent (Component | System)

    • -

  • x (float)

    • -

  • y (float)

    • -

  • z (float)

    • -

  • material (Slot__7081d854a38b4a7e)

    • -

  • D (float)

    • -

  • v (float)

    • -

  • Kfitting (float)

    • -
-
-
-
-
-property Fvec
-

1

-
-
Type:
-

returns the fluidized vector for 1D CFD for continuity

-
-
Type:
-

0, and momentum

-
-
-
- -
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.pipes.PipeFlow.html b/docs/_build/html/_autosummary/engforge.eng.pipes.PipeFlow.html deleted file mode 100644 index 0fe6751..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.pipes.PipeFlow.html +++ /dev/null @@ -1,1580 +0,0 @@ - - - - - - - engforge.eng.pipes.PipeFlow — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.pipes.PipeFlow

-
-
-class PipeFlow(*, name=NOTHING, material=NOTHING, parent=None, D, v=0)[source]
-

Bases: Component

-

Method generated by attrs for class PipeFlow.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_flow

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

A([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

C([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Fvec

1

Mf([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

P([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Q([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

T([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dP_f

The loss of pressure in the pipe due to pressure

dP_p

The loss of pressure in the pipe due to potential

dP_tot

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

density([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

enthalpy([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

reynoldsNumber([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

viscosity([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

D

v

parent

name

dataframe

-
-
Parameters:
-
    -

  • name (str)

    • -

  • material (Slot__7081d854a38b4a7e)

    • -

  • parent (Component | System)

    • -

  • D (float)

    • -

  • v (float)

    • -
-
-
-
-
-property Fvec
-

1

-
-
Type:
-

returns the fluidized vector for 1D CFD for continuity

-
-
Type:
-

0, and momentum

-
-
-
- -
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dP_f
-

The loss of pressure in the pipe due to pressure

-
- -
-
-property dP_p
-

The loss of pressure in the pipe due to potential

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.pipes.PipeLog.html b/docs/_build/html/_autosummary/engforge.eng.pipes.PipeLog.html deleted file mode 100644 index 6e71a56..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.pipes.PipeLog.html +++ /dev/null @@ -1,337 +0,0 @@ - - - - - - - engforge.eng.pipes.PipeLog — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.pipes.PipeLog

-
-
-class PipeLog(name='')[source]
-

Bases: LoggingMixin

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.pipes.PipeNode.html b/docs/_build/html/_autosummary/engforge.eng.pipes.PipeNode.html deleted file mode 100644 index de1b6d3..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.pipes.PipeNode.html +++ /dev/null @@ -1,1521 +0,0 @@ - - - - - - - engforge.eng.pipes.PipeNode — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.pipes.PipeNode

-
-
-class PipeNode(*, name=NOTHING, parent=None, x, y, z)[source]
-

Bases: Component

-

Method generated by attrs for class PipeNode.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

add_segment

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

segments

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

sum_of_flows([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

x

y

z

parent

name

dataframe

-
-
Parameters:
-
    -

  • name (str)

    • -

  • parent (Component | System)

    • -

  • x (float)

    • -

  • y (float)

    • -

  • z (float)

    • -
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.pipes.PipeSystem.html b/docs/_build/html/_autosummary/engforge.eng.pipes.PipeSystem.html deleted file mode 100644 index c49a8f6..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.pipes.PipeSystem.html +++ /dev/null @@ -1,1746 +0,0 @@ - - - - - - - engforge.eng.pipes.PipeSystem — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.pipes.PipeSystem

-
-
-class PipeSystem(*, name=NOTHING, in_node=NOTHING, parent=None, dynamic_input_vars=NOTHING, dynamic_state_vars=NOTHING, dynamic_output_vars=NOTHING)[source]
-

Bases: System

-

Method generated by attrs for class PipeSystem.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

add_to_graph

recursively add node or pipe elements

assemble_solvers

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

clone

returns a clone of this system, often used to iterate the system without affecting the input values at the last convergence step.

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_graph_from_pipe_or_node

Creates a networkx graph from a pipe or node

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

draw

error

Writes to log as a error

eval

Evaluates the system with pre/post execute methodology :type kw: :param kw: kwargs come from sys_kw input in run ect.

execute

Solves the system's system of constraints and integrates transients if any exist

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

make_plots

makes plots and traces of all on this instance, and if a system is subsystems.

mark_all_comps_changed

mark all components as changed, useful for forcing a re-run of the system, or for marking data as saved

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_run_callback

user callback for when run is complete

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

pre_run_callback

user callback for when run is beginning

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

run

the steady state run the solver for the system.

run_internal_systems

runs internal systems with potentially scoped kwargs

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

setup_global_dynamics

recursively creates numeric matricies for the simulation

signals_attributes

Lists all signals attributes for class

sim_matrix

simulate the system over the course of time.

simulate

runs a simulation over the course of time, and returns a dataframe of the results.

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solver

runs the system solver using the current system state and modifying it.

solver_vars

applies the default combo filter, and your keyword arguments to the collect_solver_refs to test the ref / vars creations

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

converged([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

dXtdt_ref

a dictionary of state var rates

dataframe_constants

dataframe_variants

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nodes

nonlinear

numeric_as_dict

numeric_hash

pipes

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

run_id([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

solved

static_A

static_B

static_C

static_D

static_F

static_K

stored_plots

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

graph

items

parent

name

dataframe

-
-
Parameters:
-
    -

  • name (str)

    • -

  • in_node (Slot__7782db09be534f57)

    • -

  • parent (Component | System)

    • -

  • dynamic_input_vars (list)

    • -

  • dynamic_state_vars (list)

    • -

  • dynamic_output_vars (list)

    • -
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-add_to_graph(graph, node_or_pipe)[source]
-

recursively add node or pipe elements

-
-
Return type:
-

str

-
-
-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-clone()
-

returns a clone of this system, often used to iterate the system without affecting the input values at the last convergence step.

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_graph_from_pipe_or_node(node_or_pipe)[source]
-

Creates a networkx graph from a pipe or node

-
-
Return type:
-

Graph

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-eval(Xo=None, eval_kw=None, sys_kw=None, cb=None, **kw)
-

Evaluates the system with pre/post execute methodology -:type kw: -:param kw: kwargs come from sys_kw input in run ect. -:type cb: -:param cb: an optional callback taking the system as an argument of the form (self,eval_kw,sys_kw,**kw)

-
-
Parameters:
-
    -

  • eval_kw (dict | None)

    • -

  • sys_kw (dict | None)

    • -
-
-
-
- -
-
-execute(**kw)
-

Solves the system’s system of constraints and integrates transients if any exist

-

Override this function for custom solving functions, and call solver to use default solver functionality.

-
-
Returns:
-

the result of this function is returned from solver()

-
-
-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-make_plots(analysis=None, store_figures=True, pre=None)
-

makes plots and traces of all on this instance, and if a system is -subsystems. Analysis should call make plots however it can be called on a system as well -:type analysis: Analysis -:param analysis: the analysis that has triggered this plot -:param store_figure: a boolean or dict, if neither a dictionary will be created and returend from this function -:returns: the dictionary from store_figures logic

-
-
Parameters:
-
    -

  • analysis (Analysis)

    • -

  • store_figures (bool)

    • -
-
-
-
- -
-
-mark_all_comps_changed(inpt)
-

mark all components as changed, useful for forcing a re-run of the system, or for marking data as saved

-
-
Parameters:
-

inpt (bool)

-
-
-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_run_callback(**kwargs)
-

user callback for when run is complete

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-pre_run_callback(**kwargs)
-

user callback for when run is beginning

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-run(**kwargs)
-

the steady state run the solver for the system. It will run the system with the input vars and return the system with the results. Dynamics systems will be run so they are in a steady state nearest their initial position.

-
- -
-
-run_internal_systems(sys_kw=None)
-

runs internal systems with potentially scoped kwargs

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-setup_global_dynamics(**kwargs)
-

recursively creates numeric matricies for the simulation

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-sim_matrix(eval_kw=None, sys_kw=None, **kwargs)
-

simulate the system over the course of time. -return a dictionary of dataframes

-
- -
-
-simulate(dt, endtime, X0=None, cb=None, eval_kw=None, sys_kw=None, min_kw=None, run_solver=False, return_system=False, return_data=False, return_all=False, debug_fail=False, **kwargs)
-

runs a simulation over the course of time, and returns a dataframe of the results.

-

A copy of this system is made, and the simulation is run on the copy, so as to not affect the state of the original system.

-

#TODO:

-
-
Return type:
-

DataFrame

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-solver(enter_refresh=True, save_on_exit=True, **kw)
-

runs the system solver using the current system state and modifying it. This is the default solver for the system, and it is recommended to add additional options or methods via the execute method.

-
-
Parameters:
-
    -

  • obj – the objective function to minimize, by default will minimize the sum of the squares of the residuals. Objective function should be a function(system,Xs,Xt) where Xs is the system state and Xt is the system transient state. The objective function will be argmin(X)|(1+custom_objective)*residual_RSS when add_obj is True in kw otherwise argmin(X)|custom_objective with constraints on the system as balances instead of first objective being included.

    • -

  • cons – the constraints to be used in the solver, by default will use the system’s constraints will be enabled when True. If a dictionary is passed the solver will use the dictionary as the constraints in addition to system constraints. These can be individually disabled by key=None in the dictionary.

    • -

  • X0 – the initial guess for the solver, by default will use the current system state. If a dictionary is passed the solver will use the dictionary as the initial guess in addition to the system state.

    • -

  • dXdt – can be 0 to indicate steady-state, or None to not run the transient constraints. Otherwise a partial dictionary of vars for the dynamics rates can be given, those not given will be assumed steady state or 0.

    • -

  • kw – additional options for the solver, such as the solver_option, or the solver method options. Described below

    • -

  • combos – a csv str or list of combos to include, including wildcards. the default means all combos will be run unless ign_combos or only combos alters behavior. The initial selection of combos is made by matching any case with the full name of the combo, or a parial name with a wildcard(s) in the combo name Ignore and only combos will further filter the selection. Wildcards / queries per fnmatch

    • -

  • ign_combos – a list of combo vars to ignore.

    • -

  • only_combos – a list of combo vars to include exclusively.

    • -

  • add_var – a csv str or variables to include, including wildcards. the default means all combos will be run unless ign_combos or only combos alters behavior. The initial selection of combos is made by matching any case with the full name of the combo, or a parial name with a wildcard(s) in the combo name Ignore and only combos will further filter the selection. Wildcards / queries per fnmatch

    • -

  • ign_var – a list of combo vars to ignore.

    • -

  • only_var – a list of combo vars to include exclusively.

    • -

  • add_obj – a flag to add the objective to the system constraints, by default will add the objective to the system constraints. If False the objective will be the only constraint.

    • -

  • only_active – default True, will only look at active variables objectives and constraints

    • -

  • activate – default None, a list of solver vars to activate

    • -

  • deactivate – default None, a list of solver vars to deactivate (if not activated above)

    • -
-
-
-
- -
-
-solver_vars(check_dynamics=True, addable=None, **kwargs)
-

applies the default combo filter, and your keyword arguments to the collect_solver_refs to test the ref / vars creations

-

parses add_vars in kwargs to append to the collected solver vars -:param add_vars: can be a str, a list or a dictionary of variables: solver_instance kwargs. If a str or list the variable will be added with positive only constraints. If a dictionary is chosen, it can have keys as parameters, and itself have a subdictionary with keys: min / max, where each respective value is placed in the constraints list, which may be a callable(sys,prob) or numeric. If nothing is specified the default is min=0,max=None, ie positive only.

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.pipes.Pump.html b/docs/_build/html/_autosummary/engforge.eng.pipes.Pump.html deleted file mode 100644 index d2557b1..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.pipes.Pump.html +++ /dev/null @@ -1,1541 +0,0 @@ - - - - - - - engforge.eng.pipes.Pump — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.pipes.Pump

-
-
-class Pump(*, name=NOTHING, parent=None, max_flow, max_pressure)[source]
-

Bases: Component

-

Simulates a pump with power input, max flow, and max pressure by assuming a flow characteristic

-

Method generated by attrs for class Pump.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

dPressure

The pressure the pump generates

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

power

The power used considering in watts

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

design_flow_curve

a tuple output of flow vector, and pressure vector

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

max_flow

max_pressure

parent

name

dataframe

-
-
Parameters:
-
    -

  • name (str)

    • -

  • parent (Component | System)

    • -

  • max_flow (float)

    • -

  • max_pressure (float)

    • -
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-dPressure(current_flow)[source]
-

The pressure the pump generates

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-property design_flow_curve
-

a tuple output of flow vector, and pressure vector

-
-
Type:
-

returns

-
-
-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-power(current_flow)[source]
-

The power used considering in watts

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.pipes.html b/docs/_build/html/_autosummary/engforge.eng.pipes.html deleted file mode 100644 index 60d8862..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.pipes.html +++ /dev/null @@ -1,213 +0,0 @@ - - - - - - - engforge.eng.pipes — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.pipes

-

We’ll use the QP formulation to develop a fluid analysis system for fluids -start with single phase and move to others

-
    -

  1. Pumps Power = C x Q x P

    2. -

  2. Compressor = C x (QP) x (PR^C2 - 1)

    3. -

  3. Pipes = dP = C x fXL/D x V^2 / 2g

    4. -

  4. Pipe Fittings / Valves = dP = C x V^2 (fXL/D +K) | K is a constant, for valves it can be interpolated between closed and opened

    5. -

  5. Splitters & Joins: Handle fluid mixing

    6. -

  6. Phase Separation (This one is gonna be hard)

    7. -

  7. Heat Exchanger dP = f(V,T) - phase change issues

    8. -

  8. Filtration dP = k x Vxc x (Afrontal/Asurface) “linear”

    9. -
-

Classes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

FlowInput

Method generated by attrs for class FlowInput.

FlowNode

Base For Boundary Condition Nodes of

Pipe

Method generated by attrs for class Pipe.

PipeFitting

Method generated by attrs for class PipeFitting.

PipeFlow

Method generated by attrs for class PipeFlow.

PipeLog

Initialize a filter.

PipeNode

Method generated by attrs for class PipeNode.

PipeSystem

Method generated by attrs for class PipeSystem.

Pump

Simulates a pump with power input, max flow, and max pressure by assuming a flow characteristic

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.prediction.PredictionMixin.html b/docs/_build/html/_autosummary/engforge.eng.prediction.PredictionMixin.html deleted file mode 100644 index 862fe2d..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.prediction.PredictionMixin.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - - engforge.eng.prediction.PredictionMixin — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.prediction.PredictionMixin

-
-
-class PredictionMixin[source]
-

Bases: object

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_prediction_record

adds a record to the prediction records, and calcultes the average and variance of the data :type record: :param record: a dict of the record :type extra_add: :param extra_add: if true, the record is added to the prediction records even if the data is inbounds :returns: a boolean indicating if the record was out of bounds of current data (therefor should be added)

check_and_retrain

Checks if more data than threshold to train or if error is sufficiently low to ignore retraining, or if more data already exists than window size (no training)

check_out_of_domain

checks if the record is in bounds of the current data

observe_and_predict

uses the existing models to predict the row and measure the error

prediction_dataframe

prediction_weights

score_data

scores a dataframe

train_compare

Use the dataframe to train the models, and compare the results to the current models using train_frac to divide total samples into training and testing sets, unless train_full is set.

training_callback

override to provide a callback when training is complete, such as saving the models

-

Attributes

- - - - - - - - - - - - - - - - - - -

basis

prediction_goal_error

prediction_records

train_window

trained

-
-
-add_prediction_record(record, extra_add=True, mult_sigma=1, target_items=1000)[source]
-

adds a record to the prediction records, and calcultes the average and variance of the data -:type record: -:param record: a dict of the record -:type extra_add: -:param extra_add: if true, the record is added to the prediction records even if the data is inbounds -:returns: a boolean indicating if the record was out of bounds of current data (therefor should be added)

-
- -
-
-check_and_retrain(records, min_rec=None)[source]
-

Checks if more data than threshold to train or if error is sufficiently low to ignore retraining, or if more data already exists than window size (no training)

-
- -
-
-check_out_of_domain(record, extra_margin=1, target_items=1000)[source]
-

checks if the record is in bounds of the current data

-
- -
-
-observe_and_predict(row)[source]
-

uses the existing models to predict the row and measure the error

-
- -
-
-score_data(df)[source]
-

scores a dataframe

-
- -
-
-train_compare(df, test_frac=2, train_full=False, min_rec=250)[source]
-

Use the dataframe to train the models, and compare the results to the current models using train_frac to divide total samples into training and testing sets, unless train_full is set.

-
-
Parameters:
-
    -

  • df – dataframe to train with

    • -

  • test_frac – N/train_frac will be size of the training window

    • -

  • train_full – boolean to use full training data

    • -
-
-
Returns:
-

trained models

-
-
-
- -
-
-training_callback(models)[source]
-

override to provide a callback when training is complete, such as saving the models

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.prediction.html b/docs/_build/html/_autosummary/engforge.eng.prediction.html deleted file mode 100644 index 15d456e..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.prediction.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - engforge.eng.prediction — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.prediction

-

a module that defines PredictionMixin which uses sklearn to make predictions about results

-

Classes

- - - - - - -

PredictionMixin

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.solid_materials.ANSI_4130.html b/docs/_build/html/_autosummary/engforge.eng.solid_materials.ANSI_4130.html deleted file mode 100644 index 9f9a454..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.solid_materials.ANSI_4130.html +++ /dev/null @@ -1,820 +0,0 @@ - - - - - - - engforge.eng.solid_materials.ANSI_4130 — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.solid_materials.ANSI_4130

-
-
-class ANSI_4130(*, name='steel 4130', color=NOTHING, in_shear_modulus=None, hardness=10, izod=100, factor_of_saftey=1.5, density=7872.0, elastic_modulus=205000000000.0, yield_strength=460000000.0, tensile_strength_ultimate=560000000.0, poissons_ratio=0.28, melting_point=1705, maxium_service_temp=1143, thermal_conductivity=42.7, specific_heat=477, thermal_expansion=1.12e-05, electrical_resistitivity=2.23e-07, cost_per_kg=2.92)[source]
-

Bases: SolidMaterial

-

Method generated by attrs for class ANSI_4130.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_inst_attributes

collects all the attributes for a system

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

plot_attributes

Lists all plot attributes for class

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

validate_class

A customizeable validator at the end of class creation in forge

von_mises_stress_max

Return arrays with the results of pyfunc broadcast (vectorized) over args and kwargs not in excluded.

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

E

G

allowable_stress

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

color

displayname

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

log_silo

logger

nu

numeric_as_dict

numeric_hash

rho

shear_modulus

Shear Modulus

slack_webhook_url

ultimate_stress

unique_hash

unique_id

yield_stress

name

density

elastic_modulus

yield_strength

tensile_strength_ultimate

poissons_ratio

melting_point

maxium_service_temp

thermal_conductivity

specific_heat

thermal_expansion

electrical_resistitivity

cost_per_kg

in_shear_modulus

hardness

izod

factor_of_saftey

-
-
Parameters:
-
    -

  • name (str)

    • -

  • color (float)

    • -

  • in_shear_modulus (float)

    • -

  • hardness (float)

    • -

  • izod (float)

    • -

  • factor_of_saftey (float)

    • -

  • density (float)

    • -

  • elastic_modulus (float)

    • -

  • yield_strength (float)

    • -

  • tensile_strength_ultimate (float)

    • -

  • poissons_ratio (float)

    • -

  • melting_point (float)

    • -

  • maxium_service_temp (float)

    • -

  • thermal_conductivity (float)

    • -

  • specific_heat (float)

    • -

  • thermal_expansion (float)

    • -

  • electrical_resistitivity (float)

    • -

  • cost_per_kg (float)

    • -
-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-property shear_modulus: float
-

Shear Modulus

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-von_mises_stress_max(**kwargs)
-

Return arrays with the results of pyfunc broadcast (vectorized) over -args and kwargs not in excluded.

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.solid_materials.ANSI_4340.html b/docs/_build/html/_autosummary/engforge.eng.solid_materials.ANSI_4340.html deleted file mode 100644 index ac86c85..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.solid_materials.ANSI_4340.html +++ /dev/null @@ -1,820 +0,0 @@ - - - - - - - engforge.eng.solid_materials.ANSI_4340 — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.solid_materials.ANSI_4340

-
-
-class ANSI_4340(*, name='steel 4340', color=NOTHING, in_shear_modulus=None, hardness=10, izod=100, factor_of_saftey=1.5, density=7872.0, elastic_modulus=192000000000.0, yield_strength=470000000.0, tensile_strength_ultimate=745000000.0, poissons_ratio=0.28, melting_point=1700, maxium_service_temp=1103, thermal_conductivity=44.5, specific_heat=475, thermal_expansion=1.37e-05, electrical_resistitivity=2.48e-07, cost_per_kg=2.23)[source]
-

Bases: SolidMaterial

-

Method generated by attrs for class ANSI_4340.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_inst_attributes

collects all the attributes for a system

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

plot_attributes

Lists all plot attributes for class

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

validate_class

A customizeable validator at the end of class creation in forge

von_mises_stress_max

Return arrays with the results of pyfunc broadcast (vectorized) over args and kwargs not in excluded.

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

E

G

allowable_stress

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

color

displayname

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

log_silo

logger

nu

numeric_as_dict

numeric_hash

rho

shear_modulus

Shear Modulus

slack_webhook_url

ultimate_stress

unique_hash

unique_id

yield_stress

name

density

elastic_modulus

yield_strength

tensile_strength_ultimate

poissons_ratio

melting_point

maxium_service_temp

thermal_conductivity

specific_heat

thermal_expansion

electrical_resistitivity

cost_per_kg

in_shear_modulus

hardness

izod

factor_of_saftey

-
-
Parameters:
-
    -

  • name (str)

    • -

  • color (float)

    • -

  • in_shear_modulus (float)

    • -

  • hardness (float)

    • -

  • izod (float)

    • -

  • factor_of_saftey (float)

    • -

  • density (float)

    • -

  • elastic_modulus (float)

    • -

  • yield_strength (float)

    • -

  • tensile_strength_ultimate (float)

    • -

  • poissons_ratio (float)

    • -

  • melting_point (float)

    • -

  • maxium_service_temp (float)

    • -

  • thermal_conductivity (float)

    • -

  • specific_heat (float)

    • -

  • thermal_expansion (float)

    • -

  • electrical_resistitivity (float)

    • -

  • cost_per_kg (float)

    • -
-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-property shear_modulus: float
-

Shear Modulus

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-von_mises_stress_max(**kwargs)
-

Return arrays with the results of pyfunc broadcast (vectorized) over -args and kwargs not in excluded.

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.solid_materials.Aluminum.html b/docs/_build/html/_autosummary/engforge.eng.solid_materials.Aluminum.html deleted file mode 100644 index 381d1c0..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.solid_materials.Aluminum.html +++ /dev/null @@ -1,820 +0,0 @@ - - - - - - - engforge.eng.solid_materials.Aluminum — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.solid_materials.Aluminum

-
-
-class Aluminum(*, name='aluminum generic', color=NOTHING, in_shear_modulus=None, hardness=10, izod=100, factor_of_saftey=1.5, density=2680.0, elastic_modulus=70300000000.0, yield_strength=240000000.0, tensile_strength_ultimate=290000000.0, poissons_ratio=0.33, melting_point=880, maxium_service_temp=616, thermal_conductivity=138, specific_heat=880, thermal_expansion=2.21e-05, electrical_resistitivity=4.99e-07, cost_per_kg=1.9)[source]
-

Bases: SolidMaterial

-

Method generated by attrs for class Aluminum.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_inst_attributes

collects all the attributes for a system

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

plot_attributes

Lists all plot attributes for class

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

validate_class

A customizeable validator at the end of class creation in forge

von_mises_stress_max

Return arrays with the results of pyfunc broadcast (vectorized) over args and kwargs not in excluded.

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

E

G

allowable_stress

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

color

displayname

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

log_silo

logger

nu

numeric_as_dict

numeric_hash

rho

shear_modulus

Shear Modulus

slack_webhook_url

ultimate_stress

unique_hash

unique_id

yield_stress

name

density

elastic_modulus

yield_strength

tensile_strength_ultimate

poissons_ratio

melting_point

maxium_service_temp

thermal_conductivity

specific_heat

thermal_expansion

electrical_resistitivity

cost_per_kg

in_shear_modulus

hardness

izod

factor_of_saftey

-
-
Parameters:
-
    -

  • name (str)

    • -

  • color (float)

    • -

  • in_shear_modulus (float)

    • -

  • hardness (float)

    • -

  • izod (float)

    • -

  • factor_of_saftey (float)

    • -

  • density (float)

    • -

  • elastic_modulus (float)

    • -

  • yield_strength (float)

    • -

  • tensile_strength_ultimate (float)

    • -

  • poissons_ratio (float)

    • -

  • melting_point (float)

    • -

  • maxium_service_temp (float)

    • -

  • thermal_conductivity (float)

    • -

  • specific_heat (float)

    • -

  • thermal_expansion (float)

    • -

  • electrical_resistitivity (float)

    • -

  • cost_per_kg (float)

    • -
-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-property shear_modulus: float
-

Shear Modulus

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-von_mises_stress_max(**kwargs)
-

Return arrays with the results of pyfunc broadcast (vectorized) over -args and kwargs not in excluded.

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.solid_materials.CarbonFiber.html b/docs/_build/html/_autosummary/engforge.eng.solid_materials.CarbonFiber.html deleted file mode 100644 index 6bae264..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.solid_materials.CarbonFiber.html +++ /dev/null @@ -1,820 +0,0 @@ - - - - - - - engforge.eng.solid_materials.CarbonFiber — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.solid_materials.CarbonFiber

-
-
-class CarbonFiber(*, name='carbon fiber', color=NOTHING, in_shear_modulus=None, hardness=10, izod=100, factor_of_saftey=1.5, density=1600.0, elastic_modulus=140000000000.0, yield_strength=686000000.0, tensile_strength_ultimate=919000000.0, poissons_ratio=0.33, melting_point=573, maxium_service_temp=423, thermal_conductivity=250, specific_heat=1100, thermal_expansion=1.41e-05, electrical_resistitivity=10000, cost_per_kg=1.9)[source]
-

Bases: SolidMaterial

-

Method generated by attrs for class CarbonFiber.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_inst_attributes

collects all the attributes for a system

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

plot_attributes

Lists all plot attributes for class

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

validate_class

A customizeable validator at the end of class creation in forge

von_mises_stress_max

Return arrays with the results of pyfunc broadcast (vectorized) over args and kwargs not in excluded.

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

E

G

allowable_stress

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

color

displayname

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

log_silo

logger

nu

numeric_as_dict

numeric_hash

rho

shear_modulus

Shear Modulus

slack_webhook_url

ultimate_stress

unique_hash

unique_id

yield_stress

name

density

elastic_modulus

yield_strength

tensile_strength_ultimate

poissons_ratio

melting_point

maxium_service_temp

thermal_conductivity

specific_heat

thermal_expansion

electrical_resistitivity

cost_per_kg

in_shear_modulus

hardness

izod

factor_of_saftey

-
-
Parameters:
-
    -

  • name (str)

    • -

  • color (float)

    • -

  • in_shear_modulus (float)

    • -

  • hardness (float)

    • -

  • izod (float)

    • -

  • factor_of_saftey (float)

    • -

  • density (float)

    • -

  • elastic_modulus (float)

    • -

  • yield_strength (float)

    • -

  • tensile_strength_ultimate (float)

    • -

  • poissons_ratio (float)

    • -

  • melting_point (float)

    • -

  • maxium_service_temp (float)

    • -

  • thermal_conductivity (float)

    • -

  • specific_heat (float)

    • -

  • thermal_expansion (float)

    • -

  • electrical_resistitivity (float)

    • -

  • cost_per_kg (float)

    • -
-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-property shear_modulus: float
-

Shear Modulus

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-von_mises_stress_max(**kwargs)
-

Return arrays with the results of pyfunc broadcast (vectorized) over -args and kwargs not in excluded.

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.solid_materials.Concrete.html b/docs/_build/html/_autosummary/engforge.eng.solid_materials.Concrete.html deleted file mode 100644 index 3b4f44e..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.solid_materials.Concrete.html +++ /dev/null @@ -1,820 +0,0 @@ - - - - - - - engforge.eng.solid_materials.Concrete — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.solid_materials.Concrete

-
-
-class Concrete(*, name='concrete', color=NOTHING, in_shear_modulus=None, hardness=10, izod=100, factor_of_saftey=1.5, density=2000.0, elastic_modulus=2920000000.0, yield_strength=57900000.0, tensile_strength_ultimate=910000.0, poissons_ratio=0.26, melting_point=3273, maxium_service_temp=3273, thermal_conductivity=0.5, specific_heat=736, thermal_expansion=1.641e-05, electrical_resistitivity=1000000.0, cost_per_kg=0.09544)[source]
-

Bases: SolidMaterial

-

Method generated by attrs for class Concrete.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_inst_attributes

collects all the attributes for a system

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

plot_attributes

Lists all plot attributes for class

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

validate_class

A customizeable validator at the end of class creation in forge

von_mises_stress_max

Return arrays with the results of pyfunc broadcast (vectorized) over args and kwargs not in excluded.

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

E

G

allowable_stress

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

color

displayname

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

log_silo

logger

nu

numeric_as_dict

numeric_hash

rho

shear_modulus

Shear Modulus

slack_webhook_url

ultimate_stress

unique_hash

unique_id

yield_stress

name

density

elastic_modulus

yield_strength

tensile_strength_ultimate

poissons_ratio

melting_point

maxium_service_temp

thermal_conductivity

specific_heat

thermal_expansion

electrical_resistitivity

cost_per_kg

in_shear_modulus

hardness

izod

factor_of_saftey

-
-
Parameters:
-
    -

  • name (str)

    • -

  • color (float)

    • -

  • in_shear_modulus (float)

    • -

  • hardness (float)

    • -

  • izod (float)

    • -

  • factor_of_saftey (float)

    • -

  • density (float)

    • -

  • elastic_modulus (float)

    • -

  • yield_strength (float)

    • -

  • tensile_strength_ultimate (float)

    • -

  • poissons_ratio (float)

    • -

  • melting_point (float)

    • -

  • maxium_service_temp (float)

    • -

  • thermal_conductivity (float)

    • -

  • specific_heat (float)

    • -

  • thermal_expansion (float)

    • -

  • electrical_resistitivity (float)

    • -

  • cost_per_kg (float)

    • -
-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-property shear_modulus: float
-

Shear Modulus

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-von_mises_stress_max(**kwargs)
-

Return arrays with the results of pyfunc broadcast (vectorized) over -args and kwargs not in excluded.

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.solid_materials.DrySoil.html b/docs/_build/html/_autosummary/engforge.eng.solid_materials.DrySoil.html deleted file mode 100644 index 141c805..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.solid_materials.DrySoil.html +++ /dev/null @@ -1,820 +0,0 @@ - - - - - - - engforge.eng.solid_materials.DrySoil — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.solid_materials.DrySoil

-
-
-class DrySoil(*, name='dry soil', color=NOTHING, in_shear_modulus=None, hardness=10, izod=100, factor_of_saftey=1.5, density=1600.0, elastic_modulus=70300000000.0, yield_strength=0.0, tensile_strength_ultimate=0.0, poissons_ratio=0.33, melting_point=1823, maxium_service_temp=1723, thermal_conductivity=0.25, specific_heat=800, thermal_expansion=1.641e-05, electrical_resistitivity=1000000.0, cost_per_kg=0.04478)[source]
-

Bases: SolidMaterial

-

Method generated by attrs for class DrySoil.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_inst_attributes

collects all the attributes for a system

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

plot_attributes

Lists all plot attributes for class

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

validate_class

A customizeable validator at the end of class creation in forge

von_mises_stress_max

Return arrays with the results of pyfunc broadcast (vectorized) over args and kwargs not in excluded.

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

E

G

allowable_stress

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

color

displayname

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

log_silo

logger

nu

numeric_as_dict

numeric_hash

rho

shear_modulus

Shear Modulus

slack_webhook_url

ultimate_stress

unique_hash

unique_id

yield_stress

name

density

elastic_modulus

yield_strength

tensile_strength_ultimate

poissons_ratio

melting_point

maxium_service_temp

thermal_conductivity

specific_heat

thermal_expansion

electrical_resistitivity

cost_per_kg

in_shear_modulus

hardness

izod

factor_of_saftey

-
-
Parameters:
-
    -

  • name (str)

    • -

  • color (float)

    • -

  • in_shear_modulus (float)

    • -

  • hardness (float)

    • -

  • izod (float)

    • -

  • factor_of_saftey (float)

    • -

  • density (float)

    • -

  • elastic_modulus (float)

    • -

  • yield_strength (float)

    • -

  • tensile_strength_ultimate (float)

    • -

  • poissons_ratio (float)

    • -

  • melting_point (float)

    • -

  • maxium_service_temp (float)

    • -

  • thermal_conductivity (float)

    • -

  • specific_heat (float)

    • -

  • thermal_expansion (float)

    • -

  • electrical_resistitivity (float)

    • -

  • cost_per_kg (float)

    • -
-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-property shear_modulus: float
-

Shear Modulus

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-von_mises_stress_max(**kwargs)
-

Return arrays with the results of pyfunc broadcast (vectorized) over -args and kwargs not in excluded.

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.solid_materials.Rock.html b/docs/_build/html/_autosummary/engforge.eng.solid_materials.Rock.html deleted file mode 100644 index a634765..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.solid_materials.Rock.html +++ /dev/null @@ -1,820 +0,0 @@ - - - - - - - engforge.eng.solid_materials.Rock — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.solid_materials.Rock

-
-
-class Rock(*, name='wet soil', color=NOTHING, in_shear_modulus=None, hardness=10, izod=100, factor_of_saftey=1.5, density=2600.0, elastic_modulus=67000000000.0, yield_strength=13000000.0, tensile_strength_ultimate=13000000.0, poissons_ratio=0.26, melting_point=3000, maxium_service_temp=3000, thermal_conductivity=1.0, specific_heat=2000, thermal_expansion=1.641e-05, electrical_resistitivity=1000000.0, cost_per_kg=0.05044)[source]
-

Bases: SolidMaterial

-

Method generated by attrs for class Rock.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_inst_attributes

collects all the attributes for a system

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

plot_attributes

Lists all plot attributes for class

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

validate_class

A customizeable validator at the end of class creation in forge

von_mises_stress_max

Return arrays with the results of pyfunc broadcast (vectorized) over args and kwargs not in excluded.

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

E

G

allowable_stress

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

color

displayname

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

log_silo

logger

nu

numeric_as_dict

numeric_hash

rho

shear_modulus

Shear Modulus

slack_webhook_url

ultimate_stress

unique_hash

unique_id

yield_stress

name

density

elastic_modulus

yield_strength

tensile_strength_ultimate

poissons_ratio

melting_point

maxium_service_temp

thermal_conductivity

specific_heat

thermal_expansion

electrical_resistitivity

cost_per_kg

in_shear_modulus

hardness

izod

factor_of_saftey

-
-
Parameters:
-
    -

  • name (str)

    • -

  • color (float)

    • -

  • in_shear_modulus (float)

    • -

  • hardness (float)

    • -

  • izod (float)

    • -

  • factor_of_saftey (float)

    • -

  • density (float)

    • -

  • elastic_modulus (float)

    • -

  • yield_strength (float)

    • -

  • tensile_strength_ultimate (float)

    • -

  • poissons_ratio (float)

    • -

  • melting_point (float)

    • -

  • maxium_service_temp (float)

    • -

  • thermal_conductivity (float)

    • -

  • specific_heat (float)

    • -

  • thermal_expansion (float)

    • -

  • electrical_resistitivity (float)

    • -

  • cost_per_kg (float)

    • -
-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-property shear_modulus: float
-

Shear Modulus

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-von_mises_stress_max(**kwargs)
-

Return arrays with the results of pyfunc broadcast (vectorized) over -args and kwargs not in excluded.

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.solid_materials.Rubber.html b/docs/_build/html/_autosummary/engforge.eng.solid_materials.Rubber.html deleted file mode 100644 index 3b07a10..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.solid_materials.Rubber.html +++ /dev/null @@ -1,820 +0,0 @@ - - - - - - - engforge.eng.solid_materials.Rubber — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.solid_materials.Rubber

-
-
-class Rubber(*, name='rubber', color=NOTHING, in_shear_modulus=None, hardness=10, izod=100, factor_of_saftey=1.5, density=1100.0, elastic_modulus=100000000.0, yield_strength=248000.0, tensile_strength_ultimate=500000.0, poissons_ratio=0.33, melting_point=873, maxium_service_temp=573, thermal_conductivity=0.108, specific_heat=2005, thermal_expansion=0.0001, electrical_resistitivity=10000000000000.0, cost_per_kg=0.04)[source]
-

Bases: SolidMaterial

-

Method generated by attrs for class Rubber.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_inst_attributes

collects all the attributes for a system

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

plot_attributes

Lists all plot attributes for class

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

validate_class

A customizeable validator at the end of class creation in forge

von_mises_stress_max

Return arrays with the results of pyfunc broadcast (vectorized) over args and kwargs not in excluded.

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

E

G

allowable_stress

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

color

displayname

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

log_silo

logger

nu

numeric_as_dict

numeric_hash

rho

shear_modulus

Shear Modulus

slack_webhook_url

ultimate_stress

unique_hash

unique_id

yield_stress

name

density

elastic_modulus

yield_strength

tensile_strength_ultimate

poissons_ratio

melting_point

maxium_service_temp

thermal_conductivity

specific_heat

thermal_expansion

electrical_resistitivity

cost_per_kg

in_shear_modulus

hardness

izod

factor_of_saftey

-
-
Parameters:
-
    -

  • name (str)

    • -

  • color (float)

    • -

  • in_shear_modulus (float)

    • -

  • hardness (float)

    • -

  • izod (float)

    • -

  • factor_of_saftey (float)

    • -

  • density (float)

    • -

  • elastic_modulus (float)

    • -

  • yield_strength (float)

    • -

  • tensile_strength_ultimate (float)

    • -

  • poissons_ratio (float)

    • -

  • melting_point (float)

    • -

  • maxium_service_temp (float)

    • -

  • thermal_conductivity (float)

    • -

  • specific_heat (float)

    • -

  • thermal_expansion (float)

    • -

  • electrical_resistitivity (float)

    • -

  • cost_per_kg (float)

    • -
-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-property shear_modulus: float
-

Shear Modulus

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-von_mises_stress_max(**kwargs)
-

Return arrays with the results of pyfunc broadcast (vectorized) over -args and kwargs not in excluded.

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.solid_materials.SS_316.html b/docs/_build/html/_autosummary/engforge.eng.solid_materials.SS_316.html deleted file mode 100644 index 2f9f324..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.solid_materials.SS_316.html +++ /dev/null @@ -1,820 +0,0 @@ - - - - - - - engforge.eng.solid_materials.SS_316 — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.solid_materials.SS_316

-
-
-class SS_316(*, name='stainless steel 316', color=NOTHING, in_shear_modulus=None, hardness=10, izod=100, factor_of_saftey=1.5, density=8000.0, elastic_modulus=193000000000.0, yield_strength=240000000.0, tensile_strength_ultimate=550000000.0, poissons_ratio=0.3, melting_point=1643, maxium_service_temp=1143, thermal_conductivity=16.3, specific_heat=500, thermal_expansion=1.6e-05, electrical_resistitivity=7.4e-07, cost_per_kg=3.26)[source]
-

Bases: SolidMaterial

-

Method generated by attrs for class SS_316.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_inst_attributes

collects all the attributes for a system

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

plot_attributes

Lists all plot attributes for class

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

validate_class

A customizeable validator at the end of class creation in forge

von_mises_stress_max

Return arrays with the results of pyfunc broadcast (vectorized) over args and kwargs not in excluded.

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

E

G

allowable_stress

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

color

displayname

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

log_silo

logger

nu

numeric_as_dict

numeric_hash

rho

shear_modulus

Shear Modulus

slack_webhook_url

ultimate_stress

unique_hash

unique_id

yield_stress

name

density

elastic_modulus

yield_strength

tensile_strength_ultimate

poissons_ratio

melting_point

maxium_service_temp

thermal_conductivity

specific_heat

thermal_expansion

electrical_resistitivity

cost_per_kg

in_shear_modulus

hardness

izod

factor_of_saftey

-
-
Parameters:
-
    -

  • name (str)

    • -

  • color (float)

    • -

  • in_shear_modulus (float)

    • -

  • hardness (float)

    • -

  • izod (float)

    • -

  • factor_of_saftey (float)

    • -

  • density (float)

    • -

  • elastic_modulus (float)

    • -

  • yield_strength (float)

    • -

  • tensile_strength_ultimate (float)

    • -

  • poissons_ratio (float)

    • -

  • melting_point (float)

    • -

  • maxium_service_temp (float)

    • -

  • thermal_conductivity (float)

    • -

  • specific_heat (float)

    • -

  • thermal_expansion (float)

    • -

  • electrical_resistitivity (float)

    • -

  • cost_per_kg (float)

    • -
-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-property shear_modulus: float
-

Shear Modulus

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-von_mises_stress_max(**kwargs)
-

Return arrays with the results of pyfunc broadcast (vectorized) over -args and kwargs not in excluded.

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.solid_materials.SolidMaterial.html b/docs/_build/html/_autosummary/engforge.eng.solid_materials.SolidMaterial.html deleted file mode 100644 index 0b7609e..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.solid_materials.SolidMaterial.html +++ /dev/null @@ -1,821 +0,0 @@ - - - - - - - engforge.eng.solid_materials.SolidMaterial — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.solid_materials.SolidMaterial

-
-
-class SolidMaterial(*, name='solid material', color=NOTHING, density=1.0, elastic_modulus=100000000.0, in_shear_modulus=None, yield_strength=1000000.0, tensile_strength_ultimate=2000000.0, hardness=10, izod=100, poissons_ratio=0.3, melting_point=1273, maxium_service_temp=773, thermal_conductivity=10, specific_heat=1000, thermal_expansion=1e-05, electrical_resistitivity=1e-08, cost_per_kg=1.0, factor_of_saftey=1.5)[source]
-

Bases: Material, Material, Configuration

-

A class to hold physical properties of solid structural materials and act as both a section property material and a pynite material

-

Method generated by attrs for class SolidMaterial.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_inst_attributes

collects all the attributes for a system

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

plot_attributes

Lists all plot attributes for class

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

validate_class

A customizeable validator at the end of class creation in forge

von_mises_stress_max

Return arrays with the results of pyfunc broadcast (vectorized) over args and kwargs not in excluded.

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

E

G

allowable_stress

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

color

displayname

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

log_silo

logger

nu

numeric_as_dict

numeric_hash

rho

shear_modulus

Shear Modulus

slack_webhook_url

ultimate_stress

unique_hash

unique_id

yield_stress

name

density

elastic_modulus

in_shear_modulus

yield_strength

tensile_strength_ultimate

hardness

izod

poissons_ratio

melting_point

maxium_service_temp

thermal_conductivity

specific_heat

thermal_expansion

electrical_resistitivity

cost_per_kg

factor_of_saftey

-
-
Parameters:
-
    -

  • name (str)

    • -

  • color (float)

    • -

  • density (float)

    • -

  • elastic_modulus (float)

    • -

  • in_shear_modulus (float)

    • -

  • yield_strength (float)

    • -

  • tensile_strength_ultimate (float)

    • -

  • hardness (float)

    • -

  • izod (float)

    • -

  • poissons_ratio (float)

    • -

  • melting_point (float)

    • -

  • maxium_service_temp (float)

    • -

  • thermal_conductivity (float)

    • -

  • specific_heat (float)

    • -

  • thermal_expansion (float)

    • -

  • electrical_resistitivity (float)

    • -

  • cost_per_kg (float)

    • -

  • factor_of_saftey (float)

    • -
-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod pre_compile()[source]
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-property shear_modulus: float
-

Shear Modulus

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-von_mises_stress_max(**kwargs)
-

Return arrays with the results of pyfunc broadcast (vectorized) over -args and kwargs not in excluded.

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.solid_materials.WetSoil.html b/docs/_build/html/_autosummary/engforge.eng.solid_materials.WetSoil.html deleted file mode 100644 index 57239ec..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.solid_materials.WetSoil.html +++ /dev/null @@ -1,820 +0,0 @@ - - - - - - - engforge.eng.solid_materials.WetSoil — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.solid_materials.WetSoil

-
-
-class WetSoil(*, name='wet soil', color=NOTHING, in_shear_modulus=None, hardness=10, izod=100, factor_of_saftey=1.5, density=2080.0, elastic_modulus=70300000000.0, yield_strength=0.0, tensile_strength_ultimate=0.0, poissons_ratio=0.33, melting_point=1823, maxium_service_temp=1723, thermal_conductivity=2.75, specific_heat=1632, thermal_expansion=1.641e-05, electrical_resistitivity=940.0, cost_per_kg=0.03444)[source]
-

Bases: SolidMaterial

-

Method generated by attrs for class WetSoil.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_inst_attributes

collects all the attributes for a system

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

plot_attributes

Lists all plot attributes for class

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

validate_class

A customizeable validator at the end of class creation in forge

von_mises_stress_max

Return arrays with the results of pyfunc broadcast (vectorized) over args and kwargs not in excluded.

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

E

G

allowable_stress

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

color

displayname

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

log_silo

logger

nu

numeric_as_dict

numeric_hash

rho

shear_modulus

Shear Modulus

slack_webhook_url

ultimate_stress

unique_hash

unique_id

yield_stress

name

density

elastic_modulus

yield_strength

tensile_strength_ultimate

poissons_ratio

melting_point

maxium_service_temp

thermal_conductivity

specific_heat

thermal_expansion

electrical_resistitivity

cost_per_kg

in_shear_modulus

hardness

izod

factor_of_saftey

-
-
Parameters:
-
    -

  • name (str)

    • -

  • color (float)

    • -

  • in_shear_modulus (float)

    • -

  • hardness (float)

    • -

  • izod (float)

    • -

  • factor_of_saftey (float)

    • -

  • density (float)

    • -

  • elastic_modulus (float)

    • -

  • yield_strength (float)

    • -

  • tensile_strength_ultimate (float)

    • -

  • poissons_ratio (float)

    • -

  • melting_point (float)

    • -

  • maxium_service_temp (float)

    • -

  • thermal_conductivity (float)

    • -

  • specific_heat (float)

    • -

  • thermal_expansion (float)

    • -

  • electrical_resistitivity (float)

    • -

  • cost_per_kg (float)

    • -
-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-property shear_modulus: float
-

Shear Modulus

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-von_mises_stress_max(**kwargs)
-

Return arrays with the results of pyfunc broadcast (vectorized) over -args and kwargs not in excluded.

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.solid_materials.html b/docs/_build/html/_autosummary/engforge.eng.solid_materials.html deleted file mode 100644 index c06f77a..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.solid_materials.html +++ /dev/null @@ -1,222 +0,0 @@ - - - - - - - engforge.eng.solid_materials — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.solid_materials

-

Functions

- - - - - - - - - -

ih

ignore hash

random_color

-

Classes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

ANSI_4130

Method generated by attrs for class ANSI_4130.

ANSI_4340

Method generated by attrs for class ANSI_4340.

Aluminum

Method generated by attrs for class Aluminum.

CarbonFiber

Method generated by attrs for class CarbonFiber.

Concrete

Method generated by attrs for class Concrete.

DrySoil

Method generated by attrs for class DrySoil.

Rock

Method generated by attrs for class Rock.

Rubber

Method generated by attrs for class Rubber.

SS_316

Method generated by attrs for class SS_316.

SolidMaterial

A class to hold physical properties of solid structural materials and act as both a section property material and a pynite material

WetSoil

Method generated by attrs for class WetSoil.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.solid_materials.ih.html b/docs/_build/html/_autosummary/engforge.eng.solid_materials.ih.html deleted file mode 100644 index 195360a..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.solid_materials.ih.html +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - - engforge.eng.solid_materials.ih — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.solid_materials.ih

-
-
-ih(val)[source]
-

ignore hash

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.solid_materials.random_color.html b/docs/_build/html/_autosummary/engforge.eng.solid_materials.random_color.html deleted file mode 100644 index fc49670..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.solid_materials.random_color.html +++ /dev/null @@ -1,179 +0,0 @@ - - - - - - - engforge.eng.solid_materials.random_color — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.solid_materials.random_color

-
-
-random_color()[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.structure_beams.Beam.html b/docs/_build/html/_autosummary/engforge.eng.structure_beams.Beam.html deleted file mode 100644 index bdc054a..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.structure_beams.Beam.html +++ /dev/null @@ -1,2072 +0,0 @@ - - - - - - - engforge.eng.structure_beams.Beam — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.structure_beams.Beam

-
-
-class Beam(*, name, parent=None, cost_per_item=nan, structure, material, section, in_Iy=None, in_Ix=None, in_J=None, in_A=None, in_Ixy=0.0, min_mesh_size=0.01, analysis_intervals=3)[source]
-

Bases: Component, CostModel

-

Beam is a wrapper for emergent useful properties of the structure

-

Method generated by attrs for class Beam.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

all_categories

apply_distributed_load

add forces in global vector

apply_gravity_force

apply_gravity_force_distribution

apply_local_distributed_load

add forces in global vector

apply_local_pt_load

add a force in a global orientation

apply_pt_load

add a force in a global orientation

calculate_item_cost

override this with a parametric model related to this systems attributes and properties

calculate_stress

takes force input and runs stress calculation as a fraction of material properties, see ShapelySection.calculate_stress() for more details

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

class_cost_properties

returns cost_property objects from this class & subclasses

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

cost_categories_at_term

costs_at_term

returns a dictionary of all costs at term i, with zero if the mode function returns False at that term

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

custom_cost

Takes class costs set, and creates a copy of the class costs, then applies the cost numeric or CostMethod in the same way but only for that instance of

debug

Writes at a low level to the log file.

default_cost

Provide a default cost for Slot items that are not CostModel's.

determine_nearest_stationary_state

determine the nearest stationary state

dict_itemized_costs

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

estimate_stress

uses the best available method to determine max stress in the beam, for ShapelySections this is done through a learning process, for other sections it is done through a simple calculation aimed at providing a conservative estimate

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_forces_at

outputs pynite results in section_properties.calculate_stress() input

get_stress_at

takes force input and runs stress calculation as a fraction of material properties

get_system_input_refs

Get the references to system input based on the specified criteria.

get_valid_force_choices

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

max_von_mises

The worst of the worst cases, after adjusting the beem orientation for best loading

max_von_mises_by_case

Gathers max vonmises stress info per case

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

reset_cls_costs

section_results

section_stresses

set_attr

set_default_costs

set default costs if no costs are set

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

show_mesh

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

sub_costs

gets items from CostModel's defined in a Slot attribute or in a slot default, tolerrant to nan's in cost definitions

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

sum_costs

sums costs of cost_property's in this item that are present at term=0, and by category if define as input

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dflt_costs

updates internal default slot costs if the current component doesn't exist or isn't a cost model, this is really a component method but we will use it never the less.

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_section

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

A([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ao

outside area, over ride for hallow sections

CG_RELATIVE_INERTIA

the mass inertia tensor in global frame

E([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Fg

force of gravity

G([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

GLOBAL_INERTIA

Returns the rotated inertia matrix with structure relative parallal axis contribution

INERTIA

the mass inertia tensor in global structure frame

ITensor

Imx([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Imxy([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Imy([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Imz([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ix([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ixy([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Iy([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Iz([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Izo([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

J([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Jm([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

L([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

LOCAL_INERTIA

the mass inertia tensor in local frame

L_vec

P1

P2

ReverseRotationMatrix

RotationMatrix

Ut_ref

alias for input values

Vol([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Vol_outside([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

X1([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

X2([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Xcg([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Xt_ref

alias for state values

Y1([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Y2([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ycg([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Yt_ref

alias for output values

Z1([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Z2([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Zcg([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

centroid2d

classname

Shorthand for the classname

cog

combine_cost([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

cost([fget, fset, fdel, doc])

A thin wrapper over system_property that will be accounted by Economics Components and apply term & categorization

cost_categories

returns itemized costs grouped by category

cost_properties

returns the current values of the current properties

current_combo([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

fail_factor_estimate([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

filename

A nice to have, good to override

future_costs([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

item_cost([fget, fset, fdel, doc])

A thin wrapper over system_property that will be accounted by Economics Components and apply term & categorization

itemized_costs([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

last_context

get the last context run, or the parent's

length([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

log_fmt

log_level

log_on

log_silo

logger

mass([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

max_axial([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

max_deflection_x([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

max_deflection_y([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

max_moment_y([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

max_moment_z([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

max_shear_y([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

max_shear_z([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

max_stress_estimate([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

max_torsion([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

member

min_axial([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

min_deflection_x([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

min_deflection_y([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

min_moment_y([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

min_moment_z([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

min_shear_y([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

min_shear_z([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

min_stress_xy

min_torsion([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

n1

n2

n_vec

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

section_mass([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

sub_items_cost([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

structure

name

material

section

in_Iy

in_Ix

in_J

in_A

in_Ixy

min_mesh_size

analysis_intervals

parent

cost_per_item

dataframe

-
-
Parameters:
-
    -

  • name (str)

    • -

  • parent (Component | System)

    • -

  • cost_per_item (float)

    • -

  • structure (Structure)

    • -

  • material (SolidMaterial)

    • -

  • section (Profile2D)

    • -

  • in_Iy (float)

    • -

  • in_Ix (float)

    • -

  • in_J (float)

    • -

  • in_A (float)

    • -

  • in_Ixy (float)

    • -

  • min_mesh_size (float)

    • -

  • analysis_intervals (int)

    • -
-
-
-
-
-property Ao
-

outside area, over ride for hallow sections

-
- -
-
-property CG_RELATIVE_INERTIA
-

the mass inertia tensor in global frame

-
- -
-
-property Fg
-

force of gravity

-
- -
-
-property GLOBAL_INERTIA
-

Returns the rotated inertia matrix with structure relative parallal axis contribution

-
- -
-
-property INERTIA
-

the mass inertia tensor in global structure frame

-
- -
-
-property LOCAL_INERTIA
-

the mass inertia tensor in local frame

-
- -
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-apply_distributed_load(start_factor=1, end_factor=1, case=None, **kwargs)[source]
-

add forces in global vector

-
- -
-
-apply_local_distributed_load(start_factor=1, end_factor=1, case=None, **kwargs)[source]
-

add forces in global vector

-
- -
-
-apply_local_pt_load(x, case=None, **kwargs)[source]
-

add a force in a global orientation

-
- -
-
-apply_pt_load(x_frac, case=None, **kwargs)[source]
-

add a force in a global orientation

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-calculate_item_cost()
-

override this with a parametric model related to this systems attributes and properties

-
-
Return type:
-

float

-
-
-
- -
-
-calculate_stress(**forces)[source]
-

takes force input and runs stress calculation as a fraction of material properties, see ShapelySection.calculate_stress() for more details

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-classmethod class_cost_properties()
-

returns cost_property objects from this class & subclasses

-
-
Return type:
-

dict

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-property cost_categories
-

returns itemized costs grouped by category

-
- -
-
-property cost_properties: dict
-

returns the current values of the current properties

-
- -
-
-costs_at_term(term, test_val=True)
-

returns a dictionary of all costs at term i, with zero if the mode -function returns False at that term

-
-
Return type:
-

dict

-
-
Parameters:
-

term (int)

-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-custom_cost(slot_name, cost, warn_on_non_costmodel=True)
-

Takes class costs set, and creates a copy of the class costs, then applies the cost numeric or CostMethod in the same way but only for that instance of

-
-
Parameters:
-
    -

  • slot_name (str)

    • -

  • cost (float | CostModel)

    • -
-
-
-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-classmethod default_cost(slot_name, cost, warn_on_non_costmodel=True)
-

Provide a default cost for Slot items that are not CostModel’s. Cost is applied class wide, but can be overriden with custom_cost per instance

-
-
Parameters:
-
    -

  • slot_name (str)

    • -

  • cost (float | CostModel)

    • -
-
-
-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-estimate_stress(force_calc=True, **forces)[source]
-

uses the best available method to determine max stress in the beam, for ShapelySections this is done through a learning process, for other sections it is done through a simple calculation aimed at providing a conservative estimate

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_forces_at(x, combo=None, lower=True, skip_principle=True)[source]
-

outputs pynite results in section_properties.calculate_stress() input

-
- -
-
-get_stress_at(x, combo=None, **kw)[source]
-

takes force input and runs stress calculation as a fraction of material properties

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-max_von_mises()[source]
-

The worst of the worst cases, after adjusting the beem orientation for best loading

-
-
Return type:
-

float

-
-
-
- -
-
-max_von_mises_by_case(combos=None)[source]
-

Gathers max vonmises stress info per case

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_default_costs()
-

set default costs if no costs are set

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-sub_costs(saved=None, categories=None, term=0)
-

gets items from CostModel’s defined in a Slot attribute or in a slot default, tolerrant to nan’s in cost definitions

-
-
Parameters:
-
    -

  • saved (set | None)

    • -

  • categories (tuple | None)

    • -
-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-sum_costs(saved=None, categories=None, term=0)
-

sums costs of cost_property’s in this item that are present at term=0, and by category if define as input

-
-
Parameters:
-
    -

  • saved (set | None)

    • -

  • categories (tuple | None)

    • -
-
-
-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dflt_costs()
-

updates internal default slot costs if the current component doesn’t exist or isn’t a cost model, this is really a component method but we will use it never the less.

-

This should be called from Component.update() if default costs are used

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.structure_beams.html b/docs/_build/html/_autosummary/engforge.eng.structure_beams.html deleted file mode 100644 index 657b35f..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.structure_beams.html +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - - engforge.eng.structure_beams — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.structure_beams

-

Functions

- - - - - - -

rotation_matrix_from_vectors

Find the rotation matrix that aligns vec1 to vec2 :type vec1: :param vec1: A 3d "source" vector :type vec2: :param vec2: A 3d "destination" vector :return mat: A transform matrix (3x3) which when applied to vec1, aligns it with vec2.

-

Classes

- - - - - - -

Beam

Beam is a wrapper for emergent useful properties of the structure

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.structure_beams.rotation_matrix_from_vectors.html b/docs/_build/html/_autosummary/engforge.eng.structure_beams.rotation_matrix_from_vectors.html deleted file mode 100644 index e3b82af..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.structure_beams.rotation_matrix_from_vectors.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - - engforge.eng.structure_beams.rotation_matrix_from_vectors — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.structure_beams.rotation_matrix_from_vectors

-
-
-rotation_matrix_from_vectors(vec1, vec2)[source]
-

Find the rotation matrix that aligns vec1 to vec2 -:type vec1: -:param vec1: A 3d “source” vector -:type vec2: -:param vec2: A 3d “destination” vector -:return mat: A transform matrix (3x3) which when applied to vec1, aligns it with vec2.

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.thermodynamics.SimpleCompressor.html b/docs/_build/html/_autosummary/engforge.eng.thermodynamics.SimpleCompressor.html deleted file mode 100644 index bc391e3..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.thermodynamics.SimpleCompressor.html +++ /dev/null @@ -1,1509 +0,0 @@ - - - - - - - engforge.eng.thermodynamics.SimpleCompressor — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.thermodynamics.SimpleCompressor

-
-
-class SimpleCompressor(*, name='Compressor', parent=None, pressure_ratio, Tin, mdot, Cp, gamma=1.4, efficiency=0.75)[source]
-

Bases: Component

-

Method generated by attrs for class SimpleCompressor.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

pressure_out

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Tout([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

power_input([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

system_id

returns an instance unique id based on id(self)

temperature_ratio([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

time

unique_hash

update_interval

parent

name

dataframe

-
-
Parameters:
-

parent (Component | System)

-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.thermodynamics.SimpleHeatExchanger.html b/docs/_build/html/_autosummary/engforge.eng.thermodynamics.SimpleHeatExchanger.html deleted file mode 100644 index f8e9e59..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.thermodynamics.SimpleHeatExchanger.html +++ /dev/null @@ -1,1518 +0,0 @@ - - - - - - - engforge.eng.thermodynamics.SimpleHeatExchanger — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.thermodynamics.SimpleHeatExchanger

-
-
-class SimpleHeatExchanger(*, name='HeatExchanger', parent=None, Thi, mdot_h, Cp_h, Tci, mdot_c, Cp_c, efficiency=0.8)[source]
-

Bases: Component

-

Method generated by attrs for class SimpleHeatExchanger.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

CmatC([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

CmatH([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Qdot([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Qdot_ideal([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Tc_out([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Th_out([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Tout_ideal([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

parent

name

dataframe

-
-
Parameters:
-

parent (Component | System)

-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.thermodynamics.SimplePump.html b/docs/_build/html/_autosummary/engforge.eng.thermodynamics.SimplePump.html deleted file mode 100644 index b61d80d..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.thermodynamics.SimplePump.html +++ /dev/null @@ -1,1521 +0,0 @@ - - - - - - - engforge.eng.thermodynamics.SimplePump — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.thermodynamics.SimplePump

-
-
-class SimplePump(*, name='pump', parent=None, MFin, pressure_ratio, Tin=293, Pin=101325.0, efficiency=0.75, fluid=NOTHING)[source]
-

Bases: Component

-

Method generated by attrs for class SimplePump.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

eval

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Pout([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Tout([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

cost([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

power_input([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

pressure_delta([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

system_id

returns an instance unique id based on id(self)

temperature_delta([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

time

unique_hash

update_interval

volumetric_flow([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

parent

name

dataframe

-
-
Parameters:
-

parent (Component | System)

-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.thermodynamics.SimpleTurbine.html b/docs/_build/html/_autosummary/engforge.eng.thermodynamics.SimpleTurbine.html deleted file mode 100644 index 177c123..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.thermodynamics.SimpleTurbine.html +++ /dev/null @@ -1,1506 +0,0 @@ - - - - - - - engforge.eng.thermodynamics.SimpleTurbine — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.thermodynamics.SimpleTurbine

-
-
-class SimpleTurbine(*, name='Turbine', parent=None, Pout, Pin, Tin, mdot, Cp, gamma=1.4, efficiency=0.8)[source]
-

Bases: Component

-

Method generated by attrs for class SimpleTurbine.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Tout([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

dXtdt_ref

a dictionary of state var rates

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe_constants

dataframe_variants

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

power_output([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

pressure_ratio([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

static_A

static_B

static_C

static_D

static_F

static_K

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

parent

name

dataframe

-
-
Parameters:
-

parent (Component | System)

-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.thermodynamics.dp_he_core.html b/docs/_build/html/_autosummary/engforge.eng.thermodynamics.dp_he_core.html deleted file mode 100644 index 5319224..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.thermodynamics.dp_he_core.html +++ /dev/null @@ -1,186 +0,0 @@ - - - - - - - engforge.eng.thermodynamics.dp_he_core — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.thermodynamics.dp_he_core

-
-
-dp_he_core(G, f, L, rho, Dh)[source]
-

Losses due to friction -:type f: -:param f: fanning friction factor -:type G: -:param G: mass flux (massflow / Area) -:type L: -:param L: length of heat exchanger -:type rho: -:param rho: intermediate density -:type Dh: -:param Dh: diameter of heat exchanger

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.thermodynamics.dp_he_entrance.html b/docs/_build/html/_autosummary/engforge.eng.thermodynamics.dp_he_entrance.html deleted file mode 100644 index 7e1f4c1..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.thermodynamics.dp_he_entrance.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - - engforge.eng.thermodynamics.dp_he_entrance — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.thermodynamics.dp_he_entrance

-
-
-dp_he_entrance(sigma, G, rho)[source]
-

Heat Exchanger Entrance Pressure Loss -:type sigma: -:param sigma: contraction-ratio - ratio of minimum flow area to frontal area -:type G: -:param G: mass flux of fluid -:type rho: -:param rho: density of fluid

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.thermodynamics.dp_he_exit.html b/docs/_build/html/_autosummary/engforge.eng.thermodynamics.dp_he_exit.html deleted file mode 100644 index 99c8936..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.thermodynamics.dp_he_exit.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - - engforge.eng.thermodynamics.dp_he_exit — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.thermodynamics.dp_he_exit

-
-
-dp_he_exit(sigma, G, rho)[source]
-

Heat Exchanger Exit Pressure Loss -:type sigma: -:param sigma: contraction-ratio - ratio of minimum flow area to frontal area -:type G: -:param G: mass flux of fluid -:type rho: -:param rho: density of fluid

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.thermodynamics.dp_he_gas_losses.html b/docs/_build/html/_autosummary/engforge.eng.thermodynamics.dp_he_gas_losses.html deleted file mode 100644 index ccfbd4d..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.thermodynamics.dp_he_gas_losses.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - - engforge.eng.thermodynamics.dp_he_gas_losses — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.thermodynamics.dp_he_gas_losses

-
-
-dp_he_gas_losses(G, rhoe, rhoi)[source]
-

Measures the pressure loss or gain due to density changes in the HE -:type G: -:param G: mass flux -:type rhoe: -:param rhoe: exit density -:type rhoi: -:param rhoi: entrance density

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.thermodynamics.fanning_friction_factor.html b/docs/_build/html/_autosummary/engforge.eng.thermodynamics.fanning_friction_factor.html deleted file mode 100644 index da988c5..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.thermodynamics.fanning_friction_factor.html +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - - engforge.eng.thermodynamics.fanning_friction_factor — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.thermodynamics.fanning_friction_factor

-
-
-fanning_friction_factor(Re, method='turbulent')[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.eng.thermodynamics.html b/docs/_build/html/_autosummary/engforge.eng.thermodynamics.html deleted file mode 100644 index e2fcebb..0000000 --- a/docs/_build/html/_autosummary/engforge.eng.thermodynamics.html +++ /dev/null @@ -1,206 +0,0 @@ - - - - - - - engforge.eng.thermodynamics — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.eng.thermodynamics

-

Functions

- - - - - - - - - - - - - - - - - - -

dp_he_core

Losses due to friction :type f: :param f: fanning friction factor :type G: :param G: mass flux (massflow / Area) :type L: :param L: length of heat exchanger :type rho: :param rho: intermediate density :type Dh: :param Dh: diameter of heat exchanger

dp_he_entrance

Heat Exchanger Entrance Pressure Loss :type sigma: :param sigma: contraction-ratio - ratio of minimum flow area to frontal area :type G: :param G: mass flux of fluid :type rho: :param rho: density of fluid

dp_he_exit

Heat Exchanger Exit Pressure Loss :type sigma: :param sigma: contraction-ratio - ratio of minimum flow area to frontal area :type G: :param G: mass flux of fluid :type rho: :param rho: density of fluid

dp_he_gas_losses

Measures the pressure loss or gain due to density changes in the HE :type G: :param G: mass flux :type rhoe: :param rhoe: exit density :type rhoi: :param rhoi: entrance density

fanning_friction_factor

-

Classes

- - - - - - - - - - - - - - - -

SimpleCompressor

Method generated by attrs for class SimpleCompressor.

SimpleHeatExchanger

Method generated by attrs for class SimpleHeatExchanger.

SimplePump

Method generated by attrs for class SimplePump.

SimpleTurbine

Method generated by attrs for class SimpleTurbine.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.engforge_attributes.AttributedBaseMixin.html b/docs/_build/html/_autosummary/engforge.engforge_attributes.AttributedBaseMixin.html deleted file mode 100644 index 785930c..0000000 --- a/docs/_build/html/_autosummary/engforge.engforge_attributes.AttributedBaseMixin.html +++ /dev/null @@ -1,533 +0,0 @@ - - - - - - - engforge.engforge_attributes.AttributedBaseMixin — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.engforge_attributes.AttributedBaseMixin

-
-
-class AttributedBaseMixin(name='')[source]
-

Bases: LoggingMixin

-

A mixin that adds the ability to configure all engforge.core attributes of a class

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

collect_all_attributes

collects all the attributes for a system

collect_inst_attributes

collects all the attributes for a system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

plot_attributes

Lists all plot attributes for class

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

as_dict

returns values as they are in the class instance

attrs_fields

identity

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

logger

numeric_as_dict

numeric_hash

slack_webhook_url

unique_hash

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)[source]
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-classmethod collect_all_attributes()[source]
-

collects all the attributes for a system

-
- -
-
-collect_inst_attributes(**kw)[source]
-

collects all the attributes for a system

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)[source]
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)[source]
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-classmethod plot_attributes()[source]
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-setattrs(dict)[source]
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()[source]
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)[source]
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()[source]
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()[source]
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod trace_attributes()[source]
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()[source]
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.engforge_attributes.EngAttr.html b/docs/_build/html/_autosummary/engforge.engforge_attributes.EngAttr.html deleted file mode 100644 index 18324fb..0000000 --- a/docs/_build/html/_autosummary/engforge.engforge_attributes.EngAttr.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - - - - engforge.engforge_attributes.EngAttr — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.engforge_attributes.EngAttr

-
-
-class EngAttr(name='')[source]
-

Bases: LoggingMixin

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.engforge_attributes.get_attributes_of.html b/docs/_build/html/_autosummary/engforge.engforge_attributes.get_attributes_of.html deleted file mode 100644 index 878c573..0000000 --- a/docs/_build/html/_autosummary/engforge.engforge_attributes.get_attributes_of.html +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - - engforge.engforge_attributes.get_attributes_of — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.engforge_attributes.get_attributes_of

-
-
-get_attributes_of(cls, subclass_of=None, exclude=False)[source]
-
-
Parameters:
-

subclass_of (type | None)

-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.engforge_attributes.html b/docs/_build/html/_autosummary/engforge.engforge_attributes.html deleted file mode 100644 index b8630cb..0000000 --- a/docs/_build/html/_autosummary/engforge.engforge_attributes.html +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - - engforge.engforge_attributes — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.engforge_attributes
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.engforge_attributes

-

Functions

- - - - - - -

get_attributes_of

-

Classes

- - - - - - - - - -

AttributedBaseMixin

A mixin that adds the ability to configure all engforge.core attributes of a class

EngAttr

Initialize a filter.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.env_var.EnvVariable.html b/docs/_build/html/_autosummary/engforge.env_var.EnvVariable.html deleted file mode 100644 index af18270..0000000 --- a/docs/_build/html/_autosummary/engforge.env_var.EnvVariable.html +++ /dev/null @@ -1,393 +0,0 @@ - - - - - - - engforge.env_var.EnvVariable — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.env_var.EnvVariable

-
-
-class EnvVariable(secret_var_name, type_conv=None, default=None, obscure=False, fail_on_missing=False, desc=None, dontovrride=False)[source]
-

Bases: LoggingMixin

-

A method to wrap SECRETS and in application with a way to get the value using self.secret -Do not store values from self.secret to ensure security

-

You can override the secret with _override

-

pass arguments to SecretVariable to have it look up information at runtime from envargs, but not store it in memory. -:type secret_var_name: -:param secret_var_name: the enviornmental variable -:type type_conv: -:param type_conv: the data from env vars will be converted with this function -:type default: -:param default: the value to use if the secret_var_name doesn’t exist in enviornmental variables -:type obscure: -:param obscure: default True, will prevent the result being printed by str(self) -:type fail_on_missing: -:param fail_on_missing: if the secret env variable is not found, and default is None -:type desc: Optional[str] -:param desc: a description of the purpose of the variable

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

load_env_vars

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

print_env_vars

prints env vars in memory

remove

removes this secret from the record

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

default

desc

identity

in_env

log_fmt

log_level

log_on

logger

obscure

obscured_name

secret

slack_webhook_url

type_conv

var_name

fail_on_missing

-
-
Parameters:
-
    -

  • type_conv (Any)

    • -

  • default (Any)

    • -

  • obscure (bool)

    • -

  • fail_on_missing (bool)

    • -

  • desc (str)

    • -
-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-classmethod print_env_vars()[source]
-

prints env vars in memory

-
- -
-
-remove()[source]
-

removes this secret from the record

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.env_var.html b/docs/_build/html/_autosummary/engforge.env_var.html deleted file mode 100644 index acca0c7..0000000 --- a/docs/_build/html/_autosummary/engforge.env_var.html +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - - engforge.env_var — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.env_var

-

Defines a class called EnvVariable that defines an interface for env variables with an option to obscure and convert variables, as well as provide a default option.

-

A global record of variables is kept for informational purposes in keeping track of progam variables

-

To prevent storage of env vars in program memory, access to the os env variables is provided on access of the secret variable. It is advisable to use the result of this as directly as possible when dealing with actual secrets.

-

For example add: `db_driver(DB_HOST.secret,DB_PASSWORD.secret,…)

-

Functions

- - - - - - -

parse_bool

-

Classes

- - - - - - -

EnvVariable

A method to wrap SECRETS and in application with a way to get the value using self.secret Do not store values from self.secret to ensure security

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.env_var.parse_bool.html b/docs/_build/html/_autosummary/engforge.env_var.parse_bool.html deleted file mode 100644 index c1a8937..0000000 --- a/docs/_build/html/_autosummary/engforge.env_var.parse_bool.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - - engforge.env_var.parse_bool — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.env_var.parse_bool

-
-
-parse_bool(input)[source]
-
-
Parameters:
-

input (str)

-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.html b/docs/_build/html/_autosummary/engforge.html deleted file mode 100644 index d43c426..0000000 --- a/docs/_build/html/_autosummary/engforge.html +++ /dev/null @@ -1,240 +0,0 @@ - - - - - - - engforge — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • -
    • -
-
-
-
-
- -
-

engforge

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

analysis

attr_dynamics

attr_plotting

This module defines Plot and Trace methods that allow the plotting of Statistical & Transient relationships of data in each system

attr_signals

This module defines the slot attrs attribute to define the update behavior of a component or between components in an analysis

attr_slots

This module defines the slot attrs attribute to ensure the type of component added is correct and to define behavior,defaults and argument passing behavio

attr_solver

solver defines a SolverMixin for use by System.

attributes

Defines a customizeable attrs attribute that is handled in configuration,

common

A set of common values and functions that are globaly available.

component_collections

define a collection of components that will propigate to its parents dataframe

components

configuration

dataframe

Dataframe Module:

datastores

dynamics

Combines the tabulation and component mixins to create a mixin for systems and components that have dynamics, such as state space models, while allowing nonlinear dynamics via matrix modification

eng

engforge_attributes

env_var

Defines a class called EnvVariable that defines an interface for env variables with an option to obscure and convert variables, as well as provide a default option.

locations

logging

patterns

problem_context

The ProblemExec provides a uniform set of options for managing the state of the system and its solvables, establishing the selection of combos or de/active attributes to Solvables.

properties

Like typical python properties, normal functions are embelished with additional functionality.

reporting

The set of reporters define an interface to report plots or tables

solveable

solver

solver defines a SolverMixin for use by System.

solver_utils

system

A System is a Configuration that orchestrates dataflow between components, as well as solving systems of equations in the presense of limits, as well as formatting results of each Component into reporting ready dataframe.

system_reference

Module to define the Ref class and utility methods for working with it.

tabulation

Tabulation Module:

typing

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.locations.client_path.html b/docs/_build/html/_autosummary/engforge.locations.client_path.html deleted file mode 100644 index 41617a4..0000000 --- a/docs/_build/html/_autosummary/engforge.locations.client_path.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - - engforge.locations.client_path — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.locations.client_path

-
-
-client_path(alternate_path=None, **kw)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.locations.html b/docs/_build/html/_autosummary/engforge.locations.html deleted file mode 100644 index 54b92ff..0000000 --- a/docs/_build/html/_autosummary/engforge.locations.html +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - - engforge.locations — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.locations
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.locations

-

Functions

- - - - - - -

client_path

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.logging.Log.html b/docs/_build/html/_autosummary/engforge.logging.Log.html deleted file mode 100644 index b8bf34c..0000000 --- a/docs/_build/html/_autosummary/engforge.logging.Log.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - - - - engforge.logging.Log — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.logging.Log

-
-
-class Log(name='')[source]
-

Bases: LoggingMixin

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.logging.LoggingMixin.html b/docs/_build/html/_autosummary/engforge.logging.LoggingMixin.html deleted file mode 100644 index f4d04c4..0000000 --- a/docs/_build/html/_autosummary/engforge.logging.LoggingMixin.html +++ /dev/null @@ -1,324 +0,0 @@ - - - - - - - engforge.logging.LoggingMixin — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.logging.LoggingMixin

-
-
-class LoggingMixin(name='')[source]
-

Bases: Filter

-

Class to include easy formatting in subclasses

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)[source]
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)[source]
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)[source]
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')[source]
-

Writes to log as a error

-
- -
-
-filter(record)[source]
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)[source]
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()[source]
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)[source]
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)[source]
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()[source]
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)[source]
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)[source]
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.logging.change_all_log_levels.html b/docs/_build/html/_autosummary/engforge.logging.change_all_log_levels.html deleted file mode 100644 index b316259..0000000 --- a/docs/_build/html/_autosummary/engforge.logging.change_all_log_levels.html +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - - engforge.logging.change_all_log_levels — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.logging.change_all_log_levels

-
-
-change_all_log_levels(inst=None, new_log_level=20, check_function=None)[source]
-

Changes All Log Levels With pyee broadcast before reactor is running -:type new_log_level: int -:param new_log_level: int - changes unit level log level (10-msg,20-debug,30-info,40-warning,50-error,60-crit) -:type check_function: -:param check_function: callable -> bool - (optional) if provided if check_function(unit) is true then the new_log_level is applied

-
-
Parameters:
-

new_log_level (int)

-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.logging.html b/docs/_build/html/_autosummary/engforge.logging.html deleted file mode 100644 index 515eb80..0000000 --- a/docs/_build/html/_autosummary/engforge.logging.html +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - - engforge.logging — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.logging

-

Functions

- - - - - - -

change_all_log_levels

Changes All Log Levels With pyee broadcast before reactor is running :type new_log_level: int :param new_log_level: int - changes unit level log level (10-msg,20-debug,30-info,40-warning,50-error,60-crit) :type check_function: :param check_function: callable -> bool - (optional) if provided if check_function(unit) is true then the new_log_level is applied

-

Classes

- - - - - - - - - -

Log

Initialize a filter.

LoggingMixin

Class to include easy formatting in subclasses

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.patterns.InputSingletonMeta.html b/docs/_build/html/_autosummary/engforge.patterns.InputSingletonMeta.html deleted file mode 100644 index 25768a2..0000000 --- a/docs/_build/html/_autosummary/engforge.patterns.InputSingletonMeta.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - - - engforge.patterns.InputSingletonMeta — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.patterns.InputSingletonMeta

-
-
-class InputSingletonMeta[source]
-

Bases: type

-

Metaclass for singletons. Any instantiation of a Singleton class yields -the exact same object, for the same given input, e.g.:

-
>>> class MyClass(metaclass=Singleton):
-        pass
->>> a = MyClass(input='same')
->>> b = MyClass(input='diff')
->>> a is b
-False
-
-
-

Methods

- - - - - - -

mro

Return a type's method resolution order.

-
-
-__call__(*args, **kwargs)[source]
-

Call self as a function.

-
- -
-
-mro()
-

Return a type’s method resolution order.

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.patterns.Singleton.html b/docs/_build/html/_autosummary/engforge.patterns.Singleton.html deleted file mode 100644 index b5e7f92..0000000 --- a/docs/_build/html/_autosummary/engforge.patterns.Singleton.html +++ /dev/null @@ -1,198 +0,0 @@ - - - - - - - engforge.patterns.Singleton — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.patterns.Singleton

-
-
-class Singleton(decorated)[source]
-

Bases: object

-

A non-thread-safe helper class to ease implementing singletons. -This should be used as a decorator – not a metaclass – to the -class that should be a singleton.

-

The decorated class can define one __init__ function that -takes only the self argument. Also, the decorated class cannot be -inherited from. Other than that, there are no restrictions that apply -to the decorated class.

-

To get the singleton instance, use the instance method. Trying -to use __call__ will result in a TypeError being raised.

-

Methods

- - - - - - -

instance

Returns the singleton instance.

-
-
-__call__()[source]
-

Call self as a function.

-
- -
-
-instance(*args, **kwargs)[source]
-

Returns the singleton instance. Upon its first call, it creates a -new instance of the decorated class and calls its __init__ method. -On all subsequent calls, the already created instance is returned.

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.patterns.SingletonMeta.html b/docs/_build/html/_autosummary/engforge.patterns.SingletonMeta.html deleted file mode 100644 index 5e9daa5..0000000 --- a/docs/_build/html/_autosummary/engforge.patterns.SingletonMeta.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - - - engforge.patterns.SingletonMeta — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.patterns.SingletonMeta

-
-
-class SingletonMeta[source]
-

Bases: type

-

Metaclass for singletons. Any instantiation of a Singleton class yields -the exact same object, e.g.:

-
>>> class MyClass(metaclass=Singleton):
-        pass
->>> a = MyClass()
->>> b = MyClass()
->>> a is b
-True
-
-
-

Methods

- - - - - - -

mro

Return a type's method resolution order.

-
-
-__call__(*args, **kwargs)[source]
-

Call self as a function.

-
- -
-
-mro()
-

Return a type’s method resolution order.

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.patterns.chunks.html b/docs/_build/html/_autosummary/engforge.patterns.chunks.html deleted file mode 100644 index c14eee8..0000000 --- a/docs/_build/html/_autosummary/engforge.patterns.chunks.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - engforge.patterns.chunks — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.patterns.chunks

-
-
-chunks(lst, n)[source]
-

Yield successive n-sized chunks from lst.

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.patterns.flat2gen.html b/docs/_build/html/_autosummary/engforge.patterns.flat2gen.html deleted file mode 100644 index 6b5ce0d..0000000 --- a/docs/_build/html/_autosummary/engforge.patterns.flat2gen.html +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - - engforge.patterns.flat2gen — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.patterns.flat2gen

-
-
-flat2gen(alist)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.patterns.flatten.html b/docs/_build/html/_autosummary/engforge.patterns.flatten.html deleted file mode 100644 index ccd8869..0000000 --- a/docs/_build/html/_autosummary/engforge.patterns.flatten.html +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - - engforge.patterns.flatten — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.patterns.flatten

-
-
-flatten(alist)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.patterns.html b/docs/_build/html/_autosummary/engforge.patterns.html deleted file mode 100644 index d042c0c..0000000 --- a/docs/_build/html/_autosummary/engforge.patterns.html +++ /dev/null @@ -1,191 +0,0 @@ - - - - - - - engforge.patterns — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.patterns
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.patterns

-

Functions

- - - - - - - - - - - - - - - -

chunks

Yield successive n-sized chunks from lst.

flat2gen

flatten

singleton_meta_object

Class decorator that transforms (and replaces) a class definition (which must have a Singleton metaclass) with the actual singleton object.

-

Classes

- - - - - - - - - - - - - - - -

InputSingletonMeta

Metaclass for singletons.

Singleton

A non-thread-safe helper class to ease implementing singletons.

SingletonMeta

Metaclass for singletons.

inst_vectorize

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.patterns.inst_vectorize.html b/docs/_build/html/_autosummary/engforge.patterns.inst_vectorize.html deleted file mode 100644 index 411924b..0000000 --- a/docs/_build/html/_autosummary/engforge.patterns.inst_vectorize.html +++ /dev/null @@ -1,179 +0,0 @@ - - - - - - - engforge.patterns.inst_vectorize — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.patterns.inst_vectorize

-
-
-class inst_vectorize(pyfunc, otypes=None, doc=None, excluded=None, cache=False, signature=None)[source]
-

Bases: vectorize

-

Methods

- - - -
-
-
-__call__(*args, **kwargs)
-

Return arrays with the results of pyfunc broadcast (vectorized) over -args and kwargs not in excluded.

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.patterns.singleton_meta_object.html b/docs/_build/html/_autosummary/engforge.patterns.singleton_meta_object.html deleted file mode 100644 index 0c9f341..0000000 --- a/docs/_build/html/_autosummary/engforge.patterns.singleton_meta_object.html +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - - engforge.patterns.singleton_meta_object — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.patterns.singleton_meta_object

-
-
-singleton_meta_object(cls)[source]
-

Class decorator that transforms (and replaces) a class definition (which -must have a Singleton metaclass) with the actual singleton object. Ensures -that the resulting object can still be “instantiated” (i.e., called), -returning the same object. Also ensures the object can be pickled, is -hashable, and has the correct string representation (the name of the -singleton)

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.problem_context.IllegalArgument.html b/docs/_build/html/_autosummary/engforge.problem_context.IllegalArgument.html deleted file mode 100644 index 427d59f..0000000 --- a/docs/_build/html/_autosummary/engforge.problem_context.IllegalArgument.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - - engforge.problem_context.IllegalArgument — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.problem_context.IllegalArgument

-
-
-exception IllegalArgument[source]
-

an exception to exit the problem context as specified

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.problem_context.ProbLog.html b/docs/_build/html/_autosummary/engforge.problem_context.ProbLog.html deleted file mode 100644 index 178209c..0000000 --- a/docs/_build/html/_autosummary/engforge.problem_context.ProbLog.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - - engforge.problem_context.ProbLog — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.problem_context.ProbLog

-
-
-class ProbLog(name='')[source]
-

Bases: LoggingMixin

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.problem_context.Problem.html b/docs/_build/html/_autosummary/engforge.problem_context.Problem.html deleted file mode 100644 index 22c9934..0000000 --- a/docs/_build/html/_autosummary/engforge.problem_context.Problem.html +++ /dev/null @@ -1,866 +0,0 @@ - - - - - - - engforge.problem_context.Problem — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.problem_context.Problem

-
-
-class Problem(system, kw_dict=None, Xnew=None, ctx_fail_new=False, **opts)[source]
-

Bases: ProblemExec, DataframeMixin

-

Initializes the ProblemExec.

-

#TODO: exit system should abide by update / signals options

-

#TODO: provide data storage options for dataframe / table storage history/ record keeping (ss vs transient data)

-

#TODO: create an option to copy the system and run operations on it, and options for applying the state from the optimized copy to the original system

-
-
Parameters:
-
    -

  • system – The system to be executed.

    • -

  • Xnew – The new state of the system to set wrt. reversion, optional

    • -

  • ctx_fail_new – Whether to raise an error if no execution context is available, use in utility methods ect. Default is False.

    • -

  • kw_dict – A keyword argument dictionary to be parsed for solver options, and removed from the outer context. Changes are made to this dictionary, so they are removed automatically from the outer context, and thus no longer passed to interior vars.

    • -

  • dxdt – The dynamics integration method. Default is None meaning that dynamic vars are not considered for minimization unless otherwise specified. Steady State can be specified by dxdt=0 all dynamic vars are considered as solver variables, with the constraint that their rate of change is zero. If a dictionary is passed then the dynamic vars are considered as solver variables, with the constraint that their rate of change is equal to the value in the dictionary, and all other unspecified rates are zero (steady).

    • -
-
-
-

#### Solver Selection Options -:param combos: The selection of combos. Default is ‘*’ (select all). -:param ign_combos: The combos to be ignored. -:param only_combos: The combos to be selected. -:param add_obj: Whether to add an objective to the solver. Default is True. -:param slv_vars: The selection of solvables. Default is ‘*’ (select all). -:param add_vars: The solvables to be added to the solver. -:param ign_vars: The solvables to be ignored. -:param only_vars: The solvables to be selected. -:param only_active: Whether to select only active items. Default is True. -:param activate: The solvables to be activated. -:param deactivate: The solvables to be deactivated. -:param fail_revert: Whether to raise an error if no solvables are selected. Default is True. -:param revert_last: Whether to revert the last change. Default is True. -:param revert_every: Whether to revert every change. Default is True. -:param exit_on_failure: Whether to exit on failure, or continue on. Default is True.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

activate_temp_state

apply_post_signals

applies all post signals

apply_pre_signals

applies all pre signals

clean_context

critical

debug

debug_levels

debug the levels of the context

discard_contexts

discard all contexts

error

error_action

handles the error action wrt to the problem

establish_system

caches the system references, and parses the system arguments

exit_action

handles the exit action wrt system

exit_and_revert

exit_to_level

exit_with_state

filter_vars

selects only settable refs

format_columns

get_extra_kws

extracts the combo input from the kwargs

get_parent_key

returns the parent key of the key

get_ref_values

returns the values of the refs

get_sesh

get the session

handle_solution

info

integral_rate

provides the dynamic rate of the system at time t, and state x

integrate

min_refresh

msg

parse_default

splits strings or lists and returns a list of options for the key, if nothing found returns None if fail set to True raises an exception, otherwise returns the default value

persist_contexts

convert all contexts to a new storage format

pos_obj

converts an objective to a positive value

post_execute

Updates the post/both signals after the solver has been executed.

post_update_system

updates the system

pre_execute

Updates the pre/both signals after the solver has been executed.

refresh_references

refresh the system references

reset_contexts

reset all contexts to a new storage format

reset_data

reset the data storage

revert_to_start

save_data

save data to the context

set_checkpoint

sets the checkpoint

set_ref_values

returns the values of the refs

set_time

smart_split_dataframe

splits dataframe between constant values and variants

solve_min

Solve the minimization problem using the given vars and constraints.

sys_solver_constraints

formatted as arguments for the solver

sys_solver_objectives

gathers variables from solver vars, and attempts to locate any input_vars to add as well.

update_dynamics

update_methods

update_system

updates the system

warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

all_components

returns all variables in the system

all_comps

returns all variables in the system

all_comps_and_vars

all_problem_vars

solver variables + dynamics states when dynamic_solve is True

all_system_references

all_variable_refs

all_variables

returns all variables in the system

attr_inst

check_dynamics

copy_system

dataframe

returns the dataframe of the system

dataframe_constants

dataframe_variants

dynamic_comps

dynamic_rate

dynamic_rate_eq

dynamic_solve

indicates if the system is dynamic

dynamic_state

enter_refresh

entered

exit_on_failure

exited

fail_revert

final_objectives

returns the final objective of the system

identity

integrator_rate_refs

combine the dynamic state and the integrator rates to get the transient state of the system, but convert their keys to the target var names

integrator_rates

integrator_var_refs

combine the dynamic state and the integrator rates to get the transient state of the system, but convert their keys to the target var names

integrator_vars

integrators

is_active

checks if the context has been entered and not exited

kwargs

copy of slv_kw args

level_name

level_number

log_level

opt_fail

output_state

records the state of the system

post_callback

post_exec

pre_exec

problem_eq

problem_id

problem_ineq

problem_input

problem_objs

problem_opt_vars

solver variables

problems_dict

raise_on_unknown

record_state

records the state of the system using session

ref_attrs

revert_every

revert_last

run_solver

save_mode

save_on_exit

sesh

caches the property for the session

session_id

signal_inst

signals

signals_source

signals_target

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

solveable

checks the system's references to determine if its solveabl

solver_inst

success_thresh

system

session

x_start

-
-
-property all_components: dict
-

returns all variables in the system

-
- -
-
-property all_comps: dict
-

returns all variables in the system

-
- -
-
-property all_problem_vars: dict
-

solver variables + dynamics states when dynamic_solve is True

-
- -
-
-property all_variables: dict
-

returns all variables in the system

-
- -
-
-apply_post_signals()
-

applies all post signals

-
- -
-
-apply_pre_signals()
-

applies all pre signals

-
- -
-
-class_cache
-

alias of ProblemExec

-
- -
-
-property dataframe: DataFrame
-

returns the dataframe of the system

-
- -
-
-debug_levels()
-

debug the levels of the context

-
- -
-
-discard_contexts()
-

discard all contexts

-
- -
-
-property dynamic_solve: bool
-

indicates if the system is dynamic

-
- -
-
-error_action(error)
-

handles the error action wrt to the problem

-
- -
-
-establish_system(system, kw_dict, **kwargs)
-

caches the system references, and parses the system arguments

-
- -
-
-exit_action()
-

handles the exit action wrt system

-
- -
-
-filter_vars(refs)
-

selects only settable refs

-
-
Parameters:
-

refs (list)

-
-
-
- -
-
-property final_objectives: dict
-

returns the final objective of the system

-
- -
-
-classmethod get_extra_kws(kwargs, _check_keys={'activate': None, 'add_obj': True, 'add_vars': None, 'both_match': True, 'combos': 'default', 'deactivate': None, 'dxdt': None, 'ign_combos': None, 'ign_vars': None, 'obj': None, 'only_active': True, 'only_combos': None, 'only_vars': None, 'slv_vars': '*', 'weights': None}, rmv=False, use_defaults=True)
-

extracts the combo input from the kwargs

-
-
Parameters:
-

_check_keys (dict)

-
-
-
- -
-
-get_parent_key(key, look_back_num=1)
-

returns the parent key of the key

-
- -
-
-get_ref_values(refs=None)
-

returns the values of the refs

-
- -
-
-get_sesh(sesh=None)
-

get the session

-
- -
-
-integral_rate(t, x, dt, Xss=None, Yobj=None, **kw)
-

provides the dynamic rate of the system at time t, and state x

-
- -
-
-property integrator_rate_refs
-

combine the dynamic state and the integrator rates to get the transient state of the system, but convert their keys to the target var names

-
- -
-
-property integrator_var_refs
-

combine the dynamic state and the integrator rates to get the transient state of the system, but convert their keys to the target var names

-
- -
-
-property is_active
-

checks if the context has been entered and not exited

-
- -
-
-property kwargs
-

copy of slv_kw args

-
- -
-
-property output_state: dict
-

records the state of the system

-
- -
-
-classmethod parse_default(key, defaults, input_dict, rmv=False, empty_str=True)
-

splits strings or lists and returns a list of options for the key, if nothing found returns None if fail set to True raises an exception, otherwise returns the default value

-
- -
-
-persist_contexts()
-

convert all contexts to a new storage format

-
- -
-
-pos_obj(ref)
-

converts an objective to a positive value

-
- -
-
-post_execute(*args, **kwargs)
-

Updates the post/both signals after the solver has been executed. This is useful for updating the system state after the solver has been executed.

-
- -
-
-post_update_system(*args, **kwargs)
-

updates the system

-
- -
-
-pre_execute(*args, **kwargs)
-

Updates the pre/both signals after the solver has been executed. This is useful for updating the system state after the solver has been executed.

-
- -
-
-property problem_opt_vars: dict
-

solver variables

-
- -
-
-property record_state: dict
-

records the state of the system using session

-
- -
-
-refresh_references(sesh=None)
-

refresh the system references

-
- -
-
-reset_contexts(fail_if_discardmode=True)
-

reset all contexts to a new storage format

-
- -
-
-reset_data()
-

reset the data storage

-
- -
-
-save_data(index=None, force=False, **add_data)
-

save data to the context

-
- -
-
-property sesh
-

caches the property for the session

-
- -
-
-set_checkpoint()
-

sets the checkpoint

-
- -
-
-set_ref_values(values, refs=None)
-

returns the values of the refs

-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-solve_min(Xref=None, Yref=None, output=None, **kw)
-

Solve the minimization problem using the given vars and constraints. And sets the system state to the solution depending on input of the following:

-

Solve the root problem using the given vars. -:type Xref: -:param Xref: The reference input values. -:type Yref: -:param Yref: The reference objective values to minimize. -:type output: -:param output: The output dictionary to store the results. (default: None) -:param fail: Flag indicating whether to raise an exception if the solver doesn’t converge. (default: True) -:type kw: -:param kw: Additional keyword arguments. -:return: The output dictionary containing the results.

-
- -
-
-property solveable
-

checks the system’s references to determine if its solveabl

-
- -
-
-sys_solver_constraints(add_con=None, combo_filter=True, **kw)
-

formatted as arguments for the solver

-
- -
-
-sys_solver_objectives(**kw)
-

gathers variables from solver vars, and attempts to locate any input_vars to add as well. use exclude_vars to eliminate a variable from the solver

-
- -
-
-update_system(*args, **kwargs)
-

updates the system

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.problem_context.ProblemExec.html b/docs/_build/html/_autosummary/engforge.problem_context.ProblemExec.html deleted file mode 100644 index 11d171d..0000000 --- a/docs/_build/html/_autosummary/engforge.problem_context.ProblemExec.html +++ /dev/null @@ -1,842 +0,0 @@ - - - - - - - engforge.problem_context.ProblemExec — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.problem_context.ProblemExec

-
-
-class ProblemExec(system, kw_dict=None, Xnew=None, ctx_fail_new=False, **opts)[source]
-

Bases: object

-

Represents the execution context for a problem in the system. The ProblemExec class provides a uniform set of options for managing the state of the system and its solvables, establishing the selection of combos or de/active attributes to Solvables. Once once created any further entracnces to ProblemExec will return the same instance until finally the last exit is called.

-

## params: -- _problem_id: uuid for subproblems, or True for top level, None means uninitialized

-

Initializes the ProblemExec.

-

#TODO: exit system should abide by update / signals options

-

#TODO: provide data storage options for dataframe / table storage history/ record keeping (ss vs transient data)

-

#TODO: create an option to copy the system and run operations on it, and options for applying the state from the optimized copy to the original system

-
-
Parameters:
-
    -

  • system – The system to be executed.

    • -

  • Xnew – The new state of the system to set wrt. reversion, optional

    • -

  • ctx_fail_new – Whether to raise an error if no execution context is available, use in utility methods ect. Default is False.

    • -

  • kw_dict – A keyword argument dictionary to be parsed for solver options, and removed from the outer context. Changes are made to this dictionary, so they are removed automatically from the outer context, and thus no longer passed to interior vars.

    • -

  • dxdt – The dynamics integration method. Default is None meaning that dynamic vars are not considered for minimization unless otherwise specified. Steady State can be specified by dxdt=0 all dynamic vars are considered as solver variables, with the constraint that their rate of change is zero. If a dictionary is passed then the dynamic vars are considered as solver variables, with the constraint that their rate of change is equal to the value in the dictionary, and all other unspecified rates are zero (steady).

    • -
-
-
-

#### Solver Selection Options -:param combos: The selection of combos. Default is ‘*’ (select all). -:param ign_combos: The combos to be ignored. -:param only_combos: The combos to be selected. -:param add_obj: Whether to add an objective to the solver. Default is True. -:param slv_vars: The selection of solvables. Default is ‘*’ (select all). -:param add_vars: The solvables to be added to the solver. -:param ign_vars: The solvables to be ignored. -:param only_vars: The solvables to be selected. -:param only_active: Whether to select only active items. Default is True. -:param activate: The solvables to be activated. -:param deactivate: The solvables to be deactivated. -:param fail_revert: Whether to raise an error if no solvables are selected. Default is True. -:param revert_last: Whether to revert the last change. Default is True. -:param revert_every: Whether to revert every change. Default is True. -:param exit_on_failure: Whether to exit on failure, or continue on. Default is True.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

activate_temp_state

apply_post_signals

applies all post signals

apply_pre_signals

applies all pre signals

clean_context

critical

debug

debug_levels

debug the levels of the context

discard_contexts

discard all contexts

error

error_action

handles the error action wrt to the problem

establish_system

caches the system references, and parses the system arguments

exit_action

handles the exit action wrt system

exit_and_revert

exit_to_level

exit_with_state

filter_vars

selects only settable refs

get_extra_kws

extracts the combo input from the kwargs

get_parent_key

returns the parent key of the key

get_ref_values

returns the values of the refs

get_sesh

get the session

handle_solution

info

integral_rate

provides the dynamic rate of the system at time t, and state x

integrate

min_refresh

msg

parse_default

splits strings or lists and returns a list of options for the key, if nothing found returns None if fail set to True raises an exception, otherwise returns the default value

persist_contexts

convert all contexts to a new storage format

pos_obj

converts an objective to a positive value

post_execute

Updates the post/both signals after the solver has been executed.

post_update_system

updates the system

pre_execute

Updates the pre/both signals after the solver has been executed.

refresh_references

refresh the system references

reset_contexts

reset all contexts to a new storage format

reset_data

reset the data storage

revert_to_start

save_data

save data to the context

set_checkpoint

sets the checkpoint

set_ref_values

returns the values of the refs

set_time

solve_min

Solve the minimization problem using the given vars and constraints.

sys_solver_constraints

formatted as arguments for the solver

sys_solver_objectives

gathers variables from solver vars, and attempts to locate any input_vars to add as well.

update_dynamics

update_methods

update_system

updates the system

warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

all_components

returns all variables in the system

all_comps

returns all variables in the system

all_comps_and_vars

all_problem_vars

solver variables + dynamics states when dynamic_solve is True

all_system_references

all_variable_refs

all_variables

returns all variables in the system

attr_inst

check_dynamics

copy_system

dataframe

returns the dataframe of the system

dynamic_comps

dynamic_rate

dynamic_rate_eq

dynamic_solve

indicates if the system is dynamic

dynamic_state

enter_refresh

entered

exit_on_failure

exited

fail_revert

final_objectives

returns the final objective of the system

identity

integrator_rate_refs

combine the dynamic state and the integrator rates to get the transient state of the system, but convert their keys to the target var names

integrator_rates

integrator_var_refs

combine the dynamic state and the integrator rates to get the transient state of the system, but convert their keys to the target var names

integrator_vars

integrators

is_active

checks if the context has been entered and not exited

kwargs

copy of slv_kw args

level_name

level_number

log_level

opt_fail

output_state

records the state of the system

post_callback

post_exec

pre_exec

problem_eq

problem_id

problem_ineq

problem_input

problem_objs

problem_opt_vars

solver variables

problems_dict

raise_on_unknown

record_state

records the state of the system using session

ref_attrs

revert_every

revert_last

run_solver

save_mode

save_on_exit

sesh

caches the property for the session

session_id

signal_inst

signals

signals_source

signals_target

solveable

checks the system's references to determine if its solveabl

solver_inst

success_thresh

system

session

x_start

-
-
-property all_components: dict
-

returns all variables in the system

-
- -
-
-property all_comps: dict
-

returns all variables in the system

-
- -
-
-property all_problem_vars: dict
-

solver variables + dynamics states when dynamic_solve is True

-
- -
-
-property all_variables: dict
-

returns all variables in the system

-
- -
-
-apply_post_signals()[source]
-

applies all post signals

-
- -
-
-apply_pre_signals()[source]
-

applies all pre signals

-
- -
-
-class_cache
-

alias of ProblemExec

-
- -
-
-property dataframe: DataFrame
-

returns the dataframe of the system

-
- -
-
-debug_levels()[source]
-

debug the levels of the context

-
- -
-
-discard_contexts()[source]
-

discard all contexts

-
- -
-
-property dynamic_solve: bool
-

indicates if the system is dynamic

-
- -
-
-error_action(error)[source]
-

handles the error action wrt to the problem

-
- -
-
-establish_system(system, kw_dict, **kwargs)[source]
-

caches the system references, and parses the system arguments

-
- -
-
-exit_action()[source]
-

handles the exit action wrt system

-
- -
-
-filter_vars(refs)[source]
-

selects only settable refs

-
-
Parameters:
-

refs (list)

-
-
-
- -
-
-property final_objectives: dict
-

returns the final objective of the system

-
- -
-
-classmethod get_extra_kws(kwargs, _check_keys={'activate': None, 'add_obj': True, 'add_vars': None, 'both_match': True, 'combos': 'default', 'deactivate': None, 'dxdt': None, 'ign_combos': None, 'ign_vars': None, 'obj': None, 'only_active': True, 'only_combos': None, 'only_vars': None, 'slv_vars': '*', 'weights': None}, rmv=False, use_defaults=True)[source]
-

extracts the combo input from the kwargs

-
-
Parameters:
-

_check_keys (dict)

-
-
-
- -
-
-get_parent_key(key, look_back_num=1)[source]
-

returns the parent key of the key

-
- -
-
-get_ref_values(refs=None)[source]
-

returns the values of the refs

-
- -
-
-get_sesh(sesh=None)[source]
-

get the session

-
- -
-
-integral_rate(t, x, dt, Xss=None, Yobj=None, **kw)[source]
-

provides the dynamic rate of the system at time t, and state x

-
- -
-
-property integrator_rate_refs
-

combine the dynamic state and the integrator rates to get the transient state of the system, but convert their keys to the target var names

-
- -
-
-property integrator_var_refs
-

combine the dynamic state and the integrator rates to get the transient state of the system, but convert their keys to the target var names

-
- -
-
-property is_active
-

checks if the context has been entered and not exited

-
- -
-
-property kwargs
-

copy of slv_kw args

-
- -
-
-property output_state: dict
-

records the state of the system

-
- -
-
-classmethod parse_default(key, defaults, input_dict, rmv=False, empty_str=True)[source]
-

splits strings or lists and returns a list of options for the key, if nothing found returns None if fail set to True raises an exception, otherwise returns the default value

-
- -
-
-persist_contexts()[source]
-

convert all contexts to a new storage format

-
- -
-
-pos_obj(ref)[source]
-

converts an objective to a positive value

-
- -
-
-post_execute(*args, **kwargs)[source]
-

Updates the post/both signals after the solver has been executed. This is useful for updating the system state after the solver has been executed.

-
- -
-
-post_update_system(*args, **kwargs)[source]
-

updates the system

-
- -
-
-pre_execute(*args, **kwargs)[source]
-

Updates the pre/both signals after the solver has been executed. This is useful for updating the system state after the solver has been executed.

-
- -
-
-property problem_opt_vars: dict
-

solver variables

-
- -
-
-property record_state: dict
-

records the state of the system using session

-
- -
-
-refresh_references(sesh=None)[source]
-

refresh the system references

-
- -
-
-reset_contexts(fail_if_discardmode=True)[source]
-

reset all contexts to a new storage format

-
- -
-
-reset_data()[source]
-

reset the data storage

-
- -
-
-save_data(index=None, force=False, **add_data)[source]
-

save data to the context

-
- -
-
-property sesh
-

caches the property for the session

-
- -
-
-set_checkpoint()[source]
-

sets the checkpoint

-
- -
-
-set_ref_values(values, refs=None)[source]
-

returns the values of the refs

-
- -
-
-solve_min(Xref=None, Yref=None, output=None, **kw)[source]
-

Solve the minimization problem using the given vars and constraints. And sets the system state to the solution depending on input of the following:

-

Solve the root problem using the given vars. -:type Xref: -:param Xref: The reference input values. -:type Yref: -:param Yref: The reference objective values to minimize. -:type output: -:param output: The output dictionary to store the results. (default: None) -:param fail: Flag indicating whether to raise an exception if the solver doesn’t converge. (default: True) -:type kw: -:param kw: Additional keyword arguments. -:return: The output dictionary containing the results.

-
- -
-
-property solveable
-

checks the system’s references to determine if its solveabl

-
- -
-
-sys_solver_constraints(add_con=None, combo_filter=True, **kw)[source]
-

formatted as arguments for the solver

-
- -
-
-sys_solver_objectives(**kw)[source]
-

gathers variables from solver vars, and attempts to locate any input_vars to add as well. use exclude_vars to eliminate a variable from the solver

-
- -
-
-update_system(*args, **kwargs)[source]
-

updates the system

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.problem_context.ProblemExit.html b/docs/_build/html/_autosummary/engforge.problem_context.ProblemExit.html deleted file mode 100644 index 63d71af..0000000 --- a/docs/_build/html/_autosummary/engforge.problem_context.ProblemExit.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - - engforge.problem_context.ProblemExit — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.problem_context.ProblemExit

-
-
-exception ProblemExit(prob, revert=None)[source]
-

an exception to exit the problem context, without error

-
-
Parameters:
-
-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.problem_context.ProblemExitAtLevel.html b/docs/_build/html/_autosummary/engforge.problem_context.ProblemExitAtLevel.html deleted file mode 100644 index 3080d7b..0000000 --- a/docs/_build/html/_autosummary/engforge.problem_context.ProblemExitAtLevel.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - - engforge.problem_context.ProblemExitAtLevel — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.problem_context.ProblemExitAtLevel

-
-
-exception ProblemExitAtLevel(prob, level, revert=None)[source]
-

an exception to exit the problem context, without error

-
-
Parameters:
-
-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.problem_context.html b/docs/_build/html/_autosummary/engforge.problem_context.html deleted file mode 100644 index c7b45a5..0000000 --- a/docs/_build/html/_autosummary/engforge.problem_context.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - - engforge.problem_context — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.problem_context
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.problem_context

-

The ProblemExec provides a uniform set of options for managing the state of the system and its solvables, establishing the selection of combos or de/active attributes to Solvables. Once once created any further entracnces to ProblemExec will return the same instance until finally the last exit is called.

-

The ProblemExec class allows entrance to a its context to the same instance until finally the last exit is called. The first entrance to the context will create the instance, each subsequent entrance will return the same instance. The ProblemExec arguments are set the first time and remove keyword arguments from the input dictionary (passed as a dict ie stateful) to subsequent methods. -This isn’t technically a singleton pattern, but it does provide a similar interface. Instead mutliple problem instances will be clones of the first instance, with the optional difference of input/output/event criteria. The first instance will be returned by each context entry, so for that reason it may always appear to have same instance, however each instance is unique in a recusive setting so it may record its own state and be reverted to its own state as per the options defined.

-

#TODO: allow update of kwargs on re-entrance

-

## Example: -.. code-block:: python

-
-

#Application code (arguments passed in kw) -with ProblemExec(sys,combos=’default’,slv_vars’*’,**kw) as pe:

-
-

pe._sys_refs #get the references and compiled problem -for i in range(10):

-
-

pe.solve_min(pe.Xref,pe.Yref,**other_args) -pe.set_checkpoint() #save the state of the system -self.save_data()

-
-
-

#Solver Module (can use without knowledge of the runtime system) -with ProblemExec(sys,{},Xnew=Xnext,ctx_fail_new=True) as pe:

-
-

#do revertable math on the state of the system without concern for the state of the system

-
-
-

…

-

# Combos Selection -By default no arguments run will select all active items with combo=”default”. The combos argument can be used to select a specific set of combos, a outer select. From this set, the ign_combos and only_combos arguments can be used to ignore or select specific combos based on exclusion or inclusion respectively.

-

# Parameter Name Selection -The slv_vars argument can be used to select a specific set of solvables. From this set, the ign_vars and only_vars arguments can be used to ignore or select specific solvables based on exclusion or inclusion respectively. The add_vars argument can be used to add a specific set of solvables to the solver.

-

# Active Mode Handiling -The only_active argument can be used to select only active items. The activate and deactivate arguments can be used to activate or deactivate specific solvables.

-

add_obj can be used to add an objective to the solver.

-

# Exit Mode Handling

-

The ProblemExec supports the following exit mode handling vars:

-
    -

  • fail_revert: Whether to raise an error if no solvables are selected. Default is True.

    • -

  • revert_last: Whether to revert the last change. Default is True.

    • -

  • revert_every: Whether to revert every change. Default is True.

    • -

  • exit_on_failure: Whether to exit on first failure. Default is True.

    • -
-

These vars control the behavior of the ProblemExec when an error occurs or when no solvables are selected.

-

Classes

- - - - - - - - - - - - -

ProbLog

Initialize a filter.

Problem

Initializes the ProblemExec.

ProblemExec

Represents the execution context for a problem in the system.

-

Exceptions

- - - - - - - - - - - - -

IllegalArgument

an exception to exit the problem context as specified

ProblemExit(prob[, revert])

an exception to exit the problem context, without error

ProblemExitAtLevel(prob, level[, revert])

an exception to exit the problem context, without error

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.properties.PropertyLog.html b/docs/_build/html/_autosummary/engforge.properties.PropertyLog.html deleted file mode 100644 index 7e4073c..0000000 --- a/docs/_build/html/_autosummary/engforge.properties.PropertyLog.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - engforge.properties.PropertyLog — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.properties.PropertyLog

-
-
-class PropertyLog(name='')[source]
-

Bases: LoggingMixin

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.properties.cache_prop.html b/docs/_build/html/_autosummary/engforge.properties.cache_prop.html deleted file mode 100644 index bfb29fb..0000000 --- a/docs/_build/html/_autosummary/engforge.properties.cache_prop.html +++ /dev/null @@ -1,214 +0,0 @@ - - - - - - - engforge.properties.cache_prop — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.properties.cache_prop

-
-
-class cache_prop(*args, **kwargs)[source]
-

Bases: engforge_prop

-

Methods

- - - - - - - - - - - - - - - - - - -

deleter

get_func_return

ensures that the function has a return annotation, and that return annotation is in valid sort types

getter

set_cache

setter

-

Attributes

- - - - - - - - - -

allow_set

must_return

-
-
-__call__(fget=None, fset=None, fdel=None, doc=None, *args, **kwargs)
-

this will be called when input is provided before property is set

-
- -
-
-get_func_return(func)
-

ensures that the function has a return annotation, and that return annotation is in valid sort types

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.properties.cached_sys_prop.html b/docs/_build/html/_autosummary/engforge.properties.cached_sys_prop.html deleted file mode 100644 index abc16a4..0000000 --- a/docs/_build/html/_autosummary/engforge.properties.cached_sys_prop.html +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - - engforge.properties.cached_sys_prop — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.properties.cached_sys_prop

-
-
-cached_sys_prop
-

alias of system_property

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.properties.cached_system_prop.html b/docs/_build/html/_autosummary/engforge.properties.cached_system_prop.html deleted file mode 100644 index e386109..0000000 --- a/docs/_build/html/_autosummary/engforge.properties.cached_system_prop.html +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - - engforge.properties.cached_system_prop — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.properties.cached_system_prop

-
-
-cached_system_prop
-

alias of system_property

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.properties.cached_system_property.html b/docs/_build/html/_autosummary/engforge.properties.cached_system_property.html deleted file mode 100644 index d3f44d5..0000000 --- a/docs/_build/html/_autosummary/engforge.properties.cached_system_property.html +++ /dev/null @@ -1,235 +0,0 @@ - - - - - - - engforge.properties.cached_system_property — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.properties.cached_system_property

-
-
-class cached_system_property(fget=None, fset=None, fdel=None, doc=None, desc=None, label=None, stochastic=False)[source]
-

Bases: system_property

-

A system property that caches the result when nothing changes. Use for expensive functions since the checking adds some overhead

-

You can initalize just the functions, or precreate the object but with meta -@system_property -def function(…): < this uses __init__ to assign function

-

@system_property(desc=’really nice’,label=’funky function’) -def function(…): < this uses __call__ to assign function

-

Methods

- - - - - - - - - - - - - - - - - - -

deleter

get_func_return

ensures that the function has a return annotation, and that return annotation is in valid sort types

getter

set_cache

setter

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - -

desc

label

must_return

private_var

return_type

stochastic

gname

-
-
-__call__(fget=None, fset=None, fdel=None, doc=None)
-

this will be called when input is provided before property is set

-
- -
-
-get_func_return(func)[source]
-

ensures that the function has a return annotation, and that return annotation is in valid sort types

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.properties.class_cache.html b/docs/_build/html/_autosummary/engforge.properties.class_cache.html deleted file mode 100644 index 56a3a65..0000000 --- a/docs/_build/html/_autosummary/engforge.properties.class_cache.html +++ /dev/null @@ -1,221 +0,0 @@ - - - - - - - engforge.properties.class_cache — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.properties.class_cache

-
-
-class class_cache(*args, **kwargs)[source]
-

Bases: cache_prop

-

a property that caches a value on the class at runtime, and then maintains that value for the duration of the program. A flag with the class name ensures the class is correct. Intended for instance methods

-

Methods

- - - - - - - - - - - - - - - - - - -

deleter

get_func_return

ensures that the function has a return annotation, and that return annotation is in valid sort types

getter

set_cache

setter

-

Attributes

- - - - - - - - - - - - - - - -

allow_set

id_var

must_return

private_var

-
-
-__call__(fget=None, fset=None, fdel=None, doc=None, *args, **kwargs)
-

this will be called when input is provided before property is set

-
- -
-
-get_func_return(func)
-

ensures that the function has a return annotation, and that return annotation is in valid sort types

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.properties.engforge_prop.html b/docs/_build/html/_autosummary/engforge.properties.engforge_prop.html deleted file mode 100644 index e895b1f..0000000 --- a/docs/_build/html/_autosummary/engforge.properties.engforge_prop.html +++ /dev/null @@ -1,209 +0,0 @@ - - - - - - - engforge.properties.engforge_prop — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.properties.engforge_prop

-
-
-class engforge_prop(fget=None, fset=None, fdel=None, *args, **kwargs)[source]
-

Bases: object

-

an interface for extension and identification and class return support

-

Methods

- - - - - - - - - - - - - - - -

deleter

get_func_return

ensures that the function has a return annotation, and that return annotation is in valid sort types

getter

setter

-

Attributes

- - - - - - -

must_return

-
-
-__call__(fget=None, fset=None, fdel=None, doc=None, *args, **kwargs)[source]
-

this will be called when input is provided before property is set

-
- -
-
-get_func_return(func)[source]
-

ensures that the function has a return annotation, and that return annotation is in valid sort types

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.properties.html b/docs/_build/html/_autosummary/engforge.properties.html deleted file mode 100644 index 54dc269..0000000 --- a/docs/_build/html/_autosummary/engforge.properties.html +++ /dev/null @@ -1,206 +0,0 @@ - - - - - - - engforge.properties — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.properties
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.properties

-

Like typical python properties, normal functions are embelished with additional functionality.

-

system_properties is a core function that adds meta information to a normal python property to include its output in the results. It is the “y” in y=f(x).

-

class_cache a subclassing safe property that stores the result at runtime

-

solver_cache a property that is recalculated any time there is an update to any attrs variable.

-

Classes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

PropertyLog

Initialize a filter.

cache_prop

cached_sys_prop

alias of system_property

cached_system_prop

alias of system_property

cached_system_property

A system property that caches the result when nothing changes.

class_cache

a property that caches a value on the class at runtime, and then maintains that value for the duration of the program.

engforge_prop

an interface for extension and identification and class return support

instance_cached

A property that caches a result to an instance the first call then returns that each successive call

solver_cached

A property that updates a first time and then anytime time the input data changed, as signaled by attrs.on_setattr callback

sys_prop

alias of system_property

system_prop

alias of system_property

system_property

this property notifies the system this is a property to be tabulated in the dataframe output.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.properties.instance_cached.html b/docs/_build/html/_autosummary/engforge.properties.instance_cached.html deleted file mode 100644 index 465445f..0000000 --- a/docs/_build/html/_autosummary/engforge.properties.instance_cached.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - - - engforge.properties.instance_cached — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.properties.instance_cached

-
-
-class instance_cached(*args, **kwargs)[source]
-

Bases: cache_prop

-

A property that caches a result to an instance the first call then returns that each successive call

-

Methods

- - - - - - - - - - - - - - - - - - -

deleter

get_func_return

ensures that the function has a return annotation, and that return annotation is in valid sort types

getter

set_cache

setter

-

Attributes

- - - - - - - - - - - - -

allow_set

must_return

private_var

-
-
-__call__(fget=None, fset=None, fdel=None, doc=None, *args, **kwargs)
-

this will be called when input is provided before property is set

-
- -
-
-get_func_return(func)
-

ensures that the function has a return annotation, and that return annotation is in valid sort types

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.properties.solver_cached.html b/docs/_build/html/_autosummary/engforge.properties.solver_cached.html deleted file mode 100644 index 5dd1396..0000000 --- a/docs/_build/html/_autosummary/engforge.properties.solver_cached.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - - - engforge.properties.solver_cached — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.properties.solver_cached

-
-
-class solver_cached(*args, **kwargs)[source]
-

Bases: cache_prop

-

A property that updates a first time and then anytime time the input data changed, as signaled by attrs.on_setattr callback

-

Methods

- - - - - - - - - - - - - - - - - - -

deleter

get_func_return

ensures that the function has a return annotation, and that return annotation is in valid sort types

getter

set_cache

setter

-

Attributes

- - - - - - - - - - - - -

allow_set

must_return

private_var

-
-
-__call__(fget=None, fset=None, fdel=None, doc=None, *args, **kwargs)
-

this will be called when input is provided before property is set

-
- -
-
-get_func_return(func)
-

ensures that the function has a return annotation, and that return annotation is in valid sort types

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.properties.sys_prop.html b/docs/_build/html/_autosummary/engforge.properties.sys_prop.html deleted file mode 100644 index f076627..0000000 --- a/docs/_build/html/_autosummary/engforge.properties.sys_prop.html +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - - engforge.properties.sys_prop — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.properties.sys_prop

-
-
-sys_prop
-

alias of system_property

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.properties.system_prop.html b/docs/_build/html/_autosummary/engforge.properties.system_prop.html deleted file mode 100644 index 5dc0b28..0000000 --- a/docs/_build/html/_autosummary/engforge.properties.system_prop.html +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - - engforge.properties.system_prop — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.properties.system_prop

-
-
-system_prop
-

alias of system_property

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.properties.system_property.html b/docs/_build/html/_autosummary/engforge.properties.system_property.html deleted file mode 100644 index b5c42a2..0000000 --- a/docs/_build/html/_autosummary/engforge.properties.system_property.html +++ /dev/null @@ -1,232 +0,0 @@ - - - - - - - engforge.properties.system_property — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.properties.system_property

-
-
-class system_property(fget=None, fset=None, fdel=None, doc=None, desc=None, label=None, stochastic=False)[source]
-

Bases: engforge_prop

-

this property notifies the system this is a property to be tabulated in the dataframe output.

-

@system_property -def function(…): < this uses __init__ to assign function

-

@system_property(desc=’really nice’,label=’funky function’) -def function(…): < this uses __call__ to assign function

-

When the underlying data has some random element, set stochastic=True and this will flag the component to always save data.

-

Functions wrapped with table type must have an return annotion of (int,float,str)… ex def func() -> int:

-

You can initalize just the functions, or precreate the object but with meta -@system_property -def function(…): < this uses __init__ to assign function

-

@system_property(desc=’really nice’,label=’funky function’) -def function(…): < this uses __call__ to assign function

-

Methods

- - - - - - - - - - - - - - - -

deleter

get_func_return

ensures that the function has a return annotation, and that return annotation is in valid sort types

getter

setter

-

Attributes

- - - - - - - - - - - - - - - - - - -

desc

label

must_return

return_type

stochastic

-
-
-__call__(fget=None, fset=None, fdel=None, doc=None)[source]
-

this will be called when input is provided before property is set

-
- -
-
-get_func_return(func)[source]
-

ensures that the function has a return annotation, and that return annotation is in valid sort types

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.reporting.CSVReporter.html b/docs/_build/html/_autosummary/engforge.reporting.CSVReporter.html deleted file mode 100644 index 8115d64..0000000 --- a/docs/_build/html/_autosummary/engforge.reporting.CSVReporter.html +++ /dev/null @@ -1,388 +0,0 @@ - - - - - - - engforge.reporting.CSVReporter — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.reporting.CSVReporter

-
-
-class CSVReporter(path=None, report_mode='single', name='CSV')[source]
-

Bases: TableReporter, DiskReporterMixin

-

Method generated by attrs for class CSVReporter.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_config

a test to see if the reporter should be used

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

ensure_exists

ensure_path

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

subclasses

get all reporters of this type

upload

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

date_key

identity

log_fmt

log_level

log_on

logger

month_key

name

path

report_mode

report_root

define your keys!

slack_webhook_url

-
-
Parameters:
-
    -

  • path (str)

    • -

  • report_mode (str)

    • -

  • name (str)

    • -
-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-check_config()
-

a test to see if the reporter should be used

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-property report_root
-

define your keys!

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-classmethod subclasses(out=None)
-

get all reporters of this type

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.reporting.DiskPlotReporter.html b/docs/_build/html/_autosummary/engforge.reporting.DiskPlotReporter.html deleted file mode 100644 index bfbe26c..0000000 --- a/docs/_build/html/_autosummary/engforge.reporting.DiskPlotReporter.html +++ /dev/null @@ -1,391 +0,0 @@ - - - - - - - engforge.reporting.DiskPlotReporter — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.reporting.DiskPlotReporter

-
-
-class DiskPlotReporter(path=None, report_mode='single', name='DrivePlots')[source]
-

Bases: PlotReporter, DiskReporterMixin

-

Method generated by attrs for class DiskPlotReporter.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_config

a test to see if the reporter should be used

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

ensure_exists

ensure_path

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

subclasses

get all reporters of this type

upload

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

date_key

ext

identity

log_fmt

log_level

log_on

logger

month_key

name

path

report_mode

report_root

define your keys!

slack_webhook_url

-
-
Parameters:
-
    -

  • path (str)

    • -

  • report_mode (str)

    • -

  • name (str)

    • -
-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-check_config()
-

a test to see if the reporter should be used

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-property report_root
-

define your keys!

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-classmethod subclasses(out=None)
-

get all reporters of this type

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.reporting.DiskReporterMixin.html b/docs/_build/html/_autosummary/engforge.reporting.DiskReporterMixin.html deleted file mode 100644 index f69d00f..0000000 --- a/docs/_build/html/_autosummary/engforge.reporting.DiskReporterMixin.html +++ /dev/null @@ -1,388 +0,0 @@ - - - - - - - engforge.reporting.DiskReporterMixin — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.reporting.DiskReporterMixin

-
-
-class DiskReporterMixin(name='reporter', path=None, report_mode='single')[source]
-

Bases: TemporalReporterMixin

-

Method generated by attrs for class DiskReporterMixin.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_config

a test to see if the reporter should be used

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

ensure_exists

ensure_path

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

subclasses

get all reporters of this type

upload

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

path

report_mode

date_key

identity

log_fmt

log_level

log_on

logger

month_key

name

report_root

define your keys!

slack_webhook_url

-
-
Parameters:
-
    -

  • name (str)

    • -

  • path (str)

    • -

  • report_mode (str)

    • -
-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-check_config()
-

a test to see if the reporter should be used

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-property report_root
-

define your keys!

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-classmethod subclasses(out=None)
-

get all reporters of this type

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.reporting.ExcelReporter.html b/docs/_build/html/_autosummary/engforge.reporting.ExcelReporter.html deleted file mode 100644 index 4b3bc64..0000000 --- a/docs/_build/html/_autosummary/engforge.reporting.ExcelReporter.html +++ /dev/null @@ -1,388 +0,0 @@ - - - - - - - engforge.reporting.ExcelReporter — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.reporting.ExcelReporter

-
-
-class ExcelReporter(path=None, report_mode='single', name='EXCEL')[source]
-

Bases: TableReporter, DiskReporterMixin

-

Method generated by attrs for class ExcelReporter.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_config

a test to see if the reporter should be used

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

ensure_exists

ensure_path

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

subclasses

get all reporters of this type

upload

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

date_key

identity

log_fmt

log_level

log_on

logger

month_key

name

path

report_mode

report_root

define your keys!

slack_webhook_url

-
-
Parameters:
-
    -

  • path (str)

    • -

  • report_mode (str)

    • -

  • name (str)

    • -
-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-check_config()
-

a test to see if the reporter should be used

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-property report_root
-

define your keys!

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-classmethod subclasses(out=None)
-

get all reporters of this type

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.reporting.GdriveReporter.html b/docs/_build/html/_autosummary/engforge.reporting.GdriveReporter.html deleted file mode 100644 index edee287..0000000 --- a/docs/_build/html/_autosummary/engforge.reporting.GdriveReporter.html +++ /dev/null @@ -1,381 +0,0 @@ - - - - - - - engforge.reporting.GdriveReporter — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.reporting.GdriveReporter

-
-
-class GdriveReporter(name='Gdrive', share_drive=None)[source]
-

Bases: PlotReporter, TemporalReporterMixin

-

Method generated by attrs for class GdriveReporter.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_config

a test to see if the reporter should be used

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

subclasses

get all reporters of this type

upload

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

share_drive

date_key

ext

identity

log_fmt

log_level

log_on

logger

month_key

name

report_root

define your keys!

slack_webhook_url

-
-
Parameters:
-
    -

  • name (str)

    • -

  • share_drive (str)

    • -
-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-check_config()
-

a test to see if the reporter should be used

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-property report_root
-

define your keys!

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-classmethod subclasses(out=None)
-

get all reporters of this type

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.reporting.GsheetsReporter.html b/docs/_build/html/_autosummary/engforge.reporting.GsheetsReporter.html deleted file mode 100644 index c7f5e6e..0000000 --- a/docs/_build/html/_autosummary/engforge.reporting.GsheetsReporter.html +++ /dev/null @@ -1,372 +0,0 @@ - - - - - - - engforge.reporting.GsheetsReporter — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.reporting.GsheetsReporter

-
-
-class GsheetsReporter(name='GSHEETS')[source]
-

Bases: TableReporter, TemporalReporterMixin

-

Method generated by attrs for class GsheetsReporter.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_config

a test to see if the reporter should be used

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

subclasses

get all reporters of this type

upload

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

date_key

identity

log_fmt

log_level

log_on

logger

month_key

name

report_root

define your keys!

slack_webhook_url

-
-
Parameters:
-

name (str)

-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-check_config()
-

a test to see if the reporter should be used

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-property report_root
-

define your keys!

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-classmethod subclasses(out=None)
-

get all reporters of this type

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.reporting.PlotReporter.html b/docs/_build/html/_autosummary/engforge.reporting.PlotReporter.html deleted file mode 100644 index bfe787d..0000000 --- a/docs/_build/html/_autosummary/engforge.reporting.PlotReporter.html +++ /dev/null @@ -1,361 +0,0 @@ - - - - - - - engforge.reporting.PlotReporter — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.reporting.PlotReporter

-
-
-class PlotReporter(name='plot_reporter')[source]
-

Bases: Reporter

-

A reporter to upload plots to a file store

-

Method generated by attrs for class PlotReporter.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_config

a test to see if the reporter should be used

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

subclasses

get all reporters of this type

upload

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - -

ext

identity

log_fmt

log_level

log_on

logger

name

slack_webhook_url

-
-
Parameters:
-

name (str)

-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-check_config()
-

a test to see if the reporter should be used

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-classmethod subclasses(out=None)
-

get all reporters of this type

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.reporting.Reporter.html b/docs/_build/html/_autosummary/engforge.reporting.Reporter.html deleted file mode 100644 index 006efc0..0000000 --- a/docs/_build/html/_autosummary/engforge.reporting.Reporter.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - - - engforge.reporting.Reporter — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.reporting.Reporter

-
-
-class Reporter(name='reporter')[source]
-

Bases: LoggingMixin

-

A mixin intended

-

Method generated by attrs for class Reporter.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_config

a test to see if the reporter should be used

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

subclasses

get all reporters of this type

upload

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - -

name

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
Parameters:
-

name (str)

-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-check_config()[source]
-

a test to see if the reporter should be used

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-classmethod subclasses(out=None)[source]
-

get all reporters of this type

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.reporting.TableReporter.html b/docs/_build/html/_autosummary/engforge.reporting.TableReporter.html deleted file mode 100644 index 4f7a763..0000000 --- a/docs/_build/html/_autosummary/engforge.reporting.TableReporter.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - - - engforge.reporting.TableReporter — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.reporting.TableReporter

-
-
-class TableReporter(name='table_reporter')[source]
-

Bases: Reporter

-

A reporter to upload dataframes to a table store

-

Method generated by attrs for class TableReporter.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_config

a test to see if the reporter should be used

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

subclasses

get all reporters of this type

upload

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

name

slack_webhook_url

-
-
Parameters:
-

name (str)

-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-check_config()
-

a test to see if the reporter should be used

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-classmethod subclasses(out=None)
-

get all reporters of this type

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.reporting.TemporalReporterMixin.html b/docs/_build/html/_autosummary/engforge.reporting.TemporalReporterMixin.html deleted file mode 100644 index f25c0a0..0000000 --- a/docs/_build/html/_autosummary/engforge.reporting.TemporalReporterMixin.html +++ /dev/null @@ -1,373 +0,0 @@ - - - - - - - engforge.reporting.TemporalReporterMixin — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.reporting.TemporalReporterMixin

-
-
-class TemporalReporterMixin(name='reporter')[source]
-

Bases: Reporter

-

Provide single or periodic keys

-

Method generated by attrs for class TemporalReporterMixin.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_config

a test to see if the reporter should be used

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

subclasses

get all reporters of this type

upload

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

date_key

identity

log_fmt

log_level

log_on

logger

month_key

name

report_root

define your keys!

slack_webhook_url

-
-
Parameters:
-

name (str)

-
-
-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-check_config()
-

a test to see if the reporter should be used

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-property report_root
-

define your keys!

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-classmethod subclasses(out=None)
-

get all reporters of this type

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.reporting.html b/docs/_build/html/_autosummary/engforge.reporting.html deleted file mode 100644 index 787f9e9..0000000 --- a/docs/_build/html/_autosummary/engforge.reporting.html +++ /dev/null @@ -1,204 +0,0 @@ - - - - - - - engforge.reporting — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.reporting
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.reporting

-

The set of reporters define an interface to report plots or tables

-

Functions

- - - - - - -

path_exist_validator

-

Classes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

CSVReporter

Method generated by attrs for class CSVReporter.

DiskPlotReporter

Method generated by attrs for class DiskPlotReporter.

DiskReporterMixin

Method generated by attrs for class DiskReporterMixin.

ExcelReporter

Method generated by attrs for class ExcelReporter.

GdriveReporter

Method generated by attrs for class GdriveReporter.

GsheetsReporter

Method generated by attrs for class GsheetsReporter.

PlotReporter

A reporter to upload plots to a file store

Reporter

A mixin intended

TableReporter

A reporter to upload dataframes to a table store

TemporalReporterMixin

Provide single or periodic keys

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.reporting.path_exist_validator.html b/docs/_build/html/_autosummary/engforge.reporting.path_exist_validator.html deleted file mode 100644 index d27e76e..0000000 --- a/docs/_build/html/_autosummary/engforge.reporting.path_exist_validator.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - - engforge.reporting.path_exist_validator — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.reporting.path_exist_validator

-
-
-path_exist_validator(inst, attr, value)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solveable.SolvableLog.html b/docs/_build/html/_autosummary/engforge.solveable.SolvableLog.html deleted file mode 100644 index 2e37ef8..0000000 --- a/docs/_build/html/_autosummary/engforge.solveable.SolvableLog.html +++ /dev/null @@ -1,322 +0,0 @@ - - - - - - - engforge.solveable.SolvableLog — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.solveable.SolvableLog

-
-
-class SolvableLog(name='')[source]
-

Bases: LoggingMixin

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solveable.SolveableMixin.html b/docs/_build/html/_autosummary/engforge.solveable.SolveableMixin.html deleted file mode 100644 index ee4c325..0000000 --- a/docs/_build/html/_autosummary/engforge.solveable.SolveableMixin.html +++ /dev/null @@ -1,778 +0,0 @@ - - - - - - - engforge.solveable.SolveableMixin — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.solveable.SolveableMixin

-
-
-class SolveableMixin(name='')[source]
-

Bases: AttributedBaseMixin

-

commonality for components,systems that identifies subsystems and states for solving.

-

This class defines the update structure of components and systems, and the storage of internal references to the system and its components. It also provides a method to iterate over the internal components and their references.

-

Importantly it defines the references to the system and its components, and the ability to set the system state from a dictionary of values across multiple objects. It also provides a method to iterate over the internal components and their references. There are several helper functions to these ends.

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

get_system_input_refs

Get the references to system input based on the specified criteria.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solvers_attributes

Lists all signals attributes for class

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

as_dict

returns values as they are in the class instance

attrs_fields

identity

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

logger

numeric_as_dict

numeric_hash

slack_webhook_url

unique_hash

parent

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)[source]
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)[source]
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)[source]
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)[source]
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)[source]
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)[source]
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)[source]
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)[source]
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)[source]
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)[source]
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)[source]
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-classmethod locate(key, fail=True)[source]
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)[source]
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-parse_run_kwargs(**kwargs)[source]
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)[source]
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-post_update(parent, *args, **kwargs)[source]
-

Kwargs comes from eval_kw in solver

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-system_references(recache=False, numeric_only=False, **kw)[source]
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)[source]
-

Kwargs comes from eval_kw in solver

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solveable.html b/docs/_build/html/_autosummary/engforge.solveable.html deleted file mode 100644 index 6ef0d1b..0000000 --- a/docs/_build/html/_autosummary/engforge.solveable.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - engforge.solveable — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.solveable
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.solveable

-

Classes

- - - - - - - - - -

SolvableLog

Initialize a filter.

SolveableMixin

commonality for components,systems that identifies subsystems and states for solving.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solver.SolverLog.html b/docs/_build/html/_autosummary/engforge.solver.SolverLog.html deleted file mode 100644 index 13a5cc2..0000000 --- a/docs/_build/html/_autosummary/engforge.solver.SolverLog.html +++ /dev/null @@ -1,322 +0,0 @@ - - - - - - - engforge.solver.SolverLog — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.solver.SolverLog

-
-
-class SolverLog(name='')[source]
-

Bases: LoggingMixin

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solver.SolverMixin.html b/docs/_build/html/_autosummary/engforge.solver.SolverMixin.html deleted file mode 100644 index f5216fa..0000000 --- a/docs/_build/html/_autosummary/engforge.solver.SolverMixin.html +++ /dev/null @@ -1,892 +0,0 @@ - - - - - - - engforge.solver.SolverMixin — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.solver.SolverMixin

-
-
-class SolverMixin(name='')[source]
-

Bases: SolveableMixin

-

A base class inherited by solveable items providing the ability to solve itself

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

eval

Evaluates the system with pre/post execute methodology :type kw: :param kw: kwargs come from sys_kw input in run ect.

execute

Solves the system's system of constraints and integrates transients if any exist

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

get_system_input_refs

Get the references to system input based on the specified criteria.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_run_callback

user callback for when run is complete

post_update

Kwargs comes from eval_kw in solver

pre_run_callback

user callback for when run is beginning

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

run

the steady state run the solver for the system.

run_internal_systems

runs internal systems with potentially scoped kwargs

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

solver

runs the system solver using the current system state and modifying it.

solver_vars

applies the default combo filter, and your keyword arguments to the collect_solver_refs to test the ref / vars creations

solvers_attributes

Lists all signals attributes for class

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

as_dict

returns values as they are in the class instance

attrs_fields

identity

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

log_fmt

log_level

log_on

logger

numeric_as_dict

numeric_hash

slack_webhook_url

solved

unique_hash

parent

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-eval(Xo=None, eval_kw=None, sys_kw=None, cb=None, **kw)[source]
-

Evaluates the system with pre/post execute methodology -:type kw: -:param kw: kwargs come from sys_kw input in run ect. -:type cb: -:param cb: an optional callback taking the system as an argument of the form (self,eval_kw,sys_kw,**kw)

-
-
Parameters:
-
    -

  • eval_kw (dict | None)

    • -

  • sys_kw (dict | None)

    • -
-
-
-
- -
-
-execute(**kw)[source]
-

Solves the system’s system of constraints and integrates transients if any exist

-

Override this function for custom solving functions, and call solver to use default solver functionality.

-
-
Returns:
-

the result of this function is returned from solver()

-
-
-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-post_run_callback(**kwargs)[source]
-

user callback for when run is complete

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-pre_run_callback(**kwargs)[source]
-

user callback for when run is beginning

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-run(**kwargs)[source]
-

the steady state run the solver for the system. It will run the system with the input vars and return the system with the results. Dynamics systems will be run so they are in a steady state nearest their initial position.

-
- -
-
-run_internal_systems(sys_kw=None)[source]
-

runs internal systems with potentially scoped kwargs

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-solver(enter_refresh=True, save_on_exit=True, **kw)[source]
-

runs the system solver using the current system state and modifying it. This is the default solver for the system, and it is recommended to add additional options or methods via the execute method.

-
-
Parameters:
-
    -

  • obj – the objective function to minimize, by default will minimize the sum of the squares of the residuals. Objective function should be a function(system,Xs,Xt) where Xs is the system state and Xt is the system transient state. The objective function will be argmin(X)|(1+custom_objective)*residual_RSS when add_obj is True in kw otherwise argmin(X)|custom_objective with constraints on the system as balances instead of first objective being included.

    • -

  • cons – the constraints to be used in the solver, by default will use the system’s constraints will be enabled when True. If a dictionary is passed the solver will use the dictionary as the constraints in addition to system constraints. These can be individually disabled by key=None in the dictionary.

    • -

  • X0 – the initial guess for the solver, by default will use the current system state. If a dictionary is passed the solver will use the dictionary as the initial guess in addition to the system state.

    • -

  • dXdt – can be 0 to indicate steady-state, or None to not run the transient constraints. Otherwise a partial dictionary of vars for the dynamics rates can be given, those not given will be assumed steady state or 0.

    • -

  • kw – additional options for the solver, such as the solver_option, or the solver method options. Described below

    • -

  • combos – a csv str or list of combos to include, including wildcards. the default means all combos will be run unless ign_combos or only combos alters behavior. The initial selection of combos is made by matching any case with the full name of the combo, or a parial name with a wildcard(s) in the combo name Ignore and only combos will further filter the selection. Wildcards / queries per fnmatch

    • -

  • ign_combos – a list of combo vars to ignore.

    • -

  • only_combos – a list of combo vars to include exclusively.

    • -

  • add_var – a csv str or variables to include, including wildcards. the default means all combos will be run unless ign_combos or only combos alters behavior. The initial selection of combos is made by matching any case with the full name of the combo, or a parial name with a wildcard(s) in the combo name Ignore and only combos will further filter the selection. Wildcards / queries per fnmatch

    • -

  • ign_var – a list of combo vars to ignore.

    • -

  • only_var – a list of combo vars to include exclusively.

    • -

  • add_obj – a flag to add the objective to the system constraints, by default will add the objective to the system constraints. If False the objective will be the only constraint.

    • -

  • only_active – default True, will only look at active variables objectives and constraints

    • -

  • activate – default None, a list of solver vars to activate

    • -

  • deactivate – default None, a list of solver vars to deactivate (if not activated above)

    • -
-
-
-
- -
-
-solver_vars(check_dynamics=True, addable=None, **kwargs)[source]
-

applies the default combo filter, and your keyword arguments to the collect_solver_refs to test the ref / vars creations

-

parses add_vars in kwargs to append to the collected solver vars -:param add_vars: can be a str, a list or a dictionary of variables: solver_instance kwargs. If a str or list the variable will be added with positive only constraints. If a dictionary is chosen, it can have keys as parameters, and itself have a subdictionary with keys: min / max, where each respective value is placed in the constraints list, which may be a callable(sys,prob) or numeric. If nothing is specified the default is min=0,max=None, ie positive only.

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solver.html b/docs/_build/html/_autosummary/engforge.solver.html deleted file mode 100644 index 69349f9..0000000 --- a/docs/_build/html/_autosummary/engforge.solver.html +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - - engforge.solver — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.solver

-

solver defines a SolverMixin for use by System.

-

Additionally the Solver attribute is defined to add complex behavior to a system as well as add constraints and transient integration.

-

### A general Solver Run Will Look Like: -0. run pre execute (signals=pre,both) -1. add execution context with **kwargument for the signals. -2. parse signals here (through a new Signals.parse_rtkwargs(**kw)) which will non destructively parse the signals and return all the signal candiates which are put into an ProblemExec object that resets the signals after the run depending on the revert behavior -3. the execute method will recieve this ProblemExec object where it can update the solver references / signals so that it can handle them per the signals api -4. with self.execution_context(**kwargs) as ctx_exe:

-
-

1. pre-update / signals -<FLEXIBLE_Exec>#self.execute(ctx_exe,**kwargs) -2. post-update / signals -> signals will be reset after the execute per the api

-
-
    -

  1. run post update

    2. -

  2. exit condition check via problem context input

    3. -
-

Classes

- - - - - - - - - -

SolverLog

Initialize a filter.

SolverMixin

A base class inherited by solveable items providing the ability to solve itself

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solver_utils.SolverUtilLog.html b/docs/_build/html/_autosummary/engforge.solver_utils.SolverUtilLog.html deleted file mode 100644 index 1e0a987..0000000 --- a/docs/_build/html/_autosummary/engforge.solver_utils.SolverUtilLog.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - - - engforge.solver_utils.SolverUtilLog — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.solver_utils.SolverUtilLog

-
-
-class SolverUtilLog(name='')[source]
-

Bases: LoggingMixin

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solver_utils.arg_var_compare.html b/docs/_build/html/_autosummary/engforge.solver_utils.arg_var_compare.html deleted file mode 100644 index 93e00ea..0000000 --- a/docs/_build/html/_autosummary/engforge.solver_utils.arg_var_compare.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - - engforge.solver_utils.arg_var_compare — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.solver_utils.arg_var_compare

-
-
-arg_var_compare(var, seq)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solver_utils.combo_filter.html b/docs/_build/html/_autosummary/engforge.solver_utils.combo_filter.html deleted file mode 100644 index 92b9963..0000000 --- a/docs/_build/html/_autosummary/engforge.solver_utils.combo_filter.html +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - - engforge.solver_utils.combo_filter — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.solver_utils.combo_filter

-
-
-combo_filter(attr_name, var_name, solver_inst, extra_kw, combos=None)[source]
-
-
Return type:
-

bool

-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solver_utils.create_constraint.html b/docs/_build/html/_autosummary/engforge.solver_utils.create_constraint.html deleted file mode 100644 index f62f4e0..0000000 --- a/docs/_build/html/_autosummary/engforge.solver_utils.create_constraint.html +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - - engforge.solver_utils.create_constraint — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.solver_utils.create_constraint

-
-
-create_constraint(system, Xref, contype, ref, con_args=None, *args, **kwargs)[source]
-

creates a constraint with bounded solver input from a constraint definition in dictionary with type and value. If value is a function it will be evaluated with the extra arguments provided. If var is None, then the constraint is assumed to be not in reference to the system x vars, otherwise lookups are made to that var.

-

Creates F(x_solver:array) such that the current vars of system are reverted to after the function has returned, which is used directly by SciPy’s optimize.minimize

-
-
Parameters:
-

contype (str)

-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solver_utils.ext_str_list.html b/docs/_build/html/_autosummary/engforge.solver_utils.ext_str_list.html deleted file mode 100644 index 7f6dd73..0000000 --- a/docs/_build/html/_autosummary/engforge.solver_utils.ext_str_list.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - - engforge.solver_utils.ext_str_list — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.solver_utils.ext_str_list

-
-
-ext_str_list(extra_kw, key, default=None)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solver_utils.f_lin_min.html b/docs/_build/html/_autosummary/engforge.solver_utils.f_lin_min.html deleted file mode 100644 index ab4267a..0000000 --- a/docs/_build/html/_autosummary/engforge.solver_utils.f_lin_min.html +++ /dev/null @@ -1,189 +0,0 @@ - - - - - - - engforge.solver_utils.f_lin_min — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.solver_utils.f_lin_min

-
-
-f_lin_min(system, prob, Xref, Yref, weights=None, *args, **kw)[source]
-

Creates an anonymous function with stored references to system, Yref, weights, that returns a scipy optimize friendly function of (x, Xref, *a, **kw) x which corresponds to the order of Xref dicts, and the other inputs are up to application.

-
-
Parameters:
-
    -

  • system – the system object

    • -

  • Xref – a dictionary of reference values for X

    • -

  • Yref – a dictionary of reference values for Y

    • -

  • weights – optional weights for Yref

    • -

  • args – additional positional arguments

    • -

  • kw – additional keyword arguments

    • -
-
-
Returns:
-

the anonymous function

-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solver_utils.filt_active.html b/docs/_build/html/_autosummary/engforge.solver_utils.filt_active.html deleted file mode 100644 index 0f5d759..0000000 --- a/docs/_build/html/_autosummary/engforge.solver_utils.filt_active.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - - engforge.solver_utils.filt_active — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.solver_utils.filt_active

-
-
-filt_active(var, inst, extra_kw=None, dflt=False)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solver_utils.filter_combos.html b/docs/_build/html/_autosummary/engforge.solver_utils.filter_combos.html deleted file mode 100644 index e4766cb..0000000 --- a/docs/_build/html/_autosummary/engforge.solver_utils.filter_combos.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - - engforge.solver_utils.filter_combos — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.solver_utils.filter_combos

-
-
-filter_combos(var, inst, extra_kw=None, combos_in=None)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solver_utils.filter_vals.html b/docs/_build/html/_autosummary/engforge.solver_utils.filter_vals.html deleted file mode 100644 index 4c4b0d0..0000000 --- a/docs/_build/html/_autosummary/engforge.solver_utils.filter_vals.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - - engforge.solver_utils.filter_vals — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.solver_utils.filter_vals

-
-
-filter_vals(var, inst, extra_kw=None)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solver_utils.handle_normalize.html b/docs/_build/html/_autosummary/engforge.solver_utils.handle_normalize.html deleted file mode 100644 index 0127768..0000000 --- a/docs/_build/html/_autosummary/engforge.solver_utils.handle_normalize.html +++ /dev/null @@ -1,173 +0,0 @@ - - - - - - - engforge.solver_utils.handle_normalize — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.solver_utils.handle_normalize

-
-
-handle_normalize(norm, Xref, Yref)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solver_utils.html b/docs/_build/html/_autosummary/engforge.solver_utils.html deleted file mode 100644 index 6422934..0000000 --- a/docs/_build/html/_autosummary/engforge.solver_utils.html +++ /dev/null @@ -1,219 +0,0 @@ - - - - - - - engforge.solver_utils — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.solver_utils
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.solver_utils

-

Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

arg_var_compare

combo_filter

create_constraint

creates a constraint with bounded solver input from a constraint definition in dictionary with type and value.

ext_str_list

f_lin_min

Creates an anonymous function with stored references to system, Yref, weights, that returns a scipy optimize friendly function of (x, Xref, *a, **kw) x which corresponds to the order of Xref dicts, and the other inputs are up to application.

filt_active

filter_combos

filter_vals

handle_normalize

objectify

converts a function f(system,slv_info:dict) into a function that safely changes states to the desired values and then runs the function.

ref_to_val_constraint

takes a var reference and a value and returns a function that can be used as a constraint for min/max cases.

refmin_solve

minimize the difference between two dictionaries of refernces, x references are changed in place, y will be solved to zero, options ensue for cases where the solution is not ideal

secondary_obj

modifies an objective function with a secondary function that is only considered when the primary function is minimized.

str_list_f

-

Classes

- - - - - - -

SolverUtilLog

Initialize a filter.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solver_utils.objectify.html b/docs/_build/html/_autosummary/engforge.solver_utils.objectify.html deleted file mode 100644 index 1003087..0000000 --- a/docs/_build/html/_autosummary/engforge.solver_utils.objectify.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - - engforge.solver_utils.objectify — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.solver_utils.objectify

-
-
-objectify(function, system, Xrefs, prob=None, *args, **kwargs)[source]
-

converts a function f(system,slv_info:dict) into a function that safely changes states to the desired values and then runs the function. A function is returend as f(x,*args,**kw)

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solver_utils.ref_to_val_constraint.html b/docs/_build/html/_autosummary/engforge.solver_utils.ref_to_val_constraint.html deleted file mode 100644 index c5c314f..0000000 --- a/docs/_build/html/_autosummary/engforge.solver_utils.ref_to_val_constraint.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - - engforge.solver_utils.ref_to_val_constraint — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.solver_utils.ref_to_val_constraint

-
-
-ref_to_val_constraint(system, ctx, Xrefs, var_ref, kind, val, contype='ineq', return_ref=False, *args, **kwargs)[source]
-

takes a var reference and a value and returns a function that can be used as a constraint for min/max cases. The function will be a function of the system and the info dictionary. The function will return the difference between the var value and the value.

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solver_utils.refmin_solve.html b/docs/_build/html/_autosummary/engforge.solver_utils.refmin_solve.html deleted file mode 100644 index 79fa606..0000000 --- a/docs/_build/html/_autosummary/engforge.solver_utils.refmin_solve.html +++ /dev/null @@ -1,186 +0,0 @@ - - - - - - - engforge.solver_utils.refmin_solve — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.solver_utils.refmin_solve

-
-
-refmin_solve(system, prob, Xref, Yref, Xo=None, weights=None, ffunc=<function f_lin_min>, **kw)[source]
-

minimize the difference between two dictionaries of refernces, x references are changed in place, y will be solved to zero, options ensue for cases where the solution is not ideal

-
-
Parameters:
-
    -

  • Xref (dict) – dictionary of references to the x values, or independents

    • -

  • Yref (dict) – dictionary of references to the value of objectives to be minimized

    • -

  • Xo – initial guess for the x values as a list against Xref order, or a dictionary

    • -

  • weights (Optional[array]) – a dictionary of values to weights the x values by, list also ok as long as same length and order as Xref

    • -

  • reset – if the solution fails, reset the x values to their original state, if true will reset the x values to their original state on failure overiding doset.

    • -

  • doset – if the solution is successful, set the x values to the solution by default, otherwise follows reset, if not successful reset is checked first, then doset

    • -
-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solver_utils.secondary_obj.html b/docs/_build/html/_autosummary/engforge.solver_utils.secondary_obj.html deleted file mode 100644 index b6318a1..0000000 --- a/docs/_build/html/_autosummary/engforge.solver_utils.secondary_obj.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - - engforge.solver_utils.secondary_obj — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.solver_utils.secondary_obj

-
-
-secondary_obj(obj_f, system, Xrefs, normalize=None, base_func=<function f_lin_min>, *args, **kwargs)[source]
-

modifies an objective function with a secondary function that is only considered when the primary function is minimized.

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.solver_utils.str_list_f.html b/docs/_build/html/_autosummary/engforge.solver_utils.str_list_f.html deleted file mode 100644 index 0d82e8b..0000000 --- a/docs/_build/html/_autosummary/engforge.solver_utils.str_list_f.html +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - - engforge.solver_utils.str_list_f — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.solver_utils.str_list_f

-
-
-str_list_f(out, sep=',')[source]
-
-
Parameters:
-

out (list)

-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.system.System.html b/docs/_build/html/_autosummary/engforge.system.System.html deleted file mode 100644 index cc7576a..0000000 --- a/docs/_build/html/_autosummary/engforge.system.System.html +++ /dev/null @@ -1,1688 +0,0 @@ - - - - - - - engforge.system.System — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.system.System

-
-
-class System(*, name=NOTHING, parent=None, dynamic_input_vars=NOTHING, dynamic_state_vars=NOTHING, dynamic_output_vars=NOTHING)[source]
-

Bases: SolverMixin, SolveableInterface, PlottingMixin, GlobalDynamics

-

A system defines SlotS for Components, and data flow between them using SignalS

-

The system records all attribues to its subcomponents via system_references with scoped keys to references to set or get attributes, as well as observe system properties. These are cached upon first access in an instance.

-

The table is made up of these system references, allowing low overhead recording of systems with many variables.

-

When solving by default the run(revert=True) call will revert the system state to what it was before the system began.

-

Method generated by attrs for class System.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

clone

returns a clone of this system, often used to iterate the system without affecting the input values at the last convergence step.

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

cls_compile

compiles this class, override this to compile functionality for this class

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

compile_classes

compiles all subclass functionality

copy_config_at_state

copy the system at the current state recrusively to a certain level, by default copying everything :type levels_deep: int :param levels_deep: how many levels deep to copy, -1 is all :type level: :param level: the current level, defaults to 0 if not set

create_dynamic_matricies

creates a dynamics object for the system

create_feedthrough_matrix

creates the input matrix for the system, called D

create_input_matrix

creates the input matrix for the system, called B

create_output_constants

creates the input matrix for the system, called O

create_output_matrix

creates the input matrix for the system, called C

create_state_constants

creates the input matrix for the system, called F

create_state_matrix

creates the state matrix for the system

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

determine_nearest_stationary_state

determine the nearest stationary state

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

eval

Evaluates the system with pre/post execute methodology :type kw: :param kw: kwargs come from sys_kw input in run ect.

execute

Solves the system's system of constraints and integrates transients if any exist

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

go_through_configurations

A generator that will go through all internal configurations up to a certain level if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will only go through this configuration

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_configurations

go through all attributes determining which are configuration objects additionally this skip any configuration that start with an underscore (private variable)

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

linear_output

simulate the system over the course of time.

linear_step

Optimal nonlinear steps

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

make_plots

makes plots and traces of all on this instance, and if a system is subsystems.

mark_all_comps_changed

mark all components as changed, useful for forcing a re-run of the system, or for marking data as saved

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

nonlinear_output

simulate the system over the course of time.

nonlinear_step

Optimal nonlinear steps

numeric_fields

parent_configurations_cls

returns all subclasses that are a Configuration

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_run_callback

user callback for when run is complete

post_update

Kwargs comes from eval_kw in solver

pre_compile

an overrideable classmethod that executes when compiled, however will not execute as a subclass

pre_run_callback

user callback for when run is beginning

print_info

rate

simulate the system over the course of time.

rate_linear

simulate the system over the course of time.

rate_nonlinear

simulate the system over the course of time.

ref_dXdt

returns the reference to the time differential of the state

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

run

the steady state run the solver for the system.

run_internal_systems

runs internal systems with potentially scoped kwargs

set_attr

set_time

sets the time of the system and context

setattrs

sets attributes from a dictionary

setup_global_dynamics

recursively creates numeric matricies for the simulation

signals_attributes

Lists all signals attributes for class

sim_matrix

simulate the system over the course of time.

simulate

runs a simulation over the course of time, and returns a dataframe of the results.

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solver

runs the system solver using the current system state and modifying it.

solver_vars

applies the default combo filter, and your keyword arguments to the collect_solver_refs to test the ref / vars creations

solvers_attributes

Lists all signals attributes for class

step

subclasses

return all subclasses of components, including their subclasses :type out: :param out: out is to pass when the middle of a recursive operation, do not use it!

subcls_compile

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

update_dynamics

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

update_feedthrough

override

update_input

override

update_output_constants

override

update_output_matrix

override

update_state

override

update_state_constants

override

validate_class

A customizeable validator at the end of class creation in forge

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ut_ref

alias for input values

Xt_ref

alias for state values

Yt_ref

alias for output values

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

classname

Shorthand for the classname

converged([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

dXtdt_ref

a dictionary of state var rates

dataframe_constants

dataframe_variants

displayname

dynamic_A

dynamic_B

dynamic_C

dynamic_D

dynamic_F

dynamic_K

dynamic_input

dynamic_input_vars

dynamic_output

dynamic_output_vars

dynamic_state

dynamic_state_vars

filename

A nice to have, good to override

identity

A customizeable property that will be in the log by default

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

get the last context run, or the parent's

log_fmt

log_level

log_on

log_silo

logger

nonlinear

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

run_id([fget, fset, fdel, doc])

this property notifies the system this is a property to be tabulated in the dataframe output.

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

solved

static_A

static_B

static_C

static_D

static_F

static_K

stored_plots

system_id

returns an instance unique id based on id(self)

time

unique_hash

update_interval

parent

name

dataframe

-
-
Parameters:
-
    -

  • name (str)

    • -

  • parent (Component | System)

    • -

  • dynamic_input_vars (list)

    • -

  • dynamic_state_vars (list)

    • -

  • dynamic_output_vars (list)

    • -
-
-
-
-
-property Ut_ref
-

alias for input values

-
- -
-
-property Xt_ref
-

alias for state values

-
- -
-
-property Yt_ref
-

alias for output values

-
- -
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-property classname
-

Shorthand for the classname

-
- -
-
-clone()[source]
-

returns a clone of this system, often used to iterate the system without affecting the input values at the last convergence step.

-
- -
-
-classmethod cls_compile()
-

compiles this class, override this to compile functionality for this class

-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-classmethod compile_classes()
-

compiles all subclass functionality

-
- -
-
-copy_config_at_state(level=None, levels_deep=-1, changed=None, **kw)
-

copy the system at the current state recrusively to a certain level, by default copying everything -:type levels_deep: int -:param levels_deep: how many levels deep to copy, -1 is all -:type level: -:param level: the current level, defaults to 0 if not set

-
-
Parameters:
-
    -

  • levels_deep (int)

    • -

  • changed (dict | None)

    • -
-
-
-
- -
-
-create_dynamic_matricies(**kw)
-

creates a dynamics object for the system

-
- -
-
-create_feedthrough_matrix(**kwargs)
-

creates the input matrix for the system, called D

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_input_matrix(**kwargs)
-

creates the input matrix for the system, called B

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_constants(**kwargs)
-

creates the input matrix for the system, called O

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_output_matrix(**kwargs)
-

creates the input matrix for the system, called C

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_constants(**kwargs)
-

creates the input matrix for the system, called F

-
-
Return type:
-

ndarray

-
-
-
- -
-
-create_state_matrix(**kwargs)
-

creates the state matrix for the system

-
-
Return type:
-

ndarray

-
-
-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property dXtdt_ref
-

a dictionary of state var rates

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-determine_nearest_stationary_state(t=0, X=None, U=None)
-

determine the nearest stationary state

-
-
Return type:
-

ndarray

-
-
-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-eval(Xo=None, eval_kw=None, sys_kw=None, cb=None, **kw)
-

Evaluates the system with pre/post execute methodology -:type kw: -:param kw: kwargs come from sys_kw input in run ect. -:type cb: -:param cb: an optional callback taking the system as an argument of the form (self,eval_kw,sys_kw,**kw)

-
-
Parameters:
-
    -

  • eval_kw (dict | None)

    • -

  • sys_kw (dict | None)

    • -
-
-
-
- -
-
-execute(**kw)
-

Solves the system’s system of constraints and integrates transients if any exist

-

Override this function for custom solving functions, and call solver to use default solver functionality.

-
-
Returns:
-

the result of this function is returned from solver()

-
-
-
- -
-
-property filename
-

A nice to have, good to override

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-go_through_configurations(level=0, levels_to_descend=-1, parent_level=0, only_inst=True, **kw)
-

A generator that will go through all internal configurations up to a certain level -if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will -only go through this configuration

-
-
Returns:
-

level,config

-
-
-
- -
-
-property identity
-

A customizeable property that will be in the log by default

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_configurations(check_config=True, use_dict=True, none_ok=False)
-

go through all attributes determining which are configuration objects -additionally this skip any configuration that start with an underscore (private variable)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

get the last context run, or the parent’s

-
- -
-
-linear_output(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-linear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-make_plots(analysis=None, store_figures=True, pre=None)
-

makes plots and traces of all on this instance, and if a system is -subsystems. Analysis should call make plots however it can be called on a system as well -:type analysis: Analysis -:param analysis: the analysis that has triggered this plot -:param store_figure: a boolean or dict, if neither a dictionary will be created and returend from this function -:returns: the dictionary from store_figures logic

-
-
Parameters:
-
    -

  • analysis (Analysis)

    • -

  • store_figures (bool)

    • -
-
-
-
- -
-
-mark_all_comps_changed(inpt)[source]
-

mark all components as changed, useful for forcing a re-run of the system, or for marking data as saved

-
-
Parameters:
-

inpt (bool)

-
-
-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-nonlinear_output(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-nonlinear_step(t, dt, X, U=None, set_Y=False)
-

Optimal nonlinear steps

-
- -
-
-classmethod parent_configurations_cls()
-

returns all subclasses that are a Configuration

-
-
Return type:
-

list

-
-
-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_run_callback(**kwargs)
-

user callback for when run is complete

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-classmethod pre_compile()
-

an overrideable classmethod that executes when compiled, however will not execute as a subclass

-
- -
-
-pre_run_callback(**kwargs)
-

user callback for when run is beginning

-
- -
-
-rate(t, dt, X, U, *args, **kwargs)
-

simulate the system over the course of time.

-
-
Parameters:
-
    -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -

  • subsystems (bool, optional) – simulate subsystems. Defaults to True.

    • -
-
-
Returns:
-

tabulated data

-
-
Return type:
-

dataframe

-
-
-
- -
-
-rate_linear(t, dt, X, U=None)
-

simulate the system over the course of time. Return time differential of the state.

-
- -
-
-rate_nonlinear(t, dt, X, U=None, update=True)
-

simulate the system over the course of time. Return time differential of the state.

-
-
Parameters:
-
    -

  • t (float) – time

    • -

  • dt (float) – interval to integrate over in time

    • -

  • X (np.ndarray) – state input

    • -

  • U (np.ndarray) – control input

    • -
-
-
Returns:
-

time differential of the state

-
-
Return type:
-

np.array

-
-
-
- -
-
-ref_dXdt(name)
-

returns the reference to the time differential of the state

-
-
Parameters:
-

name (str)

-
-
-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-run(**kwargs)
-

the steady state run the solver for the system. It will run the system with the input vars and return the system with the results. Dynamics systems will be run so they are in a steady state nearest their initial position.

-
- -
-
-run_internal_systems(sys_kw=None)
-

runs internal systems with potentially scoped kwargs

-
- -
-
-set_time(t, system=True, subcomponents=True)
-

sets the time of the system and context

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-setup_global_dynamics(**kwargs)
-

recursively creates numeric matricies for the simulation

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-sim_matrix(eval_kw=None, sys_kw=None, **kwargs)
-

simulate the system over the course of time. -return a dictionary of dataframes

-
- -
-
-simulate(dt, endtime, X0=None, cb=None, eval_kw=None, sys_kw=None, min_kw=None, run_solver=False, return_system=False, return_data=False, return_all=False, debug_fail=False, **kwargs)
-

runs a simulation over the course of time, and returns a dataframe of the results.

-

A copy of this system is made, and the simulation is run on the copy, so as to not affect the state of the original system.

-

#TODO:

-
-
Return type:
-

DataFrame

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-solver(enter_refresh=True, save_on_exit=True, **kw)
-

runs the system solver using the current system state and modifying it. This is the default solver for the system, and it is recommended to add additional options or methods via the execute method.

-
-
Parameters:
-
    -

  • obj – the objective function to minimize, by default will minimize the sum of the squares of the residuals. Objective function should be a function(system,Xs,Xt) where Xs is the system state and Xt is the system transient state. The objective function will be argmin(X)|(1+custom_objective)*residual_RSS when add_obj is True in kw otherwise argmin(X)|custom_objective with constraints on the system as balances instead of first objective being included.

    • -

  • cons – the constraints to be used in the solver, by default will use the system’s constraints will be enabled when True. If a dictionary is passed the solver will use the dictionary as the constraints in addition to system constraints. These can be individually disabled by key=None in the dictionary.

    • -

  • X0 – the initial guess for the solver, by default will use the current system state. If a dictionary is passed the solver will use the dictionary as the initial guess in addition to the system state.

    • -

  • dXdt – can be 0 to indicate steady-state, or None to not run the transient constraints. Otherwise a partial dictionary of vars for the dynamics rates can be given, those not given will be assumed steady state or 0.

    • -

  • kw – additional options for the solver, such as the solver_option, or the solver method options. Described below

    • -

  • combos – a csv str or list of combos to include, including wildcards. the default means all combos will be run unless ign_combos or only combos alters behavior. The initial selection of combos is made by matching any case with the full name of the combo, or a parial name with a wildcard(s) in the combo name Ignore and only combos will further filter the selection. Wildcards / queries per fnmatch

    • -

  • ign_combos – a list of combo vars to ignore.

    • -

  • only_combos – a list of combo vars to include exclusively.

    • -

  • add_var – a csv str or variables to include, including wildcards. the default means all combos will be run unless ign_combos or only combos alters behavior. The initial selection of combos is made by matching any case with the full name of the combo, or a parial name with a wildcard(s) in the combo name Ignore and only combos will further filter the selection. Wildcards / queries per fnmatch

    • -

  • ign_var – a list of combo vars to ignore.

    • -

  • only_var – a list of combo vars to include exclusively.

    • -

  • add_obj – a flag to add the objective to the system constraints, by default will add the objective to the system constraints. If False the objective will be the only constraint.

    • -

  • only_active – default True, will only look at active variables objectives and constraints

    • -

  • activate – default None, a list of solver vars to activate

    • -

  • deactivate – default None, a list of solver vars to deactivate (if not activated above)

    • -
-
-
-
- -
-
-solver_vars(check_dynamics=True, addable=None, **kwargs)
-

applies the default combo filter, and your keyword arguments to the collect_solver_refs to test the ref / vars creations

-

parses add_vars in kwargs to append to the collected solver vars -:param add_vars: can be a str, a list or a dictionary of variables: solver_instance kwargs. If a str or list the variable will be added with positive only constraints. If a dictionary is chosen, it can have keys as parameters, and itself have a subdictionary with keys: min / max, where each respective value is placed in the constraints list, which may be a callable(sys,prob) or numeric. If nothing is specified the default is min=0,max=None, ie positive only.

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod subclasses(out=None)[source]
-

return all subclasses of components, including their subclasses -:type out: -:param out: out is to pass when the middle of a recursive operation, do not use it!

-
- -
-
-classmethod subcls_compile()
-

reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins

-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-update_dynamics(t, X, U)
-

Updates dynamics when nonlinear is enabled, otherwise it will do nothing

-
- -
-
-update_feedthrough(t, D, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_input(t, B, X, U)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_constants(t, O, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_output_matrix(t, C, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state(t, A, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-update_state_constants(t, F, X)
-

override

-
-
Return type:
-

ndarray

-
-
-
- -
-
-classmethod validate_class()
-

A customizeable validator at the end of class creation in forge

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.system.SystemsLog.html b/docs/_build/html/_autosummary/engforge.system.SystemsLog.html deleted file mode 100644 index db49813..0000000 --- a/docs/_build/html/_autosummary/engforge.system.SystemsLog.html +++ /dev/null @@ -1,322 +0,0 @@ - - - - - - - engforge.system.SystemsLog — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.system.SystemsLog

-
-
-class SystemsLog(name='')[source]
-

Bases: LoggingMixin

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.system.html b/docs/_build/html/_autosummary/engforge.system.html deleted file mode 100644 index bab63ca..0000000 --- a/docs/_build/html/_autosummary/engforge.system.html +++ /dev/null @@ -1,187 +0,0 @@ - - - - - - - engforge.system — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.system

-

A System is a Configuration that orchestrates dataflow between components, as well as solving systems of equations in the presense of limits, as well as formatting results of each Component into reporting ready dataframe. System’s solver behavior is inspired by NASA’s numerical propulsion simulation system (NPSS) to solve systems of inequalities in complex systems.

-
-
Component or other subsystems are added to a System class with Slots:

``` -class CustomSystem(System):

-
-

slot_name = Slot.define(Component,ComponentSubclass,System)

-
-

```

-
-
Component’s data flow is established via SignalS that are defined:

``` -class CustomSystem(System):

-
-

signal_name = Signal.define(source_attr_or_property, target_attr) -control_signal = Signal.define(source_attr_or_property, target_attr,control_with=’system.attr or slot.attr`)

-
-

``` -- source_attr: can reference a locally defined slot attribute (a la attr’s fields) or any locally defined slot system property -- target_attr: must be a locally defined slot attribute or system attribute.

-
-
-

update description to include solver

-

A system calculates its state upon calling System.run(). This executes pre_execute() first which will directly update any attributes based on their Signal definition between Slot components. Once convergence is reached target_attr’s are updated in post_execute() for cyclic SignalS.

-

If the system encounters a subsystem in its solver routine, the subsystem is evald() and its results used as static in that iteration,ie it isn’t included in the system level dependents if cyclic references are found.

-

The solver uses the root or cobla scipy optimizer results on quick references to internal component references. Upon solving the system

-

SignalS can be limited with constrains via min or max values on NumericProperty which can be numeric values (int or float) or functions taking one argument of the component it is defined on. Additionally signals may take arguments of min or max which are numeric values or callbacks which take the system instance as an argument.

-

Classes

- - - - - - - - - -

System

A system defines SlotS for Components, and data flow between them using SignalS

SystemsLog

Initialize a filter.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.system_reference.Ref.html b/docs/_build/html/_autosummary/engforge.system_reference.Ref.html deleted file mode 100644 index a30406b..0000000 --- a/docs/_build/html/_autosummary/engforge.system_reference.Ref.html +++ /dev/null @@ -1,244 +0,0 @@ - - - - - - - engforge.system_reference.Ref — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.system_reference.Ref

-
-
-class Ref(comp, key, use_call=True, allow_set=True, eval_f=None)[source]
-

Bases: object

-

A way to create portable references to system’s and their component’s properties, ref can also take a key to a zero argument function which will be evald. This is useful for creating an adhoc optimization problems dynamically between variables. However use must be carefully controlled to avoid circular references, and understanding the safe use of the refset_input and refset_get methods (changing state on actual system).

-

A dictionary can be used as a component, and the key will be used to access the value in the dictionary.

-

The key can be a callable of (*args,**kw) only in which case Ref.value(*args,**kw) will take input, and the ref will be evaluated as the result of the callable (allow_set=False), this renders the component unused, and disables the ability to set the value of the reference.

-

The ability to set this ref with another on key input allows for creating a reference that is identical to another reference except for the component provided if it is not None.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - -

copy

copy the reference, and make changes to the copy

refset_get

refset_input

change a set of refs with a dictionary of values.

set

set_value

setup_calls

caches anonymous functions for value and logging speedup

value

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - -

comp

key

use_call

use_dict

allow_set

eval_f

key_override

hxd

-
-
-copy(**changes)[source]
-

copy the reference, and make changes to the copy

-
- -
-
-refset_input(delta_dict, chk=True, fail=True, warn=True)
-

change a set of refs with a dictionary of values. If chk is True k will be checked for membership in refs

-
- -
-
-setup_calls()[source]
-

caches anonymous functions for value and logging speedup

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.system_reference.RefLog.html b/docs/_build/html/_autosummary/engforge.system_reference.RefLog.html deleted file mode 100644 index b7cfae1..0000000 --- a/docs/_build/html/_autosummary/engforge.system_reference.RefLog.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - engforge.system_reference.RefLog — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.system_reference.RefLog

-
-
-class RefLog(name='')[source]
-

Bases: LoggingMixin

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.system_reference.eval_ref.html b/docs/_build/html/_autosummary/engforge.system_reference.eval_ref.html deleted file mode 100644 index a759d10..0000000 --- a/docs/_build/html/_autosummary/engforge.system_reference.eval_ref.html +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - - engforge.system_reference.eval_ref — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.system_reference.eval_ref

-
-
-eval_ref(canidate, *args, **kw)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.system_reference.html b/docs/_build/html/_autosummary/engforge.system_reference.html deleted file mode 100644 index bad54b0..0000000 --- a/docs/_build/html/_autosummary/engforge.system_reference.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - - engforge.system_reference — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.system_reference
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.system_reference

-

Module to define the Ref class and utility methods for working with it.

-

Ref’s are designed to create adhoc links between the systems & components of the system, and their properties. This is useful for creating optimization problems, and for creating dynamic links between the state and properties of the system. Care must be used on the component objects changing of state, the recommened procedure is to copy your base system to prevent hysterisis and other issues, then push/pop X values through the optimization methods and change state upon success

-

Ref.component can be a Component,System or dictionary for referencing via keyword. Ref.key can be a string or a callable, if callable the ref will be evaluated as the result of the callable (allow_set=False), this renders the component unused, and disables the ability to set the value of the reference.

-

Functions

- - - - - - - - - - - - - - - - - - - - - -

eval_ref

maybe_attr_inst

returns the ref if is one otherwise convert it, otherwise returns the value

maybe_ref

returns the value of a ref if it is a ref, otherwise returns the value

refset_get

refset_input

change a set of refs with a dictionary of values.

scale_val

-

Classes

- - - - - - - - - -

Ref

A way to create portable references to system's and their component's properties, ref can also take a key to a zero argument function which will be evald.

RefLog

Initialize a filter.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.system_reference.maybe_attr_inst.html b/docs/_build/html/_autosummary/engforge.system_reference.maybe_attr_inst.html deleted file mode 100644 index e346b8e..0000000 --- a/docs/_build/html/_autosummary/engforge.system_reference.maybe_attr_inst.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - engforge.system_reference.maybe_attr_inst — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.system_reference.maybe_attr_inst

-
-
-maybe_attr_inst(can, astype=None)[source]
-

returns the ref if is one otherwise convert it, otherwise returns the value

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.system_reference.maybe_ref.html b/docs/_build/html/_autosummary/engforge.system_reference.maybe_ref.html deleted file mode 100644 index 5de576b..0000000 --- a/docs/_build/html/_autosummary/engforge.system_reference.maybe_ref.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - engforge.system_reference.maybe_ref — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.system_reference.maybe_ref

-
-
-maybe_ref(can, astype=None, mult=None, bias=None, power=None, *args, **kw)[source]
-

returns the value of a ref if it is a ref, otherwise returns the value

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.system_reference.refset_get.html b/docs/_build/html/_autosummary/engforge.system_reference.refset_get.html deleted file mode 100644 index 15c9061..0000000 --- a/docs/_build/html/_autosummary/engforge.system_reference.refset_get.html +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - - engforge.system_reference.refset_get — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.system_reference.refset_get

-
-
-refset_get(refs, *args, **kw)[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.system_reference.refset_input.html b/docs/_build/html/_autosummary/engforge.system_reference.refset_input.html deleted file mode 100644 index 448830e..0000000 --- a/docs/_build/html/_autosummary/engforge.system_reference.refset_input.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - engforge.system_reference.refset_input — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.system_reference.refset_input

-
-
-refset_input(refs, delta_dict, chk=True, fail=True, warn=True)[source]
-

change a set of refs with a dictionary of values. If chk is True k will be checked for membership in refs

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.system_reference.scale_val.html b/docs/_build/html/_autosummary/engforge.system_reference.scale_val.html deleted file mode 100644 index 64ec858..0000000 --- a/docs/_build/html/_autosummary/engforge.system_reference.scale_val.html +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - - engforge.system_reference.scale_val — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.system_reference.scale_val

-
-
-scale_val(val, mult=None, bias=None, power=None)[source]
-
-
Return type:
-

float

-
-
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.tabulation.TableLog.html b/docs/_build/html/_autosummary/engforge.tabulation.TableLog.html deleted file mode 100644 index c83914a..0000000 --- a/docs/_build/html/_autosummary/engforge.tabulation.TableLog.html +++ /dev/null @@ -1,322 +0,0 @@ - - - - - - - engforge.tabulation.TableLog — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.tabulation.TableLog

-
-
-class TableLog(name='')[source]
-

Bases: LoggingMixin

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

installSTDLogger

We only want std logging to start

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

slack_notification

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - -

identity

log_fmt

log_level

log_on

logger

slack_webhook_url

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.tabulation.TabulationMixin.html b/docs/_build/html/_autosummary/engforge.tabulation.TabulationMixin.html deleted file mode 100644 index 533d479..0000000 --- a/docs/_build/html/_autosummary/engforge.tabulation.TabulationMixin.html +++ /dev/null @@ -1,879 +0,0 @@ - - - - - - - engforge.tabulation.TabulationMixin — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.tabulation.TabulationMixin

-
-
-class TabulationMixin(name='')[source]
-

Bases: SolveableMixin, DataframeMixin

-

In which we define a class that can enable tabulation

-

Initialize a filter.

-

Initialize with the name of the logger which, together with its -children, will have its events allowed through the filter. If no -name is specified, allow every event.

-

Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

add_fields

Overwrite this to modify logging fields

change_all_log_lvl

check_ref_slot_type

recursively checks class slots for the key, and returns the slot type

cls_all_attrs_fields

cls_all_property_keys

cls_all_property_labels

collect_all_attributes

collects all the attributes for a system

collect_comp_refs

collects all the references for the system grouped by component

collect_dynamic_refs

collects the dynamics of the systems 1.

collect_inst_attributes

collects all the attributes for a system

collect_post_update_refs

checks all methods and creates ref's to execute them later

collect_solver_refs

collects all the references for the system grouped by function and prepended with the system key

collect_update_refs

checks all methods and creates ref's to execute them later

comp_references

A cached set of recursive references to any slot component #FIXME: by instance recache on iterative component change or other signals

critical

A routine to communicate to the root of the server network that there is an issue

debug

Writes at a low level to the log file.

difference

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

error

Writes to log as a error

extract_message

filter

This acts as the interface for logging.Filter Don't overwrite this, use add_fields instead.

format_columns

get_system_input_refs

Get the references to system input based on the specified criteria.

info

Writes to log but with info category, these are important typically and inform about progress of process in general

input_attrs

input_fields

no attr base types, no tuples, no lists, no dicts

installSTDLogger

We only want std logging to start

internal_components

get all the internal components

internal_references

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

internal_systems

get all the internal components

internal_tabulations

get all the internal tabulations

locate

locate_ref

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function.

message_with_identiy

converts to color and string via the termcolor library :type message: str :param message: a string convertable entity :type color: :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

msg

Writes to log.

numeric_fields

parse_run_kwargs

ensures correct input for simulation.

parse_simulation_input

parses the simulation input

plot_attributes

Lists all plot attributes for class

post_update

Kwargs comes from eval_kw in solver

pre_compile

print_info

resetLog

reset log

resetSystemLogs

resets log on all internal instance LoggingMixins

set_attr

setattrs

sets attributes from a dictionary

signals_attributes

Lists all signals attributes for class

slack_notification

slot_refs

returns all slot references in this configuration

slots_attributes

Lists all slots attributes for class

smart_split_dataframe

splits dataframe between constant values and variants

solvers_attributes

Lists all signals attributes for class

system_properties_classdef

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

system_references

gather a list of references to attributes and

table_fields

trace_attributes

Lists all trace attributes for class

transients_attributes

Lists all signals attributes for class

update

Kwargs comes from eval_kw in solver

warning

Writes to log as a warning

-

Attributes

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

anything_changed

use the on_setattr method to determine if anything changed, also assume that stat_tab could change without input changes

as_dict

returns values as they are in the class instance

attrs_fields

data_dict

this is what is captured and used in each row of the dataframe / table

dataframe([fget, fset, fdel, doc])

A property that updates a first time and then anytime time the input data changed, as signaled by attrs.on_setattr callback

dataframe_constants

dataframe_variants

identity

input_as_dict

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

last_context

Returns the last context

log_fmt

log_level

log_on

logger

numeric_as_dict

numeric_hash

plotable_variables

Checks columns for ones that only contain numeric types or haven't been explicitly skipped

skip_plot_vars

accesses '_skip_plot_vars' if it exists, otherwise returns empty list

slack_webhook_url

system_id

returns an instance unique id based on id(self)

unique_hash

parent

-
-
-add_fields(record)
-

Overwrite this to modify logging fields

-
- -
-
-property anything_changed
-

use the on_setattr method to determine if anything changed, -also assume that stat_tab could change without input changes

-
- -
-
-property as_dict
-

returns values as they are in the class instance

-
- -
-
-classmethod check_ref_slot_type(sys_key)
-

recursively checks class slots for the key, and returns the slot type

-
-
Return type:
-

list

-
-
Parameters:
-

sys_key (str)

-
-
-
- -
-
-classmethod collect_all_attributes()
-

collects all the attributes for a system

-
- -
-
-collect_comp_refs(conf=None, **kw)
-

collects all the references for the system grouped by component

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_dynamic_refs(conf=None, **kw)
-

collects the dynamics of the systems -1. Time.integrate -2. Dynamic Instances

-
-
Return type:
-

dict

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_inst_attributes(**kw)
-

collects all the attributes for a system

-
- -
-
-collect_post_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-collect_solver_refs(conf=None, check_atr_f=None, check_kw=None, check_dynamics=True, **kw)
-

collects all the references for the system grouped by function and prepended with the system key

-
-
Parameters:
-

conf (Configuration | None)

-
-
-
- -
-
-collect_update_refs(eval_kw=None, ignore=None)
-

checks all methods and creates ref’s to execute them later

-
- -
-
-comp_references(ignore_none_comp=True, **kw)
-

A cached set of recursive references to any slot component -#FIXME: by instance recache on iterative component change or other signals

-
- -
-
-critical(*args)
-

A routine to communicate to the root of the server network that there is an issue

-
- -
-
-property data_dict
-

this is what is captured and used in each row of the dataframe / table

-
- -
-
-debug(*args)
-

Writes at a low level to the log file… usually this should -be detailed messages about what exactly is going on

-
- -
-
-difference(**kwargs)
-

a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.

-
-
with self.difference(name=’new_name’, value = new_value) as new_config:

#do stuff with config, ok to fail

-
-
-

you may not access any “private” variable that starts with an _ as in _whatever

-

difference is useful for saving slight differences in configuration in conjunction with solve -you might create wrappers for eval, or implement a strategy pattern.

-

only attributes may be changed.

-

#TODO: allow recursive operation with sub comps or systems. -#TODO: make a full system copy so the system can be reverted later

-
- -
-
-error(error, msg='')
-

Writes to log as a error

-
- -
-
-filter(record)
-

This acts as the interface for logging.Filter -Don’t overwrite this, use add_fields instead.

-
- -
-
-get_system_input_refs(strings=False, numeric=True, misc=False, all=False, boolean=False, **kw)
-

Get the references to system input based on the specified criteria.

-
-
Parameters:
-
    -

  • strings – Include system properties of string type.

    • -

  • numeric – Include system properties of numeric type (float, int).

    • -

  • misc – Include system properties of miscellaneous type.

    • -

  • all – Include all system properties regardless of type.

    • -

  • boolean – Include system properties of boolean type.

    • -

  • kw – Additional keyword arguments passed to recursive config loop

    • -
-
-
Returns:
-

A dictionary of system property references.

-
-
Return type:
-

dict

-
-
-
- -
-
-info(*args)
-

Writes to log but with info category, these are important typically -and inform about progress of process in general

-
- -
-
-property input_as_dict
-

returns values as they are in the class instance, but converts classes inputs to their input_as_dict

-
- -
-
-classmethod input_fields(add_ign_types=None)
-

no attr base types, no tuples, no lists, no dicts

-
-
Parameters:
-

add_ign_types (list | None)

-
-
-
- -
-
-installSTDLogger()
-

We only want std logging to start

-
- -
-
-internal_components(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_references(recache=False, numeric_only=False)
-

get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_systems(recache=False)
-

get all the internal components

-
-
Return type:
-

dict

-
-
-
- -
-
-internal_tabulations(recache=False)
-

get all the internal tabulations

-
-
Return type:
-

dict

-
-
-
- -
-
-property last_context
-

Returns the last context

-
- -
-
-classmethod locate(key, fail=True)
-
-
Return type:
-

type

-
-
Returns:
-

the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error

-
-
-
- -
-
-locate_ref(key, fail=True, **kw)
-

Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a . in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the comp passed in the kw will be used. -:type key: -:param key: the key to locate, or a callable to be used as a reference -:param comp: the component to use if a callable is passed -:returns: the instance assigned to this system. If the key has a . in it the comp the lowest level component will be returned

-
- -
-
-message_with_identiy(message, color=None)
-

converts to color and string via the termcolor library -:type message: str -:param message: a string convertable entity -:type color: -:param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]

-
-
Parameters:
-

message (str)

-
-
-
- -
-
-msg(*args, lvl=5)
-

Writes to log… this should be for raw data or something… least priorty

-
- -
-
-parse_run_kwargs(**kwargs)
-

ensures correct input for simulation. -:returns: first set of input for initalization, and all input dictionaries as tuple.

-
- -
-
-parse_simulation_input(**kwargs)
-

parses the simulation input

-
-
Parameters:
-
    -

  • dt – timestep in s, required for transients

    • -

  • endtime – when to end the simulation

    • -
-
-
-
- -
-
-classmethod plot_attributes()
-

Lists all plot attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property plotable_variables
-

Checks columns for ones that only contain numeric types or haven’t been explicitly skipped

-
- -
-
-post_update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-resetLog()
-

reset log

-
- -
-
-resetSystemLogs(reseted=None)
-

resets log on all internal instance LoggingMixins

-
- -
-
-setattrs(dict)
-

sets attributes from a dictionary

-
- -
-
-classmethod signals_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property skip_plot_vars: list
-

accesses ‘_skip_plot_vars’ if it exists, otherwise returns empty list

-
- -
-
-classmethod slot_refs(recache=False)
-

returns all slot references in this configuration

-
- -
-
-classmethod slots_attributes()
-

Lists all slots attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-smart_split_dataframe(df=None, split_groups=0, key_f=<function <lambda>>)
-

splits dataframe between constant values and variants

-
- -
-
-classmethod solvers_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-property system_id: str
-

returns an instance unique id based on id(self)

-
- -
-
-classmethod system_properties_classdef(recache=False)[source]
-

Combine other parent-classes table properties into this one, in the case of subclassed system_properties

-
- -
-
-system_references(recache=False, numeric_only=False, **kw)
-

gather a list of references to attributes and

-
- -
-
-classmethod trace_attributes()
-

Lists all trace attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-classmethod transients_attributes()
-

Lists all signals attributes for class

-
-
Return type:
-

Dict[str, Attribute]

-
-
-
- -
-
-update(parent, *args, **kwargs)
-

Kwargs comes from eval_kw in solver

-
- -
-
-warning(*args)
-

Writes to log as a warning

-
- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.tabulation.html b/docs/_build/html/_autosummary/engforge.tabulation.html deleted file mode 100644 index 4d24e2f..0000000 --- a/docs/_build/html/_autosummary/engforge.tabulation.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - - engforge.tabulation — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • engforge
    • -
  • engforge.tabulation
    • -
  • -
    • -
-
-
-
-
- -
-

engforge.tabulation

-

Tabulation Module:

-

Incrementally records attrs input values and system_properties per save_data() call.

-

save_data() is called after item.eval() is called.

-

Classes

- - - - - - - - - -

TableLog

Initialize a filter.

TabulationMixin

In which we define a class that can enable tabulation

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.typing.NUMERIC_NAN_VALIDATOR.html b/docs/_build/html/_autosummary/engforge.typing.NUMERIC_NAN_VALIDATOR.html deleted file mode 100644 index f839d2a..0000000 --- a/docs/_build/html/_autosummary/engforge.typing.NUMERIC_NAN_VALIDATOR.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - engforge.typing.NUMERIC_NAN_VALIDATOR — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.typing.NUMERIC_NAN_VALIDATOR

-
-
-NUMERIC_NAN_VALIDATOR()[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.typing.NUMERIC_VALIDATOR.html b/docs/_build/html/_autosummary/engforge.typing.NUMERIC_VALIDATOR.html deleted file mode 100644 index 2ab6f81..0000000 --- a/docs/_build/html/_autosummary/engforge.typing.NUMERIC_VALIDATOR.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - engforge.typing.NUMERIC_VALIDATOR — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.typing.NUMERIC_VALIDATOR

-
-
-NUMERIC_VALIDATOR()[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.typing.Options.html b/docs/_build/html/_autosummary/engforge.typing.Options.html deleted file mode 100644 index 127def1..0000000 --- a/docs/_build/html/_autosummary/engforge.typing.Options.html +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - - engforge.typing.Options — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.typing.Options

-
-
-Options(*choices, **kwargs)[source]
-

creates an attrs field with validated choices on init and setattr -:type choices: -:param choices: a list of choices that are validated on input, the first becoming the default unless it is passed in kwargs -:type kwargs: -:param kwargs: keyword args passed to attrs field

-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.typing.STR_VALIDATOR.html b/docs/_build/html/_autosummary/engforge.typing.STR_VALIDATOR.html deleted file mode 100644 index 8976855..0000000 --- a/docs/_build/html/_autosummary/engforge.typing.STR_VALIDATOR.html +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - - engforge.typing.STR_VALIDATOR — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.typing.STR_VALIDATOR

-
-
-STR_VALIDATOR()[source]
-
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/engforge.typing.html b/docs/_build/html/_autosummary/engforge.typing.html deleted file mode 100644 index ed6040b..0000000 --- a/docs/_build/html/_autosummary/engforge.typing.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - engforge.typing — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

engforge.typing

-

Functions

- - - - - - - - - - - - - - - -

NUMERIC_NAN_VALIDATOR

NUMERIC_VALIDATOR

Options

creates an attrs field with validated choices on init and setattr :type choices: :param choices: a list of choices that are validated on input, the first becoming the default unless it is passed in kwargs :type kwargs: :param kwargs: keyword args passed to attrs field

STR_VALIDATOR

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/examples.air_filter.html b/docs/_build/html/_autosummary/examples.air_filter.html deleted file mode 100644 index 03ebee3..0000000 --- a/docs/_build/html/_autosummary/examples.air_filter.html +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - - examples.air_filter — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • examples
    • -
  • examples.air_filter
    • -
  • -
    • -
-
-
-
-
- -
-

examples.air_filter

-

Classes

- - - - - - - - - - - - - - - -

Airfilter(*[, name, fan, filt, parent, ...])

Method generated by attrs for class Airfilter.

AirfilterAnalysis(*[, name, ...])

Does post processing on a system

Fan(*[, name, parent, n_frac, dp_design, ...])

Method generated by attrs for class Fan.

Filter(*[, name, parent, w, k_loss])

Method generated by attrs for class Filter.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/examples.html b/docs/_build/html/_autosummary/examples.html deleted file mode 100644 index 6ac444e..0000000 --- a/docs/_build/html/_autosummary/examples.html +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - examples — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • examples
    • -
  • -
    • -
-
-
-
-
- -
-

examples

-

Modules

- - - - - - - - - -

air_filter

spring_mass

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/examples.spring_mass.html b/docs/_build/html/_autosummary/examples.spring_mass.html deleted file mode 100644 index 97231cb..0000000 --- a/docs/_build/html/_autosummary/examples.spring_mass.html +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - - examples.spring_mass — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • examples
    • -
  • examples.spring_mass
    • -
  • -
    • -
-
-
-
-
- -
-

examples.spring_mass

-

Classes

- - - - - - -

SpringMass(*[, name, parent, ...])

Method generated by attrs for class SpringMass.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/test.html b/docs/_build/html/_autosummary/test.html deleted file mode 100644 index 89730fc..0000000 --- a/docs/_build/html/_autosummary/test.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - - test — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • test
    • -
  • -
    • -
-
-
-
-
- -
-

test

-

Modules

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

test_airfilter

tests airfilter system operation by solving for airflow between filter and and fan

test_comp_iter

test_composition

test_costs

Testing of costs reporting module - emphasis on recursive testing w/o double accounting on instance basis (id!) - emphasis on default / subclass adjustments

test_dynamics

test transient cases and match against real world results

test_dynamics_spaces

test_four_bar

test_modules

test_performance

test_pipes

test_problem_deepscoping

test_slider_crank

test_solver

test_tabulation

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/test.test_airfilter.html b/docs/_build/html/_autosummary/test.test_airfilter.html deleted file mode 100644 index 1fa73b3..0000000 --- a/docs/_build/html/_autosummary/test.test_airfilter.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - - test.test_airfilter — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • test
    • -
  • test.test_airfilter
    • -
  • -
    • -
-
-
-
-
- -
-

test.test_airfilter

-

tests airfilter system operation by solving for airflow between filter and and fan

-

Classes

- - - - - - - - - -

TestAnalysis([methodName])

Create an instance of the class that will use the named test method when executed.

TestFilterSystem([methodName])

Create an instance of the class that will use the named test method when executed.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/test.test_comp_iter.html b/docs/_build/html/_autosummary/test.test_comp_iter.html deleted file mode 100644 index b6d3b9f..0000000 --- a/docs/_build/html/_autosummary/test.test_comp_iter.html +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - test.test_comp_iter — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • test
    • -
  • test.test_comp_iter
    • -
  • -
    • -
-
-
-
-
- -
-

test.test_comp_iter

-

Classes

- - - - - - - - - - - - - - - - - - - - - - - - -

DictComp(*[, name, parent, current_item, ...])

Method generated by attrs for class DictComp.

ListComp(*[, name, parent, current_item, ...])

Method generated by attrs for class ListComp.

NarrowSystem(*[, name, cdict, citer, ...])

Method generated by attrs for class NarrowSystem.

TestConfig(*[, name, parent, attrs_prop, ...])

Method generated by attrs for class TestConfig.

TestNarrow([methodName])

Create an instance of the class that will use the named test method when executed.

TestWide([methodName])

Create an instance of the class that will use the named test method when executed.

WideSystem(*[, name, cdict, citer, parent, ...])

Method generated by attrs for class WideSystem.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/test.test_composition.html b/docs/_build/html/_autosummary/test.test_composition.html deleted file mode 100644 index edfd560..0000000 --- a/docs/_build/html/_autosummary/test.test_composition.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - - test.test_composition — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • test
    • -
  • test.test_composition
    • -
  • -
    • -
-
-
-
-
- -
-

test.test_composition

-

Functions

- - - - - - -

limit_max(system, prb)

-

Classes

- - - - - - - - - - - - -

MockComponent(*[, name, comp, parent, ...])

Method generated by attrs for class MockComponent.

MockSystem(*[, name, comp, parent, ...])

Method generated by attrs for class MockSystem.

TestComposition([methodName])

Create an instance of the class that will use the named test method when executed.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/test.test_costs.html b/docs/_build/html/_autosummary/test.test_costs.html deleted file mode 100644 index 3fa3dec..0000000 --- a/docs/_build/html/_autosummary/test.test_costs.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - - test.test_costs — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • test
    • -
  • test.test_costs
    • -
  • -
    • -
-
-
-
-
- -
-

test.test_costs

-

Testing of costs reporting module -- emphasis on recursive testing w/o double accounting on instance basis (id!) -- emphasis on default / subclass adjustments

-

Classes

- - - - - - - - - - - - - - - - - - -

TestCategoriesAndTerms([methodName])

Create an instance of the class that will use the named test method when executed.

TestCostModel([methodName])

Create an instance of the class that will use the named test method when executed.

TestEconDefaults([methodName])

Create an instance of the class that will use the named test method when executed.

TestEconomicsAccounting([methodName])

Create an instance of the class that will use the named test method when executed.

TestFanSystemDataFrame([methodName])

Create an instance of the class that will use the named test method when executed.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/test.test_dynamics.html b/docs/_build/html/_autosummary/test.test_dynamics.html deleted file mode 100644 index 6d46211..0000000 --- a/docs/_build/html/_autosummary/test.test_dynamics.html +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - - test.test_dynamics — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • test
    • -
  • test.test_dynamics
    • -
  • -
    • -
-
-
-
-
- -
-

test.test_dynamics

-

test transient cases and match against real world results

-

Functions

- - - - - - - - - - - - - - - -

f(x, t, y)

fit(t, a, b, w)

jac(t, a, b, w)

ls(x, t, y)

-

Classes

- - - - - - -

TestDynamics([methodName])

Create an instance of the class that will use the named test method when executed.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/test.test_dynamics_spaces.html b/docs/_build/html/_autosummary/test.test_dynamics_spaces.html deleted file mode 100644 index 426b969..0000000 --- a/docs/_build/html/_autosummary/test.test_dynamics_spaces.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - test.test_dynamics_spaces — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • test
    • -
  • test.test_dynamics_spaces
    • -
  • -
    • -
-
-
-
-
- -
-

test.test_dynamics_spaces

-

Classes

- - - - - - -

TestDynamics([methodName])

Create an instance of the class that will use the named test method when executed.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/test.test_four_bar.html b/docs/_build/html/_autosummary/test.test_four_bar.html deleted file mode 100644 index 2922601..0000000 --- a/docs/_build/html/_autosummary/test.test_four_bar.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - test.test_four_bar — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • test
    • -
  • test.test_four_bar
    • -
  • -
    • -
-
-
-
-
- -
-

test.test_four_bar

-

Classes

- - - - - - -

FourBar(*[, name, parent, ...])

Method generated by attrs for class FourBar.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/test.test_modules.html b/docs/_build/html/_autosummary/test.test_modules.html deleted file mode 100644 index 4ef7fff..0000000 --- a/docs/_build/html/_autosummary/test.test_modules.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - test.test_modules — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • test
    • -
  • test.test_modules
    • -
  • -
    • -
-
-
-
-
- -
-

test.test_modules

-

Classes

- - - - - - -

ImportTest([methodName])

We test the compilation of all included modules

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/test.test_performance.html b/docs/_build/html/_autosummary/test.test_performance.html deleted file mode 100644 index 569e04d..0000000 --- a/docs/_build/html/_autosummary/test.test_performance.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - - test.test_performance — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • test
    • -
  • test.test_performance
    • -
  • -
    • -
-
-
-
-
- -
-

test.test_performance

-

Functions

- - - - - - - - - -

eval_steady_state([dxdt])

test that the ss answer is equal to the result with damping

eval_transient([endtime, dt, run_solver])

test that the ss answer is equal to the result with damping

-

Classes

- - - - - - - - - -

PerfTest([name])

Initialize a filter.

TestPerformance([methodName])

Create an instance of the class that will use the named test method when executed.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/test.test_pipes.html b/docs/_build/html/_autosummary/test.test_pipes.html deleted file mode 100644 index bd392a0..0000000 --- a/docs/_build/html/_autosummary/test.test_pipes.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - test.test_pipes — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • test
    • -
  • test.test_pipes
    • -
  • -
    • -
-
-
-
-
- -
-

test.test_pipes

-

Classes

- - - - - - -

TestPipes([methodName])

Create an instance of the class that will use the named test method when executed.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/test.test_problem_deepscoping.html b/docs/_build/html/_autosummary/test.test_problem_deepscoping.html deleted file mode 100644 index 899347c..0000000 --- a/docs/_build/html/_autosummary/test.test_problem_deepscoping.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - - test.test_problem_deepscoping — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • test
    • -
  • test.test_problem_deepscoping
    • -
  • -
    • -
-
-
-
-
- -
-

test.test_problem_deepscoping

-

Functions

- - - - - - - - - - - - -

test_con(sys, prob)

test_obj(sys, prob)

test_zero(sys, prob)

-

Classes

- - - - - - - - - - - - - - - -

DeepComp(*[, name, comp, parent, val, comp_val])

Method generated by attrs for class DeepComp.

DeepSys(*[, name, comp, parent, ...])

Method generated by attrs for class DeepSys.

TestComp(*[, name, parent, val, comp_val])

Method generated by attrs for class TestComp.

TestDeep([methodName])

Create an instance of the class that will use the named test method when executed.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/test.test_slider_crank.html b/docs/_build/html/_autosummary/test.test_slider_crank.html deleted file mode 100644 index 365d0e8..0000000 --- a/docs/_build/html/_autosummary/test.test_slider_crank.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - - test.test_slider_crank — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • test
    • -
  • test.test_slider_crank
    • -
  • -
    • -
-
-
-
-
- -
-

test.test_slider_crank

-

Classes

- - - - - - -

TestSliderCrank([methodName])

Create an instance of the class that will use the named test method when executed.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/test.test_solver.html b/docs/_build/html/_autosummary/test.test_solver.html deleted file mode 100644 index abc3bbc..0000000 --- a/docs/_build/html/_autosummary/test.test_solver.html +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - - test.test_solver — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • test
    • -
  • test.test_solver
    • -
  • -
    • -
-
-
-
-
- -
-

test.test_solver

-

Classes

- - - - - - - - - -

SingleCompSolverTest([methodName])

Create an instance of the class that will use the named test method when executed.

SolverRefSelection([methodName])

Create an instance of the class that will use the named test method when executed.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_autosummary/test.test_tabulation.html b/docs/_build/html/_autosummary/test.test_tabulation.html deleted file mode 100644 index 2808fcf..0000000 --- a/docs/_build/html/_autosummary/test.test_tabulation.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - test.test_tabulation — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • test
    • -
  • test.test_tabulation
    • -
  • -
    • -
-
-
-
-
- -
-

test.test_tabulation

-

Classes

- - - - - - - - - - - - - - - -

Static(*[, name, parent, ...])

Method generated by attrs for class Static.

Test([methodName])

Create an instance of the class that will use the named test method when executed.

TestConfig(*[, name, parent, ...])

Method generated by attrs for class TestConfig.

TestStatic([methodName])

Create an instance of the class that will use the named test method when executed.

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_config.yml b/docs/_build/html/_config.yml deleted file mode 100644 index 72f81eb..0000000 --- a/docs/_build/html/_config.yml +++ /dev/null @@ -1,3 +0,0 @@ -theme: jekyll-theme-slate -title: Engforge -description: The Engineers Framework \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/analysis.html b/docs/_build/html/_modules/engforge/analysis.html deleted file mode 100644 index 0aa5633..0000000 --- a/docs/_build/html/_modules/engforge/analysis.html +++ /dev/null @@ -1,410 +0,0 @@ - - - - - - engforge.analysis — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.analysis

-import attr
-from engforge.configuration import forge, Configuration
-from engforge.components import Component
-from engforge.tabulation import TabulationMixin, DataframeMixin
-from engforge.system import System
-from engforge.typing import *
-from engforge.reporting import *
-from engforge.attr_plotting import PlottingMixin
-
-
-# import datetime
-import os
-from uuid import uuid4
-
-import random
-import attrs
-
-from contextlib import contextmanager
-import inspect
-
-import matplotlib.pylab as pylab
-
-list_check = attrs.validators.instance_of(list)
-
-
-

-[docs]
-def make_reporter_check(type_to_check):
-    def reporter_type_check(inst, attr, value):
-        if not isinstance(value, list):
-            raise ValueError("must be a list!")
-
-        if not all([isinstance(v, type_to_check) for v in value]):
-            raise ValueError("must be a list of type {value.__name__}!")
-
-    return reporter_type_check

-
-
-
-

-[docs]
-@forge
-class Analysis(Configuration, TabulationMixin, PlottingMixin, DataframeMixin):
-    """Analysis takes a system and many reporters, runs the system, adds its own system properties to the dataframe and post processes the results
-
-    make_plots() makes plots from the analysis, and stores figure
-    post_process()  but can be overriden
-    report_results() writes to reporters
-    """
-
-    # TODO: generate pdf with tables ect.
-
-    system: System = attrs.field()
-    table_reporters: list = attrs.field(
-        factory=list, validator=make_reporter_check(TableReporter)
-    )
-    plot_reporters: list = attrs.field(
-        factory=list, validator=make_reporter_check(PlotReporter)
-    )
-
-    _stored_plots: dict = attrs.field(factory=dict)
-    _uploaded = False
-
-    show_plots: bool = attrs.field(default=True)
-
-    @property
-    def uploaded(self):
-        return self._uploaded
-    
-
-

-[docs]
-    def run(self, *args, **kwargs):
-        """Analysis.run() passes inputs to the assigned system and saves data via the system.run(cb=callback), once complete `Analysis.post_process()` is run also being passed input arguments, then plots & reports are made"""
-        self.info(
-            f"running analysis {self.identity} with input {args} {kwargs}"
-        )
-        cb = lambda *args, **kw: self.system.last_context.save_data(force=True)
-        out = self.system.run(*args, **kwargs, cb=cb)
-        self.post_process(*args, **kwargs)
-
-        self._stored_plots = {}
-        self.make_plots(analysis=self, store_figures=self._stored_plots)
-        self.report_results()

-
-
-

-[docs]
-    def post_process(self, *args, **kwargs):
-        """A user customizeable function"""
-        pass

-
-
-    def report_results(self):
-        self.info(f"report results")
-
-        for tbl_reporter in self.table_reporters:
-            try:
-                tbl_reporter.upload(self)
-            except Exception as e:
-                self.error(e, "issue in {tbl_reporter}")
-
-        for plt_reporter in self.plot_reporters:
-            try:
-                plt_reporter.upload(self)
-            except Exception as e:
-                self.error(e, "issue in {plt_reporter}")
-
-        if self.show_plots:
-            self.info(f"showing plots {len(self.stored_plots)}")
-            for figkey, fig in self.stored_plots.items():
-                self.info(f"showing {figkey}")
-                try:
-                    fig.show()
-                except Exception as e:
-                    self.error(e, f"issue showing {figkey}")
-
-        self._uploaded = True
-
-    @property
-    def dataframe(self):
-        # TODO: join with analysis dataframe
-        return self.system.dataframe

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-    # Plotting & Report Methods:
-
-
-#     @property
-#     def _report_path(self):
-#         """Add some name options that work into ClientInfoMixin"""
-#
-#         if (
-#             self.namepath_mode == "both"
-#             and self.mode == "iterator"
-#             and isinstance(self.component_iterator, Component)
-#         ):
-#             return os.path.join(
-#                 self.namepath_root,
-#                 f"{self.name}",
-#                 f"{self.component_iterator.name}",
-#             )
-#         elif (
-#             self.namepath_mode == "iterator"
-#             and self.mode == "iterator"
-#             and isinstance(self.component_iterator, Component)
-#         ):
-#             return os.path.join(
-#                 self.namepath_root, f"{self.component_iterator.name}"
-#             )
-#         else:
-#             if self.name != "default":
-#                 return os.path.join(
-#                     self.namepath_root, f"{self.classname.lower()}_{self.name}"
-#                 )
-#             return os.path.join(self.namepath_root, f"{self.classname.lower()}")
-
-# @property
-# def component_iterator(self) -> ComponentIterator:
-#     """Override me!"""
-#     return self.iterator
-
-# def post_process(self):
-#     """override me!"""
-#     pass
-#
-#     def reset_analysis(self):
-#         self.reset_data()
-#         self._solved = False
-#         self.run_id = None
-
-#     def gsync_results(self, filename="Analysis", meta_tags=None):
-#         """Syncs All Variable Tables To The Cloud"""
-#         with self.drive.context(
-#             filepath_root=self.local_sync_path, sync_root=self.cloud_sync_path
-#         ) as gdrive:
-#             with self.drive.rate_limit_manager(
-#                 self.gsync_results, 6, filename=filename, meta_tags=meta_tags
-#             ):
-#                 old_sleep = gdrive._sleep_time
-#                 gdrive.reset_sleep_time(max(old_sleep, 1.0))
-#
-#                 gpath = gdrive.sync_path(self.local_sync_path)
-#
-#                 self.debug(f"saving as gsheets {gpath}")
-#                 parent_id = gdrive.get_gpath_id(gpath)
-#                 # TODO: delete old file if exists
-#
-#                 gdrive.sleep(12 * random.random())
-#
-#                 gdrive.cache_directory(parent_id)
-#                 gdrive.sleep()
-#
-#                 # Remove items with same name in parent dir
-#                 parent = gdrive.item_nodes[parent_id]
-#                 parent.remove_contents_with_title(filename)
-#
-#                 df = self.joined_dataframe
-#
-#                 # Make the new sheet
-#                 sht = gdrive.gsheets.create(filename, folder=parent_id)
-#                 gdrive.sleep(2 * (1 + gdrive.time_fuzz * random.random()))
-#
-#                 wk = sht.add_worksheet(filename)
-#                 gdrive.sleep(2 * (1 + gdrive.time_fuzz * random.random()))
-#
-#                 wk.rows = df.shape[0]
-#                 gdrive.sleep(2 * (1 + gdrive.time_fuzz * random.random()))
-#
-#                 wk.set_dataframe(df, start="A1", fit=True)
-#                 gdrive.sleep(2 * (1 + gdrive.time_fuzz * random.random()))
-#
-#                 for df_result in self.variable_tables:
-#                     df = df_result["df"]
-#                     conf = df_result["conf"]
-#
-#                     if meta_tags is not None and type(meta_tags) is dict:
-#                         for tag, value in meta_tags.items():
-#                             df[tag] = value
-#
-#                     gdrive.sleep(2 * (1 + gdrive.time_fuzz * random.random()))
-#                     wk = sht.add_worksheet(conf.displayname)
-#                     gdrive.sleep(2 * (1 + gdrive.time_fuzz * random.random()))
-#
-#                     wk.rows = df.shape[0]
-#                     gdrive.sleep(2 * (1 + gdrive.time_fuzz * random.random()))
-#
-#                     wk.set_dataframe(df, start="A1", fit=True)
-#                     gdrive.sleep(2 * (1 + gdrive.time_fuzz * random.random()))
-#
-#                 sht.del_worksheet(sht.sheet1)
-#                 gdrive.sleep(2 * (1 + gdrive.time_fuzz * random.random()))
-#
-#                 # TODO: add in dataframe dict with schema sheename: {dataframe,**other_args}
-#                 self.info(
-#                     "gsheet saved -> {}".format(os.path.join(gpath, filename))
-#                 )
-#
-#                 gdrive.reset_sleep_time(old_sleep)
-
-#     @property
-#     def columns(self):
-#         if self.solved:
-#             return list(self.joined_dataframe)
-#         else:
-#             return []
-#
-#     def plot(self, x, y, kind="line", **kwargs):
-#         """
-#         A wrapper for pandas dataframe.plot
-#         :param grid: set True if input is not False
-#         """
-#
-#         # TODO: Add a default x iterator for what is iterated in analysis!
-#
-#         if "grid" not in kwargs:
-#             kwargs["grid"] = True
-#
-#         if isinstance(y, (list, tuple)):
-#             old_y = set(y)
-#             y = list([yval for yval in y if yval in self.dataframe.columns])
-#             rmv_y = set.difference(old_y, set(y))
-#             if rmv_y:
-#                 self.warning(f"vars not found: {rmv_y}")
-#
-#         if self.solved and y:
-#             df = self.dataframe
-#             return df.plot(x=x, y=y, kind=kind, **kwargs)
-#         elif y:
-#             self.warning("not solved yet!")
-#         elif self.solved:
-#             self.warning("bad input!")
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/attr_dynamics.html b/docs/_build/html/_modules/engforge/attr_dynamics.html deleted file mode 100644 index 1299e7a..0000000 --- a/docs/_build/html/_modules/engforge/attr_dynamics.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - - engforge.attr_dynamics — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.attr_dynamics

-from engforge.attributes import ATTR_BASE, AttributeInstance
-
-import attrs, attr, uuid
-
-
-# Instance & Attribute definition for integration vars
-# Solver minimizes residual by changing independents
-

-[docs]
-class IntegratorInstance(AttributeInstance):
-    """A decoupled signal instance to perform operations on a system instance"""
-
-    system: "System"
-
-    # compiled info
-    var_ref: "Ref"
-    rate_ref: "Ref"
-
-    __slots__ = ["system", "solver", "var_ref", "rate_ref"]
-
-    def __init__(self, solver: "Time", system: "System") -> None:
-        self.class_attr = self.solver = solver
-        self.system = system
-        self.compile()
-
-    def compile(self):
-        self.var_ref = self.system.locate_ref(self.solver.var)
-        self.rate_ref = self.system.locate_ref(self.solver.rate)
-        self.system.debug(f"integrating {self.var_ref} with {self.rate_ref}")
-
-    def as_ref_dict(self):
-        return {'rate':self.rate_ref,'var':self.var_ref}
-    
-    @property
-    def rates(self):
-        return {self.name: self.class_attr.rate}
-    
-    @property
-    def integrated(self):
-        return {self.name: self.class_attr.var}
-
-    @property
-    def var(self):
-        return self.class_attr.var
-    
-    @property
-    def rate(self):
-        return self.class_attr.rate
-    
-    @property
-    def current_rate(self):
-        return self.rate_ref.value(self.system, self.system.last_context)
-    
-    @property
-    def constraint_refs(self):
-        if self.solver.slvtype in ["eq","ineq"]:
-            return self.const_f
-        return None
-
-    @property
-    def constraints(self):
-        if hasattr(self,'_constraints'):
-            return self._constraints
-        
-        return self.solver.constraints
-    
-        # return [{'type':self.slvtype,'var':self.solver.lhs,'value':self.const_f}]
-        # if self.solver.slvtype in ['var','obj']:
-        #    return self.solver.constraints
-        #else:
-            #just me
-        
-        
-
-    @property
-    def slvtype(self):
-        return self.solver.slvtype
-    
-    @property
-    def combos(self):
-        return self.solver.combos
-    
-    @property
-    def normalize(self):
-        return self.solver.normalize
-    
-    @property
-    def active(self):
-        if hasattr(self,'_active'):
-            return self._active         

-
-
-
-#TODO: depriciate modes and update for dynamicmixin strategies
-#TODO: add Time.add_profile(parm, time:parameter_values, combos,active) to add a transient profile to be run on the system that is selectable by the user
-
-

-[docs]
-class Time(ATTR_BASE):
-    """Transient is a base class for integrators over time"""
-
-    mode: str
-    var: str
-    rate: str
-    constraints:list
-    allow_constraint_override: bool = True
-    instance_class = IntegratorInstance
-
-

-[docs]
-    @classmethod
-    def integrate(
-        cls,
-        var: str,
-        rate: "system_property",
-        mode: str = "euler",
-        active=True,
-        combos='default'
-    ):
-        """Defines an ODE like integrator that will be integrated over time with the defined integration rule.
-
-        Input should be of strings to look up the particular property or field
-        """
-        # Create A New Signals Class
-        new_name = f"TRANSIENT_{mode}_{var}_{rate}".replace(
-            ".", "_"
-        )
-        #new_name = new_name
-        new_dict = dict(
-            mode=mode,
-            name=new_name,
-            var=var,
-            rate=rate,
-            active=active,
-            constraints=[], #TODO: parse kwargs for limits
-            combos=cls.process_combos(combos,add_combos=f'time,{var}')
-        )
-        return cls._setup_cls(new_name, new_dict)

-
-
-    # make define the same as integrate
-    # @classmethod
-    # def subcls_compile(cls,**kwargs):
-    #     cls.define = cls.integrate
-
-

-[docs]
-    @classmethod
-    def class_validate(cls, instance, **kwargs):
-        from engforge.properties import system_property
-        from engforge.solver import SolveableMixin
-
-        system = cls.config_cls
-        assert issubclass(system, SolveableMixin), f"must be a solveable system"
-
-        var_type = instance.locate(cls.var)
-        if var_type is None:
-            raise Exception(f"var not found: {cls.var}")
-        assert isinstance(
-            var_type, attrs.Attribute
-        ), f"bad var {cls.var} not attribute: {var_type}"
-        assert var_type.type in (
-            int,
-            float,
-        ), f"bad var {cls.var} not numeric"
-
-        driv_type = instance.locate(cls.rate)
-        if driv_type is None:
-            raise Exception(f"rate not found: {cls.rate}")
-        assert isinstance(
-            driv_type, (system_property, attrs.Attribute)
-        ), f"bad rate {cls.rate} type: {driv_type}"
-        if isinstance(driv_type, system_property):
-            assert driv_type.return_type in (
-                int,
-                float,
-            ), f"bad var {cls.rate} not numeric"

-
-
-        # else: attributes are not checked, youre in command
-
-

-[docs]
-    @classmethod
-    def add_var_constraint(cls, value, kind="min",**kwargs):
-        """adds a `type` constraint to the solver. If value is numeric it is used as a bound with `scipy` optimize.
-
-        :param type: str, must be either min or max with var value comparison, or with a function additionally eq,ineq (same as max(0)) can be used
-        :value: either a numeric (int,float), or a function, f(system)
-        """
-        assert cls is not Time, f"must set constraint on Time Attribute"
-        # assert not cls.constraint_exists(type=kind,var=var), f"constraint already exists!"
-        assert isinstance(value, (int, float)) or callable(
-            value
-        ), f"only int,float or callables allow. Callables must take system as argument"
-
-        var = cls.var
-        assert var is not None, "must provide var on non-var solvers"
-        assert kind in ("min", "max")
-        combo_dflt = "default,lim"
-        cmbs = kwargs.get("combos",'')
-        combos = cls.process_combos(cmbs,combo_dflt,combo_dflt)
-        if isinstance(combos,str):
-            combos = combos.split(',')
-        active = kwargs.get("active", True)
-        const = {"type": kind, "value": value, "var": var, "active": active, "combos": combos, 'combo_var':cls.name}
-        #print(const,cls.__dict__)
-
-        cinx = cls.constraint_exists(type=kind, var=var)
-        inix = cinx is not None
-        if cls.allow_constraint_override and inix:
-            #print(f'replacing constraint {cinx} with {kind} {value} {var}')
-            constraint = cls.constraints[cinx]
-            constraint.update(const)
-        elif not cls.allow_constraint_override and inix:
-            cnx = cls.constraints[cinx]
-            raise Exception(f"constraint already exists! {cnx}")
-        else:
-            cls.constraints.append(const)

-
-
-

-[docs]
-    @classmethod
-    def constraint_exists(cls, **kw):
-        """check constraints on the system, return its index position if found, else None."""
-        for i, c in enumerate(cls.constraints):
-            if all([c[k] == v for k, v in kw.items()]):
-                return i
-        return None

-

-
-
-
-
-# Support Previous API
-TRANSIENT = Time
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/attr_plotting.html b/docs/_build/html/_modules/engforge/attr_plotting.html deleted file mode 100644 index 0833e74..0000000 --- a/docs/_build/html/_modules/engforge/attr_plotting.html +++ /dev/null @@ -1,1009 +0,0 @@ - - - - - - engforge.attr_plotting — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.attr_plotting

-"""This module defines Plot and Trace methods that allow the plotting of Statistical & Transient relationships of data in each system
-"""
-
-
-import attrs
-import uuid
-import numpy as np
-import seaborn as sns
-import matplotlib.pylab as pylab
-from matplotlib.font_manager import get_font_names
-import inspect
-
-import typing
-
-# from engforge.configuration import forge
-from engforge.properties import *
-from engforge.logging import LoggingMixin
-from engforge.env_var import EnvVariable
-from engforge.attributes import ATTR_BASE, AttributeInstance
-from matplotlib.backends.backend_pdf import PdfPages
-
-
-

-[docs]
-class PlotLog(LoggingMixin):
-    pass

-
-
-
-log = PlotLog()
-
-# Seaborn Config Options
-SEABORN_CONTEXTS = ["paper", "talk", "poster", "notebook"]
-SEABORN_THEMES = ["darkgrid", "whitegrid", "dark", "white", "ticks"]
-
-
-

-[docs]
-def conv_ctx(ctx):
-    if ctx.lower() not in SEABORN_CONTEXTS:
-        raise ValueError(f"theme must be one of {SEABORN_CONTEXTS}")
-    return ctx.lower()

-
-
-
-

-[docs]
-def conv_theme(theme):
-    if theme.lower() not in SEABORN_THEMES:
-        raise ValueError(f"theme must be one of {SEABORN_THEMES}")
-    return theme.lower()

-
-
-
-# Color Maps
-SEABORN_COLORMAPS = ["deep", "musted", "bright", "pastel", "dark", "colorblind"]
-SEABORN_COLORMAPS += list(pylab.colormaps.keys())
-SEABORN_COLORMAPS += ["husl", "hls"]
-# TODO: handle other seaboorn options
-
-
-

-[docs]
-def conv_maps(map):
-    if map.lower() not in SEABORN_COLORMAPS:
-        raise ValueError(f"theme must be one of {SEABORN_COLORMAPS}")
-    return str(map.lower())

-
-
-
-# SEABORN_FONTS = get_font_names()
-# FONT_INX_LC = {k.lower():k for k in SEABORN_FONTS}
-# def conv_font(fnt):
-#     if fnt.lower() not in FONT_INX_LC:
-#         raise ValueError(f'theme must be one of {SEABORN_FONTS}')
-#     act = FONT_INX_LC[str(fnt).lower()]
-#     return act
-
-
-# Seaborn Config Via Env Var
-_def_opts = {"obscure": False, "dontovrride": True}
-SEABORN_CONTEXT = EnvVariable(
-    "SEABORN_CONTEXT",
-    default="paper",
-    type_conv=conv_ctx,
-    desc=f"choose one of: {SEABORN_CONTEXTS}",
-    **_def_opts,
-)
-SEABORN_THEME = EnvVariable(
-    "SEABORN_THEME",
-    default="darkgrid",
-    type_conv=conv_theme,
-    desc=f"choose one of: {SEABORN_THEMES}",
-    **_def_opts,
-)
-SEABORN_PALETTE = EnvVariable(
-    "SEABORN_PALETTE",
-    default="deep",
-    type_conv=conv_maps,
-    desc=f"choose one of: {SEABORN_COLORMAPS}",
-    **_def_opts,
-)
-
-# Figure Saving Config
-# FIGURE_SAVE = EnvVariable(
-#    ""
-# )
-
-# TODO: fonts are platform dependent :(
-# SEABORN_FONT = EnvVariable('SEABORN_FONT',default='sans-serif',**_def_opts)
-
-# Staistical View Through Seaborn:
-# takes a dataframe and displays it via several types of statisical views, the default is `relplot.scatterplot` to show first order trends.
-PLOT_KINDS = {
-    "displot": ("histplot", "kdeplot", "ecdfplot", "rugplot"),
-    "relplot": ("scatterplot", "lineplot"),
-    "catplot": (
-        "stripplot",
-        "swarmplot",
-        "boxplot",
-        "violinplot",
-        "pointplot",
-        "barplot",
-    ),
-}
-
-
-# Install Seaborn Themes
-

-[docs]
-def install_seaborn(rc_override=None, **kwargs):
-    default = dict(
-        context=SEABORN_CONTEXT.secret,
-        style=SEABORN_THEME.secret,
-        palette=SEABORN_PALETTE.secret,
-    )
-    default.update(**kwargs)
-
-    if rc_override:
-        sns.set_theme(**default, rc=rc_override)
-    else:
-        sns.set_theme(**default)

-
-
-
-install_seaborn()
-
-
-

-[docs]
-def save_all_figures_to_pdf(
-    filename, figs=None, dpi=200, close=True, pdf=None, return_pdf=False
-):
-    """
-    Save all figures to a PDF file.
-
-    :param filename: The name of the PDF file to save.
-    :param figs: List of figures to save. If None, all open figures will be saved.
-    :param dpi: The resolution of the saved figures in dots per inch.
-    :param close: Whether to close all figures after saving.
-    :param pdf: An existing PdfPages object to append the figures to. If None, a new PdfPages object will be created.
-    :param return_pdf: Whether to return the PdfPages object after saving.
-    :return: The PdfPages object if return_pdf is True, else None.
-    :rtype: PdfPages or None
-    """
-    if pdf is None:
-        pp = PdfPages(filename)
-    else:
-        pp = pdf
-
-    if figs is None:
-        figs = [pylab.figure(n) for n in pylab.get_fignums()]
-
-    for fig in figs:
-        fig.savefig(pp, format="pdf", dpi=dpi)
-
-    if close:
-        pylab.close("all")
-    if return_pdf:
-        return pp
-    else:
-        pp.close()  # Don't keep the PDF file open

-
-
-
-

-[docs]
-class PlottingMixin:
-    """Inherited by Systems and Analyses to provide common interface for plotting"""
-
-    _stored_plots: dict
-
-    @instance_cached
-    def plots(self):
-        return {k: getattr(self, k) for k in self.plot_attributes()}
-
-    @property
-    def stored_plots(self):
-        if not hasattr(self, "_stored_plots"):
-            self._stored_plots = {}
-        return self._stored_plots
-
-    @instance_cached
-    def traces(self):
-        if not self.transients_attributes():
-            return {}  # not a transient system
-        return {k: getattr(self, k) for k in self.trace_attributes()}
-
-

-[docs]
-    def make_plots(
-        self, analysis: "Analysis" = None, store_figures: bool = True, pre=None
-    ):
-        """makes plots and traces of all on this instance, and if a system is
-        subsystems. Analysis should call make plots however it can be called on a system as well
-        :param analysis: the analysis that has triggered this plot
-        :param store_figure: a boolean or dict, if neither a dictionary will be created and returend from this function
-        :returns: the dictionary from store_figures logic
-        """
-        if not pre:
-            pre = f"{self.classname}"
-        else:
-            pre = f"{pre}.{self.classname}"
-
-        if analysis and store_figures is True:
-            imgstore = analysis._stored_plots
-        elif store_figures == True:
-            imgstore = {}  # gotta store somewhere
-        elif isinstance(store_figures, dict):
-            imgstore = store_figures
-        else:
-            imgstore = None
-
-        # Announce
-        log.info(f"Plotting {pre}")
-
-        # Traces
-        for plotnm, plot in self.plots.items():
-            try:
-                log.info(f"{self.identity} plotting {pre}.{plotnm} | {plot}")
-                fig, ax = plot()
-                if isinstance(fig, pylab.Figure):
-                    pylab.close(fig)
-                if imgstore is not None:
-                    imgstore[f"{pre}.{plotnm}"] = fig
-            except Exception as e:
-                log.error(e, f"issue in plot {plot}")
-
-        # Traces
-        for plotnm, plot in self.traces.items():
-            try:
-                log.info(f"{self.identity} tracing {pre}.{plotnm} | {plot}")
-                fig, ax = plot()
-                if isinstance(fig, pylab.Figure):
-                    pylab.close(fig)
-                if imgstore is not None:
-                    imgstore[f"{pre}.{plotnm}"] = fig
-            except Exception as e:
-                log.error(e, f"issue in trace {plot}")
-
-        # Sub Systems
-        for confnm, conf in self.internal_configurations().items():
-            if isinstance(conf, PlottingMixin):
-                log.info(f"{self.identity} system plotting {confnm} | {conf}")
-                conf.make_plots(analysis, store_figures=store_figures, pre=pre)
-
-        return imgstore

-

-
-
-
-

-[docs]
-class PlotInstance(AttributeInstance):
-    """combine plotclass vars with system info"""
-
-    plot_cls: "Plot"
-    system: "System"
-
-    refs = None
-
-    def __init__(self, system: "System", plot_cls: "Plot"):
-        self.plot_cls = plot_cls
-        self.system = system
-
-        
-        _sys_refs = self.system.system_references()
-        sys_refs = {k:v for atr,grp in _sys_refs.items() for k,v in grp.items()}
-
-        diff = set()
-        varss = set()
-        for k, vers in self.plot_cls.plot_vars().items():
-            if isinstance(vers, list):
-                for v in vers:
-                    if v not in sys_refs:
-                        diff.add(v)
-                    else:
-                        varss.add(v)
-            elif vers not in sys_refs:
-                diff.add(vers)
-            else:
-                varss.add(vers)
-
-        if self.system.log_level < 10:
-            log.debug(f"system references: {sys_refs}")
-            if diff:
-                log.warning(f"has diff {diff}| found: {varss}| possible: {sys_refs}")
-
-        if diff:
-            #raise KeyError(f"has system diff: {diff} found: {vars}| from: {sys_ref}")
-            log.warning(f"has system diff: {diff} found: {vars}| from: {sys_refs}")
-
-        self.refs = {k: sys_refs[k] for k in varss}
-
-

-[docs]
-    def plot(self, **kwargs):
-        """applies the system dataframe to the plot"""
-        return self(**kwargs)

-
-        
-
-

-[docs]
-    def __call__(self, **override_kw):
-        """
-        method allowing a similar type.kind(**override_kw,**default) (ie. relplot.scatterplot(x=different var))
-        #TODO: override strategy
-        """
-        if not self.system.solved:
-            raise ValueError(f"not solved yet!")
-
-        PC = self.plot_cls
-        f = self.plot_cls.plot_func
-
-        # Defaults
-        args = PC.plot_vars()
-        if hasattr(PC, "kind"):
-            args["kind"] = kind = PC.kind.replace("plot", "")
-
-        # these go in plot
-        extra = PC.plot_extra()
-
-        # Parse title
-        title = self.plot_cls.title
-        if "title" in override_kw:
-            title = override_kw.pop("title")
-
-        # Announce Override
-        if override_kw:
-            log.debug(f"overriding vars {override_kw}")
-            args.update(**override_kw)
-
-        log.info(
-            f"plotting {self.system.identity}| {self.identity} with {args}"
-        )
-        fig = ax = f(data=self.system.dataframe, **args, **extra)
-
-        return self.process_fig(fig, title)

-
-
-    def process_fig(self, fig, title):
-        if isinstance(fig, pylab.Axes):
-            ax = fig
-            fig = fig.fig
-        elif isinstance(fig, sns.FacetGrid):
-            ax = fig
-            fig = fig.fig
-        else:
-            ax = fig
-
-        # Polish Fig Args
-        if title:
-            fig.subplots_adjust(top=0.9)
-            fig.suptitle(title)
-
-        return fig, ax
-
-    @property
-    def identity(self) -> str:
-        return f"{self.plot_cls.type}.{self.plot_cls.kind}"

-
-
-
-

-[docs]
-class PlotBase(ATTR_BASE):
-    """base class for plot attributes"""
-
-    name: str
-    config_cls: "System"
-    title: str = None
-    kind: str
-    cls_vars = {"x", "y"}
-    instance_class = PlotInstance
-
-

-[docs]
-    @classmethod
-    def plot_vars(cls) -> dict:
-        """gathers seaborn plot vars that will scope from system.dataframe"""
-        p = {}
-        p["x"] = cls.x
-        p["y"] = cls.y
-        if cls.hue:
-            p["hue"] = cls.hue
-        if cls.col:
-            p["col"] = cls.col
-        if cls.row:
-            p["row"] = cls.row
-
-        # Add the options
-        var_opts = cls.type_var_options[cls.type]
-        for k, arg in cls.plot_args.items():
-            if k in var_opts:
-                p[k] = arg
-        return p

-
-
-    @classmethod
-    def plot_extra(cls):
-        plot_vars = cls.plot_vars()
-        out = {}
-        for k, arg in cls.plot_args.items():
-            if k not in plot_vars:
-                out[k] = arg
-        return out
-
-

-[docs]
-    @classmethod
-    def validate_plot_args(cls, system: "System"):
-        """Checks system.system_references that cls.plot_vars exists"""
-        log.info(f"validating: {system}")
-        sys_ref = system.system_references()
-        attr_keys = set(sys_ref["attributes"].keys())
-        prop_keys = set(sys_ref["properties"].keys())
-        valid = attr_keys.union(prop_keys)
-
-        diff = set()
-        for k, vers in cls.plot_vars().items():
-            if isinstance(vers, list):
-                for v in vers:
-                    if v not in valid:
-                        diff.add(v)
-            elif vers not in valid:
-                diff.add(vers)
-
-        if log.log_level <= 10:
-            log.debug(
-                f"{cls.__name__} has vars: {attr_keys} and bad input: {diff}"
-            )
-
-        if diff:
-            log.warning(f"bad plot vars: {diff} do not exist in system: {valid}")

-
-            #TODO: fix time being defined on components
-            # raise KeyError(
-            #     f"bad plot vars: {diff} do not exist in system: {valid}"
-            # )
-
-    
-

-[docs]
-    @classmethod
-    def handle_instance(cls,canidate):
-        """no interacion with system, reporing only"""
-        return None

-
-
-

-[docs]
-    @classmethod
-    def create_instance(cls, system: "System") -> PlotInstance:
-        cls.validate_plot_args(system)
-        return PlotInstance(system, cls)

-

-
-
-
-trace_type = typing.Union[str, list]
-
-
-

-[docs]
-class TraceInstance(PlotInstance):
-    @classmethod
-    def plot_extra(cls) -> dict:
-        return cls.plot_cls.extra_args
-
-

-[docs]
-    def __call__(self, **override_kw):
-        """
-        method allowing a similar type.kind(**override_kw,**default) (ie. relplot.scatterplot(x=different var))
-        #TODO: override strategy
-        """
-        if not self.system.solved:
-            raise ValueError(f"not solved yet!")
-
-        PC = self.plot_cls
-
-        type = PC.type
-        types = self.plot_cls.types
-        if "type" in override_kw and override_kw["type"] in types:
-            type = override_kw.pop("type")
-        elif "type" in override_kw:
-            raise KeyError(f"invalid trace type, must be in {types}")
-
-        if type == "scatter":
-            f = lambda ax, *args, **kwargs: ax.scatter(*args, **kwargs)
-        elif type == "line":
-            f = lambda ax, *args, **kwargs: ax.plot(*args, **kwargs)
-
-        # Defaults
-        args = PC.plot_args.copy()
-
-        # these go in plot
-        extra = PC.plot_extra()
-
-        # Parse title
-        title = PC.title
-        if "title" in override_kw:
-            title = override_kw.pop("title")
-
-        # Announce Override
-        if override_kw:
-            log.debug(f"overriding vars {override_kw}")
-            args.update(**override_kw)
-
-        log.info(
-            f"plotting {self.system.identity}| {self.identity} with {args}"
-        )
-
-        # PLOTTING
-        # Make the axes and plot
-        # Get The MVPS
-        x = args.pop("x")
-        if "x" in override_kw:
-            x = override_kw["x"]
-        y = args.pop("y")
-        if "y" in override_kw:
-            y = override_kw["y"]
-        if not isinstance(y, list):
-            y = list(y)
-
-        # secondary plot
-        if "y2" in args and args["y2"]:
-            y2 = args.pop("y2")
-            if "y2" in override_kw:
-                y2 = override_kw["y2"]
-            if y2 is None:
-                y2 = []
-            elif not isinstance(y2, list):
-                y2 = list(y2)
-        else:
-            y2 = []
-
-        # TODO: insert marker, color ect per group, ensure no overlap
-        fig, axes = pylab.subplots(2 if y2 else 1, 1)
-        if y2:
-            ax, ax2 = axes[0], axes[1]
-        else:
-            ax = axes
-            ax2 = None
-
-        # Loop over y1
-        yleg = []
-        for y in y:
-            f(ax, x, y, data=self.system.dataframe, label=y, **args, **extra)
-        else:
-            # The only specificity of the code is when plotting the legend
-            h, l = np.hstack(
-                [
-                    l.get_legend_handles_labels()
-                    for l in ax.figure.axes
-                    if l.bbox.bounds == ax.bbox.bounds
-                ]
-            ).tolist()
-            ax.legend(handles=h, labels=l, loc="upper right")
-
-        # Loop over y2
-        for y in y2:
-            f(ax2, x, y, data=self.system.dataframe, label=y, **args, **extra)
-        else:
-            # The only specificity of the code is when plotting the legend
-            h, l = np.hstack(
-                [
-                    l.get_legend_handles_labels()
-                    for l in ax2.figure.axes
-                    if l.bbox.bounds == ax2.bbox.bounds
-                ]
-            ).tolist()
-            ax2.legend(handles=h, labels=l, loc="upper right")
-
-        return self.process_fig(fig, title)

-

-
-
-
-

-[docs]
-class Trace(PlotBase):
-    """trace is a plot for transients, with y and y2 axes which can have multiple vars each"""
-
-    types = ["scatter", "line"]
-    type = "scatter"
-    instance_class = TraceInstance
-
-    # mainem
-    y2: trace_type
-    y: trace_type
-    x: str
-
-    plot_args: dict
-    extra_args: dict
-
-    # Extended vars per option
-    type_var_options = {
-        "scatter": ("size", "color"),
-        "line": ("color", "marker", "linestyle"),
-    }
-
-    type_options = {
-        "scatter": ("vmax", "vmin", "marker", "alpha", "cmap"),
-        "line": ("linewidth",),
-    }
-    all_options = (
-        "xlabel",
-        "ylabel",
-        "y2label",
-        "title",
-        "xticks",
-        "yticks",
-        "alpha",
-    )
-
-    always = ("x", "y", "y2")
-
-

-[docs]
-    @classmethod
-    def define(
-        cls, x="time", y: trace_type = None, y2=None, kind="line", **kwargs
-    ):
-        """Defines a plot that will be matplotlib, with validation happening as much as possible in the define method
-
-        #Plot Choice
-        :param kind: specify the kind of type of plot scatter or line, with the default being line
-
-        # Dependents & Independents:
-        :param x: the x var for each plot, by default 'time'
-        :param y: the y var for each plot, required
-        :param y2: the y2 var for each plot, optional
-
-        # Additional Parameters:
-        :param title: this title will be applied to the figure.suptitle()
-        :param xlabel: the x label, by default the capitalized var
-        :param ylabel: the x label, by default the capitalized var
-        :param y2label: the x label, by default the capitalized var
-        """
-
-        if x is None or y is None:
-            raise ValueError(f"x and y must both be input")
-
-        if not isinstance(x, str):
-            raise ValueError(f"x must be string")
-
-        if not isinstance(y, (list, str)):
-            raise ValueError(f"y must be string or list")
-
-        if not any([y2 is None, isinstance(y2, (list, str))]):
-            raise ValueError(f"y2 must be string or list")
-
-        # Validate Plot
-        assert kind in cls.types, f"invalid kind not in {cls.types}"
-        if kind == "line":
-            pfunc = pylab.plot
-        elif kind == "scatter":
-            pfunc = pylab.scatter
-        else:
-            raise KeyError(f"bad plot kind: {kind}")
-
-        # Remove special args
-        title = None
-        if "title" in kwargs:
-            title = kwargs.pop("title")
-
-        # Remove special args
-        non_var_args = cls.valid_non_vars(kind)
-        var_args = cls.valid_vars_options(kind)
-        extra = {}
-
-        for k in list(kwargs.keys()):
-            if k in non_var_args:
-                extra[k] = kwargs.pop(k)
-
-        # Validate Args
-        assert set(kwargs).issubset(var_args), f"invalid plot args {kwargs}"
-        plot_args = kwargs
-        plot_args["x"] = x
-        plot_args["y"] = y
-
-        if "y2":
-            plot_args["y2"] = y2
-
-        log.info(f"adding Trace|{kind} {x},{y},{y2},{kwargs}")
-
-        # Create A New Signals Class
-        new_name = f"Trace_x_{x}_y_{y}".replace(
-            ".", "_"
-        ).replace("-", "")
-        new_dict = dict(
-            name=new_name,
-            x=x,
-            y=y,
-            y2=y2,
-            plot_func=pfunc,
-            plot_args=plot_args,
-            extra_args=extra,
-            title=title,
-            kind=kind,
-        )
-        new_plot = cls._setup_cls(new_name, new_dict)
-        return new_plot

-
-
-    @classmethod
-    def valid_non_vars(cls, type) -> set:
-        s = set(cls.all_options)
-        s = s.union(set(cls.type_options[type]))
-        return s
-
-    @classmethod
-    def valid_vars_options(cls, type) -> set:
-        s = set(cls.always)
-        s = s.union(set(cls.type_var_options[type]))
-        return s
-
-

-[docs]
-    @classmethod
-    def plot_vars(cls) -> set:
-        pa = cls.plot_args.copy()
-
-        y1 = pa.pop("y")
-        c = set()
-        if isinstance(y1, list):
-            for y in y1:
-                c.add(y)
-        else:
-            c.add(y1)
-        pa["y"] = list(c)
-
-        if "y2" in c:
-            c = set()
-            y2 = pa.pop("y2")
-            if isinstance(y2, list):
-                for y in y2:
-                    c.add(y)
-            else:
-                c.add(y2)
-
-            pa["y2"] = list(c)
-        return pa

-

-
-
-
-

-[docs]
-class Plot(PlotBase):
-    """Plot is a conveinence method"""
-
-    types: tuple = ("displot", "relplot", "catplot")
-    std_fields: tuple = ("x", "y", "col", "hue", "row")
-
-    # These options must be filled out
-    type: str
-    kind: str
-    x: str
-    y: str
-
-    # optional, must be var
-    hue: str
-    col: str
-    row: str
-
-    # Extended vars per option
-    type_var_options = {
-        "displot": (),
-        "relplot": ("style", "shape"),
-        "catplot": (),
-    }
-
-    # These capture the function and extra keywords
-    plot_func: None
-    plot_args: dict
-
-

-[docs]
-    @classmethod
-    def define(
-        cls,
-        x,
-        y,
-        _type="relplot",
-        kind="scatterplot",
-        row=None,
-        col=None,
-        hue=None,
-        **kwargs,
-    ):
-        """Defines a plot that will be rendered in seaborn, with validation happening as much as possible in the define method
-
-        #Plot Choice
-        :param _type: the type of seaborn plot (relplot,displot,catplot)
-        :param kind: specify the kind of type of plot (ie. scatterplot of relplot)
-
-        # Dependents & Independents:
-        :param x: the x var for each plot
-        :param y: the y var for each plot
-
-        # Additional Parameters:
-        :param row: create a grid of data with row var
-        :param col: create a grid of data with column var
-        :param hue: provide an additional dimension of color based on this var
-        :param title: this title will be applied to the figure.suptitle()
-        """
-
-        # Validate Plot
-        assert (
-            _type in PLOT_KINDS
-        ), f"type {_type} must be in {PLOT_KINDS.keys()}"
-        kinds = PLOT_KINDS[_type]
-        assert kind in kinds, f"plot kind {kind} not in {kinds}"
-
-        # Remove special args
-        title = None
-        if "title" in kwargs:
-            title = kwargs.pop("title")
-
-        # Validate Args
-        pfunc = getattr(sns, _type)
-        kfunc = getattr(sns, kind)
-        args = set(inspect.signature(kfunc).parameters.keys())
-        assert set(kwargs).issubset(args), f"only {args} allowed for kw"
-        plot_args = kwargs
-
-        log.info(
-            f"adding PLOT|{_type}.{kind}({x},{y},hue={hue},c:[{col}],r:[{row}],{kwargs}"
-        )
-
-        # Create A New Signals Class
-        new_name = f"PLOT_x_{x}_y_{y}".replace(
-            ".", "_"
-        ).replace("-", "")
-        new_dict = dict(
-            name=new_name,
-            x=x,
-            y=y,
-            hue=hue,
-            row=row,
-            col=col,
-            type=_type,
-            kind=kind,
-            plot_func=pfunc,
-            plot_args=plot_args,
-            title=title,
-        )
-        new_plot = cls._setup_cls(new_name, new_dict)
-        return new_plot

-
-
-

-[docs]
-    @classmethod
-    def plot_vars(cls) -> dict:
-        """gathers seaborn plot vars that will scope from system.dataframe"""
-        p = {}
-        p["x"] = cls.x
-        p["y"] = cls.y
-        if cls.hue:
-            p["hue"] = cls.hue
-        if cls.col:
-            p["col"] = cls.col
-        if cls.row:
-            p["row"] = cls.row
-
-        # Add the options
-        var_opts = cls.type_var_options[cls.type]
-        for k, arg in cls.plot_args.items():
-            if k in var_opts:
-                p[k] = arg
-        return p

-

-
-
-
-### Support Previous API
-PLOT = Plot
-Trace = Trace
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/attr_signals.html b/docs/_build/html/_modules/engforge/attr_signals.html deleted file mode 100644 index 7d5ffed..0000000 --- a/docs/_build/html/_modules/engforge/attr_signals.html +++ /dev/null @@ -1,239 +0,0 @@ - - - - - - engforge.attr_signals — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.attr_signals

-"""This module defines the slot attrs attribute to define the update behavior of a component or between components in an analysis"""
-"""Signals define data flow in the solver system. These updates can happen before or after a solver execution as defined in SolverMixin
-
-"""
-
-
-import attrs, uuid
-from engforge.attributes import ATTR_BASE, AttributeInstance, DEFAULT_COMBO
-from engforge.attr_slots import SLOT_TYPES
-
-VALID_MODES = ["pre", "post", "both"]
-
-
-

-[docs]
-class SignalInstance(AttributeInstance):
-    """A decoupled signal instance to perform operations on a system instance"""
-
-    system: "System"
-    signal: "Signal"
-
-    # compiled info
-    target: "Ref"
-    source: "Ref"
-    class_attr: "Signal"
-
-    def __init__(self, signal, system) -> None:
-        self.class_attr = self.signal = signal
-        self.system = system
-        self.compile()
-
-    def compile(self, **kwargs):
-        self.source = self.system.locate_ref(self.signal.source)
-        self.target = self.system.locate_ref(self.signal.target)
-        self.system.debug(f"SIGNAL| setting {self.target} with {self.source}")
-
-

-[docs]
-    def apply(self):
-        """sets `target` from `source`"""
-        val = self.source.value()
-        if self.system.log_level < 10:
-            self.system.msg(
-                f"Signal| applying {self.source}|{val} to {self.target}"
-            )
-        self.target.set_value(val)

-
-
-    @property
-    def mode(self) -> str:
-        return self.signal.mode
-    
-    def as_ref_dict(self)->dict:
-        return dict(
-            target=self.target,
-            source=self.source,
-            signal=self,
-        )
-    
-    def get_alias(self,path):
-        return path.split('.')[-1]    

-
-
-
-

-[docs]
-class Signal(ATTR_BASE):
-    """A base class that handles initalization in the attrs meta class scheme by ultimately createing a SignalInstance"""
-
-    name: str
-    mode: str
-    target: str
-    source: str
-    config_cls: "System"
-    attr_prefix = "SIGNAL"
-    instance_class = SignalInstance
-
-

-[docs]
-    @classmethod
-    def define(cls, target: str, source: str, mode="pre",**kw):
-        """taking a component or system class as possible input valid input is later validated as an instance of that class or subclass"""
-        assert mode in VALID_MODES, f"invalid mode: {mode}"
-
-        active = kw.get("active", True)
-        combo_dflt = 'default,signals'
-        combos = kw.get("combos",None)
-
-        # Create A New Signals Class
-        new_name = f"Signal_{mode}_{source}_to_{target}".replace(".", "_")
-        new_name = new_name + "_" + str(uuid.uuid4()).replace("-", "")[0:16]
-        new_dict = dict(
-            name=new_name,
-            mode=mode,
-            target=target,
-            source=source,
-            active=active,
-            combos=cls.process_combos(combos,combo_dflt,combo_dflt),
-            default_options=cls.default_options.copy(),
-        )
-        new_slot = type(new_name, (Signal,), new_dict)
-        new_slot.default_options["default"] = new_slot.make_factory()
-        new_slot.default_options["validator"] = new_slot.configure_instance
-        new_sig = cls._setup_cls(new_name, new_dict)
-        return new_sig

-
-
-    # FIXME: move to
-

-[docs]
-    @classmethod
-    def class_validate(cls, instance, **kwargs):
-        from engforge.properties import system_property
-
-        system = cls.config_cls
-
-        var_type = system.locate(cls.target)
-        if var_type is None:
-            raise Exception(f"target not found: {cls.target}")
-        assert isinstance(
-            var_type, attrs.Attribute
-        ), f"bad var {cls.target} not attribute: {var_type}"
-
-        driv_type = system.locate(cls.source)
-        if driv_type is None:
-            raise Exception(f"source not found: {cls.source}")

-

-
-
-
-# Support Previous API
-Signal = Signal
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/attr_slots.html b/docs/_build/html/_modules/engforge/attr_slots.html deleted file mode 100644 index 45d9624..0000000 --- a/docs/_build/html/_modules/engforge/attr_slots.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - - engforge.attr_slots — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.attr_slots

-"""This module defines the slot attrs attribute to ensure the type of component added is correct and to define behavior,defaults and argument passing behavio"""
-
-import attrs
-import uuid
-from engforge.attributes import ATTR_BASE, AttributeInstance
-import typing as typ
-from engforge.logging import LoggingMixin
-
-SLOT_TYPES = typ.Union["Component", "System"]
-ITERATOR = typ.Union["ComponentIterator"]
-
-

-[docs]
-class SlotLog(LoggingMixin):pass

-
-log = SlotLog()
-
-    
-
-
-

-[docs]
-class Slot(ATTR_BASE):
-    """Slot defines a way to accept different components or systems in a system"""
-
-    # These are added on System signals_slots_handler aka attrs field_transformer
-    name: str
-    accepted: SLOT_TYPES
-    config_cls: "System"
-    attr_prefix = "Slot"
-    none_ok: bool
-    instance_class = None #add the component or system on define
-
-    dflt_kw: dict = None  # a dictionary of input in factory for custom inits
-    default_ok = True  # otherwise accept class with defaults
-
-    is_iter: bool
-    wide: bool  # only for component iterator
-    # default_options = ATTR_BASE.default_options.copy()
-    default_options = dict(
-        repr=True,
-        validator=None,
-        cmp=None,
-        hash=None,
-        init=True,
-        metadata=None,
-        converter=None,
-        kw_only=True,
-        eq=None,
-        order=None,
-        on_setattr=None,
-        inherited=False,
-    )
-
-

-[docs]
-    @classmethod
-    def define(
-        cls,
-        *component_or_systems: SLOT_TYPES,
-        none_ok=False,
-        default_ok=True,
-        dflt_kw: dict = None,
-    ):
-        """taking a component or system class as possible input valid input is later validated as an instance of that class or subclass
-
-        :param none_ok: will allow no component on that item, oterwise will fail
-        :param default_ok: will create the slot class with no input if true
-        :param dflt_kw: a dictionary of input in factory for custom inits overrides defaults_ok
-        #TODO: add default_args,default_kwargs
-        """
-        from engforge.components import Component
-        from engforge.component_collections import ComponentIter
-        from engforge.system import System
-        from engforge.eng.costs import CostModel
-
-        # Format THe Accepted Component Types
-        assert (
-            len(component_or_systems) == 1
-        ), "only one slot allowed, try making a subclass"
-        assert not any(
-            [issubclass(c, ComponentIter) for c in component_or_systems]
-        ), f"`ComponentIter` slot should be defined with `define_iterator` "
-        assert all(
-            [
-                issubclass(c, Component) or issubclass(c, System)
-                for c in component_or_systems
-            ]
-        ), "Not System Or Component Input"
-
-        ### Cost models should always default to None
-        #FIXME: is this nessicary?
-        if any([issubclass(c, CostModel) for c in component_or_systems]):
-            default_ok = False
-            none_ok = True
-
-        new_dict =  dict(
-                accepted=component_or_systems,
-                none_ok=none_ok,
-                default_ok=default_ok,
-                dflt_kw=dflt_kw,
-                instance_class = component_or_systems[0],
-                default_options=cls.default_options.copy(),
-            )
-
-        #slot
-        new_name = cls.attr_prefix+'_'
-        new_sig = cls._setup_cls(new_name, new_dict)     
-        return new_sig

-
-
-

-[docs]
-    @classmethod
-    def define_iterator(
-        cls,
-        *component_or_systems: ITERATOR,
-        none_ok: bool = False,
-        default_ok: bool = True,
-        wide: bool = True,
-        dflt_kw: dict = None,
-    ):
-        """taking a type of component iterator, defines an interface that can be 'wide' where all items are executed in the same row on `System.run()`.
-
-        Conversely if `wide` is false the system will loop over each item as if it was included in System.run(). Multiple ComponentIterators with wide=False will result in a `outer join` of the items.
-
-        :param none_ok: will allow no component on that item, otherwise will fail
-        :param default_ok: will create the slot class with no input if true
-        :param dflt_kw: a dictionary of input in factory for custom inits
-        :param wide: default is true, will determine if wide dataframe format, or outerproduct format when `System.run()` is called
-        """
-        from engforge.components import Component
-        from engforge.component_collections import ComponentIter
-        from engforge.system import System
-
-        # Format THe Accepted Component Types
-        assert (
-            len(component_or_systems) == 1
-        ), "only one slot allowed, try making a subclass"
-        assert all(
-            [issubclass(c, ComponentIter) for c in component_or_systems]
-        ), "Not System Or Component Input"
-
-        # FIXME: come up with a better name :)
-        new_name = f"SlotITER_{str(uuid.uuid4()).replace('-','')[0:16]}"
-        new_slot = type(
-            new_name,
-            (Slot,),
-            dict(
-                # default=cls.make_factory(),
-                name=new_name,
-                accepted=component_or_systems,
-                none_ok=none_ok,
-                default_ok=default_ok,
-                dflt_kw=dflt_kw,
-                is_iter=True,
-                wide=wide,
-                instance_class = component_or_systems[0],
-                default_options=cls.default_options.copy(),
-            ),
-        )
-        new_slot.default_options['validator'] = new_slot.configure_instance
-        new_slot.default_options['default'] =  new_slot.make_factory()
-        return new_slot

-
-
-    # Create a validator function
-

-[docs]
-    @classmethod
-    def configure_instance(cls, instance, attribute, value):
-        from engforge.component_collections import ComponentIter
-
-        comp_cls = cls.config_cls
-
-        # apply wide behavior to componentiter instance
-        if isinstance(value, ComponentIter) and attribute.type.wide == False:
-            # print(f'validate {instance} {attribute} {value}')
-            value.wide = False
-
-        if value in cls.accepted or all([value is None, cls.none_ok]):
-            return True
-
-        if any([isinstance(value, a) for a in cls.accepted]):
-            return True
-
-        if cls.default_ok and value is None:
-            return True
-
-        raise ValueError(
-            f"{instance} value {value} is not an accepted type for slot: {comp_cls.__name__}.{cls.name}"
-        )

-
-
-    @classmethod
-    def make_factory(cls, **kwargs):
-        accepted = cls.accepted
-        log.debug(f'slot instance factory: {cls} {accepted}, {kwargs}')
-
-        if isinstance(accepted, (tuple, list)) and len(accepted) > 0:
-            accepted = accepted[0]
-
-        log.debug(f'slot factory: {accepted},{cls.dflt_kw},{cls.default_ok}')
-        if cls.dflt_kw:
-            return attrs.Factory(cls.make_accepted(accepted,**cls.dflt_kw), False)
-        elif cls.default_ok:
-            return attrs.Factory(accepted, False)
-        else:
-            return None
-
-    @classmethod
-    def make_accepted(cls,accepted,**kw):
-        log.debug(f'making accepted: {cls.instance_class} {kw}')
-        return lambda: accepted(**kw)
-    
-        
-

-[docs]
-    @classmethod
-    def handle_instance(cls,canidate):
-        """a passthrough"""
-        return canidate

-

-
-
-
-# Support Previous SnakeCase
-Slot = Slot
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/attr_solver.html b/docs/_build/html/_modules/engforge/attr_solver.html deleted file mode 100644 index a3119b9..0000000 --- a/docs/_build/html/_modules/engforge/attr_solver.html +++ /dev/null @@ -1,561 +0,0 @@ - - - - - - engforge.attr_solver — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.attr_solver

-"""solver defines a SolverMixin for use by System.
-
-Additionally the Solver attribute is defined to add complex behavior to a system as well as add constraints and transient integration.
-"""
-
-import attrs
-import uuid
-import numpy
-import scipy.optimize as scopt
-from contextlib import contextmanager
-import copy
-import datetime
-import typing
-
-from engforge.attributes import ATTR_BASE, AttributeInstance
-from engforge.system_reference import Ref,maybe_attr_inst,maybe_ref
-from engforge.properties import *
-
-import itertools
-
-INTEGRATION_MODES = ["euler", "trapezoid", "implicit"]
-SOLVER_OPTIONS = ["root", "minimize"]
-
-
-

-[docs]
-class AttrSolverLog(LoggingMixin):
-    pass

-
-
-
-log = AttrSolverLog()
-
-
-indep_type = typing.Union[str]
-dep_type = typing.Union[system_property,callable]
-ref_type = typing.Union[str, system_property, callable, float, int]
-
-
-# Solver minimizes residual by changing vars
-

-[docs]
-class SolverInstance(AttributeInstance):
-    """A decoupled signal instance to perform operations on a system instance"""
-
-    system: "System"
-    solver: "Solver"
-
-    # compiled info
-    obj: "Ref"
-    var: "Ref"
-    lhs: "Ref"
-    rhs: "Ref"
-    const_f: "Ref"
-
-    _active: bool
-    _constraints: list
-
-
-    def __init__(self, solver: "Solver", system: "System",**kw) -> None:
-        """kwargs passed to compile"""
-        self.class_attr = self.solver = solver
-        self.system = system
-        self.compile(**kw)
-
-

-[docs]
-    def compile(self, **kwargs):
-        """establishes the references for the solver to use directly"""
-        from engforge.solver import objectify,secondary_obj
-        if self.solver.slvtype == "var":
-            self.var = self.system.locate_ref(self.solver.var)
-            self.system.debug(f"solving with indpendent: {self.var}")
-
-        elif self.solver.slvtype in ["ineq", "eq"]:
-            self.lhs = self.system.locate_ref(self.solver.lhs)
-            
-            if hasattr(self.solver, "rhs") and (isinstance(self.solver.rhs, str)or callable(self.solver.rhs)):
-                self.rhs = self.system.locate_ref(self.solver.rhs)
-            elif hasattr(self.solver, "rhs") and self.solver.rhs is not None:
-                #raise Exception(f"bad rhs: {self.solver.rhs}")
-                self.rhs = self.solver.rhs
-                
-            m = " = " if self.solver.slvtype == "eq" else " >= "
-            self.system.debug(f"solving {self.lhs}{m}{self.rhs}")
-
-            if hasattr(self,'rhs') and self.rhs is not None:
-                mult=1
-                bias=None
-                power=None
-                #careful with kw vs positional args here
-                fun = lambda sys,prob: maybe_ref(self.lhs,SolverInstance,sys=sys,prob=prob,mult=mult,bias=bias,power=power) - maybe_ref(self.rhs,SolverInstance,sys=sys,prob=prob,mult=mult,bias=bias,power=power)
-                fun.__name__ = f"{self.lhs}_{self.rhs}_{self.solver.slvtype}"
-                objfunc = Ref(self.system,fun)
-            else:
-                objfunc = self.lhs
-            
-            if log.log_level <= 6:
-                self.system.debug(f"const defined: {objfunc}|{self.solver}")
-
-            self.const_f = objfunc
-
-        elif self.solver.slvtype == 'obj':
-            self.obj_ref = self.system.locate_ref(self.solver.obj)
-            if self.solver.kind == 'max':
-                mult=None
-                bias=None
-                power=None
-            else:
-                mult=None
-                bias=None
-                power=None
-
-            fun = lambda sys,prob: maybe_ref(self.obj_ref,SolverInstance,sys=sys,prob=prob,mult=mult,bias=bias,power=power)  
-            fun.__name__ = f"obj_{self.solver.obj}_{self.solver.kind}"
-            self.obj = Ref(self.system,fun)
-            #self.obj = self.system.locate_ref(fun)
-            self.system.debug(f"solving with obj: {self.obj}")

-
-            
-    @property
-    def constraints(self):
-        if hasattr(self,'_constraints'):
-            return self._constraints
-        if self.solver.slvtype in ['var','obj']:
-            return self.solver.constraints
-        else:
-            #just me
-            return [{'type':self.slvtype,'var':self.solver.lhs,'value':self.const_f}]
-        
-
-    @property
-    def slvtype(self):
-        return self.solver.slvtype
-    
-    @property
-    def combos(self):
-        return self.solver.combos
-    
-    @property
-    def normalize(self):
-        return self.solver.normalize
-    
-    @property
-    def active(self):
-        if hasattr(self,'_active'):
-            return self._active        
-        return self.solver.active
-    
-    def get_alias(self,pre):
-        if self.solver.slvtype  == 'var':
-            return self.var.key #direct ref
-        return super().get_alias(pre) #default
-
-    def as_ref_dict(self):
-        out = {'var':None,'eq':None,'ineq':None,'obj':None}
-
-        if self.solver.slvtype == "var":
-                out['var'] = self.var
-        elif self.solver.slvtype == "obj":
-                out['obj'] = self.obj
-        elif self.solver.slvtype == "eq":
-                out['eq'] =  self.const_f
-        elif self.solver.slvtype == "ineq":
-                out['ineq'] =  self.const_f
-        
-        return out

-
-
-            
-            
-
-

-[docs]
-class Solver(ATTR_BASE):
-    """solver creates subclasses per solver balance"""
-
-    obj: dep_type = None
-    var: indep_type = None
-    rhs: ref_type = None
-    lhs: ref_type = None
-    slvtype: str
-    constraints: dict
-    combos: list = None
-    
-    normalize: ref_type
-    allow_constraint_override: bool = True
-
-    attr_prefix = "Solver"
-    active: bool
-    instance_class = SolverInstance
-
-    define = None
-
-
-

-[docs]
-    @classmethod
-    def configure_for_system(cls, name, config_class, cb=None, **kwargs):
-        """add the config class, and perform checks with `class_validate)
-        :returns: [optional] a dictionary of options to be used in the make_attribute method
-        """
-        pre_name = cls.name #random attr name
-        super(Solver,cls).configure_for_system(name,config_class,cb,**kwargs)
-
-        #change name of constraint  var if 
-        if cls.slvtype == "var":
-            #provide defaults ot constraints, and update combo_var with attribut name
-            for const in cls.constraints:
-                if 'combo_var' in const and const['combo_var'] == pre_name:
-                    const['combo_var'] = name #update me
-                elif 'combo_var' not in const:
-                    const['combo_var'] = name #update me
-                
-                if 'combos' not in const:
-                    const['combos'] = 'default'

-
-                    
-
-    # TODO: add normalize attribute to tune optimizations
-

-[docs]
-    @classmethod
-    def declare_var(cls, var: str, **kwargs):
-        """
-        Defines a solver variable for optimization in the class, constraints defined on this solver will correspond to the limits of that variable
-        :param var: The var attribute for the solver variable.
-        :param combos: The combinations of the solver variable.
-        :return: The setup class for the solver variable.
-        """
-        assert ',' not in var, f"var cannot have commas: {var}"
-
-        # Create A New Signals Class
-        active = kwargs.get("active", True)
-        combos = kwargs.get("combos", f'default,{var}') #default + var_name
-
-        new_name = f"Solver_var_{var}".replace(".", "_")
-        bkw = {"var": var, "value": None}
-        constraints = [{"type": "min", **bkw}, {"type": "max", **bkw}]
-        new_dict = dict(
-            name=new_name, #until configured for system, it gets the assigned name
-            active=active,
-            var=var,
-            slvtype="var",
-            constraints=constraints,
-            combos=cls.process_combos(combos),
-            default_options=cls.default_options.copy(),
-        )
-        return cls._setup_cls(new_name, new_dict)

-
-
-
-

-[docs]
-    @classmethod
-    def objective(cls, obj: str, **kwargs):
-        """
-        Defines a solver variable for optimization in the class, constraints defined on this solver will correspond to the limits of that variable
-
-        :param obj: The var attribute for the solver variable.
-        :param combos: The combinations of the solver variable.
-        :vara kind: the kind of optimization, either min or max
-        :return: The setup class for the solver variable.
-        """
-        # Create A New Signals Class
-        active = kwargs.get("active", True)
-        combos = kwargs.get("combos", "default")
-        kind = kwargs.get("kind", "min")
-        assert kind in ("min", "max")
-
-        new_name = f"Solver_obj_{obj}_{kind}".replace(".", "_")
-        bkw = {"var": obj, "value": None}
-        new_dict = dict(
-            name=new_name,
-            active=active,
-            obj=obj,
-            slvtype="obj",
-            kind=kind,
-            constraints=[],
-            combos=cls.process_combos(combos),
-            default_options=cls.default_options.copy(),
-        )
-        return cls._setup_cls(new_name, new_dict)

-
-
-    obj = objective  
-
-

-[docs]
-    @classmethod
-    def constraint_equality(
-        cls, lhs: "system_property", rhs: "system_property" = 0, **kwargs
-    ):
-        """Defines an equality constraint based on a required lhs of equation, and an optional rhs, the difference of which will be driven to zero"""
-        combos = kwargs.get("combos", "default")
-        active = kwargs.get("active", True)
-
-        # Create A New Signals Class
-        new_name = f"Solver_coneq_{lhs}_{rhs}".replace(".", "_")
-        new_dict = dict(
-            name=new_name,
-            active=active,
-            lhs=lhs,
-            rhs=rhs,
-            slvtype="eq",
-            constraints=[],
-            combos=cls.process_combos(combos),
-            default_options=cls.default_options.copy(),
-        )
-        return cls._setup_cls(new_name, new_dict)

-
-
-    con_eq = constraint_equality
-
-

-[docs]
-    @classmethod
-    def constraint_inequality(cls, lhs: ref_type, rhs: ref_type = 0, **kwargs):
-        """Defines an inequality constraint"""
-        combos = kwargs.get("combos", "default")
-        active = kwargs.get("active", True)
-
-        # Create A New Signals Class
-        new_name = f"Solver_conineq_{lhs}_{rhs}".replace(".", "_")
-        new_dict = dict(
-            name=new_name,
-            active=active,
-            lhs=lhs,
-            rhs=rhs,
-            slvtype="ineq",
-            constraints=[],
-            combos=cls.process_combos(combos),
-            default_options=cls.default_options.copy(),
-        )
-        return cls._setup_cls(new_name, new_dict)

-
-
-    con_ineq = constraint_inequality
-
-    # TODO: add minimize / maximize / objective options
-
-

-[docs]
-    @classmethod
-    def class_validate(cls, instance, **kwargs):
-        from engforge.properties import system_property
-
-        system = cls.config_cls
-
-        # TODO: normalize references to ref or constant here
-        # TODO: add a check for the solver to be a valid solver type
-
-        if cls.slvtype == "var":
-            var_type = system.locate(cls.var)
-            if var_type is None:
-                raise Exception(f"var not found: {cls.var}")
-            assert isinstance(
-                var_type, attrs.Attribute
-            ), f"bad var {cls.var} not attribute: {var_type}"
-            assert var_type.type in (
-                int,
-                float,
-            ), f"bad var {cls.var} not numeric"
-
-        elif cls.slvtype in ["ineq", "eq"]:
-            driv_type = system.locate(cls.lhs)
-            if driv_type is None:
-                raise Exception(f"LHS not found: {cls.lhs}")
-            assert isinstance(
-                driv_type, system_property
-            ), f"bad LHS {cls.lhs} type: {driv_type}"
-            if cls.rhs is not None:
-                driv_type = system.locate(cls.rhs)
-                if driv_type is None:
-                    raise Exception(f"RHS not found: {cls.rhs}")
-                assert isinstance(
-                    driv_type, system_property
-                ), f"bad RHS {cls.rhs} type: {driv_type}"
-
-        else:
-            raise Exception(f"bad slvtype: {cls.slvtype}")

-
-
-

-[docs]
-    @classmethod
-    def create_instance(cls, system: "System") -> SolverInstance:
-        return SolverInstance(cls, system)

-
-
-

-[docs]
-    @classmethod
-    def add_var_constraint(cls, value, kind="min",**kwargs):
-        """adds a `type` constraint to the solver. If value is numeric it is used as a bound with `scipy` optimize.
-
-        If value is a function it should be of the form value(Xarray) and will establish an inequality constraint that var var must be:
-            1. less than for max
-            2. more than for min
-
-        During the evaluation of the limit function system.X should be set, and pre_execute() have already run.
-
-        :param type: str, must be either min or max with var value comparison, or with a function additionally eq,ineq (same as max(0)) can be used
-        :value: either a numeric (int,float), or a function, f(system)
-        """
-        assert cls is not Solver, f"must set constraint on Solver subclass"
-        # assert not cls.constraint_exists(type=kind,var=var), f"constraint already exists!"
-        assert isinstance(value, (int, float)) or callable(
-            value
-        ), f"only int,float or callables allow. Callables must take system as argument"
-
-        var = cls.var
-        assert var is not None, "must provide var on non-var solvers"
-        assert cls.slvtype == "var", "only Solver.declare_var can have constraints"
-        assert kind in ("min", "max")
-
-        combo_dflt = "default,lim"
-        cmbs = kwargs.get("combos",'')
-        combos = cls.process_combos(cmbs,combo_dflt,combo_dflt)
-        if isinstance(combos,str):
-            combos = combos.split(',')
-        active = kwargs.get("active", True)
-        const = {"type": kind, "value": value, "var": var, "active": active, "combos": combos, 'combo_var':cls.name}
-        #print(const,cls.__dict__)
-
-        cinx = cls.constraint_exists(type=kind, var=var)
-        inix = cinx is not None
-        if cls.allow_constraint_override and inix:
-            log.debug(f'replacing constraint {cinx} with {kind} {value} {var}')
-            constraint = cls.constraints[cinx]
-            constraint.update(const)
-        elif not cls.allow_constraint_override and inix:
-            cnx = cls.constraints[cinx]
-            raise Exception(f"constraint already exists! {cnx}")
-        else:
-            cls.constraints.append(const)

-
-
-
-

-[docs]
-    @classmethod
-    def constraint_exists(cls, **kw):
-        """check constraints on the system, return its index position if found, else None."""
-        for i, c in enumerate(cls.constraints):
-            if all([c[k] == v for k, v in kw.items()]):
-                return i
-        return None

-

-
-
-
-# Support Previous SnakeCase
-Solver = Solver
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/attributes.html b/docs/_build/html/_modules/engforge/attributes.html deleted file mode 100644 index 966855a..0000000 --- a/docs/_build/html/_modules/engforge/attributes.html +++ /dev/null @@ -1,461 +0,0 @@ - - - - - - engforge.attributes — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.attributes

-"""Defines a customizeable attrs attribute that is handled in configuration,
-
-on init an instance of `Instance` type for any ATTR_BASE subclass is created """
-
-import attrs, attr, uuid
-from engforge.logging import LoggingMixin, log
-
-
-

-[docs]
-class ATTRLog(LoggingMixin):
-    pass

-
-log = ATTRLog()
-
-
-DEFAULT_COMBO = 'default'
-
-

-[docs]
-class AttributeInstance:
-    class_attr: "ATTR_BASE"
-    system: "System"
-    classname: str = "attribute" #for ref compatability
-    backref: "ATTR_BASE"
-
-    # TODO: universal slots method
-    # __slots__ = ["system", "class_attr"]
-
-    def __init__(
-        self, class_attr: "CLASS_ATTR", system: "System", **kwargs
-    ) -> None:
-        self.class_attr = class_attr
-        self.system = system
-        self.compile(**kwargs)
-
-    def compile(self, **kwargs):
-        # raise NotImplementedError("Override Me!")
-        pass
-
-    def as_ref_dict(self)->dict:
-        log.info(f'pass - as ref {self}')
-        return None
-    
-    def get_alias(self,path):
-        return path.split('.')[-1]
-    
-    def is_active(self,value=False) -> bool:
-        mthd = 'dflt'
-        if hasattr(self,'_active'):
-            mthd = 'instance'
-            value = self._active
-
-        elif hasattr(self.class_attr,'active'):
-            mthd = 'class'
-            value = self.class_attr.active
-        
-        #print(f'{self}| {mthd} is_active: {value}')
-        #the default
-        return value       
-    
-    @property
-    def combos(self):
-        return self.class_attr.combos
-    
-    @property
-    def active(self):
-        return self.class_attr.active    

-
-
-#TODO: add a concept of queries of ATTR_BASE subclasses, where multiple types may be selected or filtered, with individual arguments.
-

-[docs]
-class ATTR_BASE(attrs.Attribute):
-    """A base class that handles initalization in the attrs meta class scheme by ultimately createing an Instance"""
-
-    name: str
-    config_cls: "System"
-    attr_prefix = "ATTR"
-    instance_class: AttributeInstance = AttributeInstance  # Define me
-    default_options: dict
-    template_class = True
-
-    #TODO: add generic selection & activation of attributes
-    active: bool
-    combos: list
-
-    none_ok = False
-
-    #Activation & Combo Selection Functionality
-    @classmethod
-    def process_combos(cls, combos,default=None,add_combos=None):
-        if isinstance(combos, str):
-            if '*' in combos:
-                raise KeyError("wildcard (*) not allowed in combos!")
-            out = combos.split(",") 
-        elif isinstance(combos, list):
-            if any(['*' in c for c in combos]):
-                raise KeyError("wildcard (*) not allowed in combos!")            
-            out = combos
-        else:
-            out = []    
-        
-        if add_combos is not None:
-            out += cls.process_combos(add_combos,default=default)
-
-
-        if out:
-            return out
-        if default:
-            return default
-        return ['default']
-
-    #Initialization
-

-[docs]
-    @classmethod
-    def configure_for_system(cls, name, config_class, cb=None, **kwargs):
-        """add the config class, and perform checks with `class_validate)
-        :returns: [optional] a dictionary of options to be used in the make_attribute method
-        """
-        log.debug(f"{cls.__name__} is being configured for {cls.attr_prefix}")
-        cls.name = name
-        cls.config_cls = config_class
-
-        if isinstance(cls.instance_class,ATTR_BASE) and not hasattr(cls.instance_class, "backref"):
-            #get parent class
-            refs = [cls,ATTR_BASE]
-            mro_group = cls.mro()
-            mro_group = mro_group[:mro_group.index(ATTR_BASE)]
-            cans = [v for v in mro_group if v not in refs]
-            last = cans[-1]
-            # if not hasattr(cls,'instance_class') or not cls.instance_class:
-            #     log.info(f'no instance class! {cls}')
-            cls.instance_class.backref = last
-        else:
-            pass
-            #print(f'backref exists {cls.instance_class.backref} {cls}')
-
-        if cb is not None:
-            cb(cls, config_class, **kwargs)
-
-        return {}  # OVERWRITE ME "custom_options":False

-
-
-

-[docs]
-    @classmethod
-    def create_instance(cls, instance: "Configuration") -> AttributeInstance:
-        """Create an instance of the instance_class"""
-        if cls.instance_class is None:
-            raise Exception(
-                f"Instance Class Hasnt Been Defined For `{cls}.instance_class`"
-            )
-        if not hasattr(cls, "config_cls"):
-            raise Exception(f"`config_cls` hasnt been defined for `{cls}`")
-
-        cls.class_validate(instance=instance)
-        return cls.instance_class(cls, instance)

-
-
-    #Override Me:
-

-[docs]
-    @classmethod
-    def configure_instance(cls, instance, attribute, value):
-        """validates the instance given attr's init routine"""
-        pass

-
-
-

-[docs]
-    @classmethod
-    def class_validate(cls, instance, **kwargs):
-        """validates onetime A method to validate the kwargs passed to the define method"""
-        pass

-
-
-

-[docs]
-    @classmethod
-    def define_validate(cls, **kwargs):
-        """A method to validate the kwargs passed to the define method"""
-        pass

-
-    
-    #Interafce & Utility
-

-[docs]
-    @classmethod
-    def define(cls, **kwargs):
-        """taking a component or system class as possible input valid input is later validated as an instance of that class or subclass"""
-        assert not cls.template_class, f"{cls} is not template class and cannot defined anything, ie anything that has been created as a function of `define` cannot be defined"
-
-        cls.define_validate(**kwargs)
-
-        # Create A New Signals Class
-        kw_pairs = [f"{k}_{v}" for k, v in kwargs.items()]
-        new_name = f"{cls.attr_prefix}_{('_'.join(kw_pairs))}".replace(".", "_")
-        # define the class dictionary
-        new_dict = dict(name=new_name)
-        new_slot = cls._setup_cls(new_name, new_dict, **kwargs)
-        return new_slot

-
-
-    @classmethod
-    def _setup_cls(cls, name, new_dict, **kwargs):
-       
-        #randomize name for specifics reasons
-        uid = str(uuid.uuid4())
-        name = name + "_" + uid.replace("-", "")[0:16]
-        new_dict['uuid'] = uid
-        new_dict['default_options'] = cls.default_options.copy()
-        new_dict['template_class'] = False
-        new_dict['name'] = name
-        new_slot = type(name, (cls,), new_dict)
-        new_slot.default_options["default"] = new_slot.make_factory()
-        new_slot.default_options["validator"] = new_slot.configure_instance
-        log.debug(
-            f"defined {name}|{new_slot} with {kwargs}| {new_slot.default_options}"
-        )         
-        return new_slot   
-
-    @classmethod
-    def make_factory(cls, **kwargs):
-        #print(f"{cls} making factory with: {kwargs}")
-        return attrs.Factory(cls.create_instance, takes_self=True)
-
-

-[docs]
-    @classmethod
-    def make_attribute(cls, name, comp_class, **kwargs):
-        """makes an attrs.Attribute for the class"""
-        cust_options = cls.configure_for_system(name, comp_class, **kwargs)
-        # make copy for new instance
-        opts = cls.default_options.copy()
-        # update with custom kwargs
-        if isinstance(cust_options, dict):
-            opts.update(cust_options)
-        # input has the final override
-        opts.update(kwargs)
-        # The core functionality
-        opts.update(name=name, type=cls)
-
-        # Handle the default and validator, if not overridden
-        if "default" not in kwargs:
-            opts["default"] = cls.make_factory()
-        if "validator" not in kwargs:
-            opts["validator"] = cls.configure_instance
-
-        return attrs.Attribute(**opts)

-
-
-    # Structural Orchestration Through Subclassing
-

-[docs]
-    @classmethod
-    def collect_cls(cls,system)->dict:
-        """collects all the attributes for a system"""
-        if not isinstance(system,type):
-            system = system.__class__
-        return {k:at.type for k,at in system._get_init_attrs_data(cls).items()}

-
-    
-

-[docs]
-    @classmethod
-    def collect_attr_inst(cls,system,handle_inst=True)->dict:
-        """collects all the attribute instances for a system"""
-        cattr = cls.collect_cls(system)
-        out = {}
-        for k,v in cattr.items():
-            inst = getattr(system,k)
-            if (inst is None and getattr(cls.instance_class,'none_ok',False)) or (cls.instance_class is not None and not isinstance(inst,cls.instance_class)):
-                log.warning(f"Attribute {k}|{inst} is not an instance of {cls.instance_class} in {system}")
-                continue
-
-            if inst and handle_inst:
-                inst = cls.handle_instance(inst)
-                
-            if inst is not None:
-                out[k] = inst
-        return out

-
-
-    @staticmethod
-    def unpack_atrs(d,pre='',conv=None):
-
-        if not conv:
-            conv = lambda v: v
-        if isinstance(d,dict):
-            for k,v in d.items():
-                if not isinstance(v,dict):
-                    yield k,pre,conv(v)
-                elif v:
-                    if pre and not pre.endswith('.'): ppre = pre+'.'
-                    ck = f'{ppre}{k}'
-                    for kii,ki,vi in ATTR_BASE.unpack_atrs(v,ck):
-                        yield kii,ki,conv(vi)
-                else:
-                    if pre and not pre.endswith('.'): ppre = pre+'.'
-                    ck = f'{ppre}{k}'           
-                    yield '',ck,v
-        return d
-    
-

-[docs]
-    @classmethod
-    def handle_instance(cls,canidate):
-        """handles the instance, override as you wish"""
-        #print('handle_instance',cls,canidate,cls.instance_class)
-
-        if isinstance(canidate,cls.instance_class):
-            o =  canidate.as_ref_dict()
-            return o
-        return canidate #live and let live

-
-    
-

-[docs]
-    @classmethod
-    def subclasses(cls, out=None):
-        """return all subclasses of components, including their subclasses
-        :param out: out is to pass when the middle of a recursive operation, do not use it!
-        """
-
-        # init the set by default
-        if out is None:
-            out = set()
-
-        for cls in cls.__subclasses__():
-            if not cls.template_class:
-                continue
-            out.add(cls)
-            cls.subclasses(out)
-
-        return out    

-

-
-
-ATTR_BASE.default_options = dict(
-    # validator=ATTR_BASE.configure_instance,
-    repr=False,
-    cmp=None,
-    hash=None,
-    init=False,  # change this to allow for init input
-    metadata=None,
-    converter=None,
-    kw_only=True,
-    eq=None,
-    order=None,
-    on_setattr=None,
-    inherited=False,
-)
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/common.html b/docs/_build/html/_modules/engforge/common.html deleted file mode 100644 index e60e0ad..0000000 --- a/docs/_build/html/_modules/engforge/common.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - - engforge.common — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.common

-"""A set of common values and functions that are globaly available."""
-import sys
-import functools
-
-# Common Modules
-from engforge.configuration import *
-from engforge.logging import LoggingMixin
-from urllib.request import urlopen
-
-import numpy
-
-
-

-[docs]
-class ForgeLog(LoggingMixin):
-    pass

-
-
-
-log = ForgeLog()
-log.info("Starting engforge Enviornment")
-
-
-

-[docs]
-class inst_vectorize(numpy.vectorize):
-    def __get__(self, obj, objtype):
-        return functools.partial(self.__call__, obj)

-
-
-
-

-[docs]
-def chunks(lst, n):
-    """Yield successive n-sized chunks from lst."""
-    for i in range(0, len(lst), n):
-        yield lst[i : i + n]

-
-
-
-

-[docs]
-def is_ec2_instance():
-    """Check if an instance is running on AWS."""
-    result = False
-    meta = "http://169.254.169.254/latest/meta-data/public-ipv4"
-    try:
-        result = urlopen(meta, timeout=5.0).status == 200
-        return True
-    except:
-        return False
-    return False

-
-
-
-

-[docs]
-def get_size(obj, seen=None):
-    """Recursively finds size of objects"""
-    size = sys.getsizeof(obj)
-    if seen is None:
-        seen = set()
-    obj_id = id(obj)
-    if obj_id in seen:
-        return 0
-    # Important mark as seen *before* entering recursion to gracefully handle
-    # self-referential objects
-    seen.add(obj_id)
-    if isinstance(obj, dict):
-        size += sum([get_size(v, seen) for v in obj.values()])
-        size += sum([get_size(k, seen) for k in obj.keys()])
-    elif hasattr(obj, "__dict__"):
-        size += get_size(obj.__dict__, seen)
-    elif hasattr(obj, "__iter__") and not isinstance(
-        obj, (str, bytes, bytearray)
-    ):
-        size += sum([get_size(i, seen) for i in obj])
-    return size

-
-
-
-# Constants
-g = gravity = 9.80665  # m/s2
-G_grav_constant = 6.67430e-11  # m3/kgs
-speed_of_light = 299792458  # m/s
-u_planck = 6.62607015e-34  # Js
-R_univ_gas = 8.314462618  # J/molkg
-mass_electron = 9.1093837015e-31  # kg
-mass_proton = 1.67262192369e-27
-mass_neutron = 1.67492749804e-27
-r_electron = 2.8179403262e-15
-Kboltzman = 1.380649e-23  # J⋅K−1
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/component_collections.html b/docs/_build/html/_modules/engforge/component_collections.html deleted file mode 100644 index 3fbfb78..0000000 --- a/docs/_build/html/_modules/engforge/component_collections.html +++ /dev/null @@ -1,408 +0,0 @@ - - - - - - engforge.component_collections — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • Module code
    • -
  • engforge.component_collections
    • -
  • -
    • -
-
-
-
-
- -

Source code for engforge.component_collections

-"""define a collection of components that will propigate to its parents dataframe
-
-When `wide` is set each component's references are reported to the system's table, otherwise only one component's references are reported, however the system will iterate over the components by calling `system.iterable_components` 
-
-Define a Iterable Component slot in a system by calling `Slot.define_iterable(...,wide=True/False)`
-
-CostModel isonly supported in wide mode at this time.
-
-Types: 
-1. ComponentList, ordered by index
-2. ComponentDict, ordered by key
-3. ComponentGraph,  ?#TODO:
-"""
-
-from collections import UserDict, UserList
-from engforge.components import Component
-from engforge.attr_slots import Slot
-from engforge.configuration import forge
-from engforge.typing import *
-from engforge.system_reference import Ref, system_property
-from engforge.properties import *
-
-
-import attrs
-
-
-

-[docs]
-def check_comp_type(instance, attr, value):
-    """ensures the input component type is a Component"""
-    from engforge.eng.costs import CostModel
-
-    if (
-        not instance.wide
-        and isinstance(value, type)
-        and issubclass(value, CostModel)
-    ):
-        raise TypeError(f"Cost Mixin Not Supported As Iter Type! {value}")
-
-    if isinstance(value, type) and issubclass(value, Component):
-        return
-
-    raise TypeError(f"Not A Component Class! {value}")

-
-
-
-

-[docs]
-class iter_tkn:
-    """ambigious type to keep track of iterable position form system reference"""
-
-    pass

-
-
-
-

-[docs]
-@forge
-class ComponentIter(Component):
-    """Iterable components are designed to eval a large selection of components either one-by-one or all at once at the system level depending on if `wide` property is set."""
-
-    _ref_cache: dict = None
-    _item_refs: dict = None
-
-    wide: bool = True
-
-    # what holds the components
-    data: iter
-
-    # current item keu, non table type, this triggers `anything_changed` in `system._iterate_component()`
-    current_item: iter_tkn = attr.ib(factory=lambda: None, hash=False, eq=False)
-    _first_item_key: iter_tkn
-
-    @property
-    def current(self):
-        """returns all data in wide format and the active key in _current_item"""
-        if self.wide:
-            return self.data
-        else:
-            if self.current_item is None:
-                if not hasattr(self, "_first_item_key"):
-                    next(self._item_gen())
-                return self.data[self._first_item_key]
-            return self.data[self.current_item]
-
-    def _item_gen(self):
-        for key, item in self.data.items():
-            if not hasattr(self, "_first_item_key"):
-                self._first_item_key = key
-            yield key, item
-
-    def __setitem__(self, key, value):
-        assert isinstance(
-            value, self.component_type
-        ), f"{value} is not of type: {self.component_type}"
-        super().__setitem__(key, value)
-        self.reset()
-
-    def reset(self):
-        # reset reference cache
-        self._prv_internal_references = None
-        self._item_refs = None
-        self.current_item = None
-
-    def _item_key(self, itkey, item):
-        """override this to customize data access to self.data or other container name"""
-        return itkey
-
-    #TODO: way to update internal references in problem, do on update()?
-    @property
-    def _internal_references(self) -> dict:
-        """considers wide format to return active references"""
-        if self.wide:
-            return self._prv_internal_references
-        else:
-            if self.current_item is None:
-                return self._item_refs[self._first_item_key]
-            return self._item_refs[self.current_item]
-
-

-[docs]
-    def comp_references(self,**kw):
-        """Returns this components global references"""
-        out = {}
-        out["attributes"] = at = {}
-        out["properties"] = pr = {}
-
-        for key in self.system_properties_classdef():
-            pr[key] = Ref(self, key, True, False)
-
-        for key in self.input_fields():
-            at[key] = Ref(self, key, False, True)
-
-        return out

-
-
-

-[docs]
-    def internal_references(self, recache=False,numeric_only=False):
-        """lists the this_name.comp_key.<attr/prop key>: Ref format to override data_dict"""
-
-        if (
-            recache == False
-            and hasattr(self, "_prv_internal_references")
-            and self._prv_internal_references
-        ):
-            return self._internal_references
-
-        keeprefcopy = lambda d: {k: {**c} for k, c in d.items()}
-
-        out = keeprefcopy(self.comp_references())
-        at = out["attributes"]  # = at = {}
-        pr = out["properties"]  # = pr = {}
-        _item_refs = {}
-
-        for itkey, item in self._item_gen():
-            it_base_key = self._item_key(itkey, item)
-
-            _item_refs[itkey] = ir = keeprefcopy(self.comp_references())
-            atr = ir["attributes"]  # = atr = {}
-            prr = ir["properties"]  # = prr = {}
-
-            # set property refs
-            for key in item.system_properties_classdef():
-                k = f"{it_base_key}.{key}"
-                rc = Ref(item, key, True, False)
-                pr[k] = rc
-                prr[key] = rc
-
-            # set attr refs
-            if numeric_only:
-                for key in item.numeric_fields():
-                    k = f"{it_base_key}.{key}"
-                    ri = Ref(item, key, False, True)
-                    at[k] = ri
-                    atr[key] = ri
-
-            else:
-                for key in item.input_fields():
-                    k = f"{it_base_key}.{key}"
-                    ri = Ref(item, key, False, True)
-                    at[k] = ri
-                    atr[key] = ri
-
-        # cache the references
-        self._prv_internal_references = out
-        self._item_refs = _item_refs
-        return self._internal_references

-
-
-    def __hash__(self):
-        return hash(id(self))

-
-
-
-

-[docs]
-@forge
-class ComponentDict(ComponentIter, UserDict):
-    """Stores components by name, and allows tabulation of them"""
-
-    component_type: type = attrs.field(validator=check_comp_type)
-
-    # tabulate_depth:int = attrs.field(default=1) #TODO: impement this
-
-    _ref_cache: dict = None
-
-    # Dict Setup
-    def __on_init__(self):
-        UserDict.__init__(self)
-
-    def __str__(self):
-        return f"{self.__class__.__name__}[{len(self.data)}]"
-
-    def __repr__(self) -> str:
-        return str(self)

-
-
-
-

-[docs]
-@forge
-class ComponentIterator(ComponentIter, UserList):
-    """Stores components by name, and allows tabulation of them"""
-
-    component_type: type = attrs.field(validator=check_comp_type)
-
-    # Dict Setup
-    def __on_init__(self):
-        UserList.__init__(self)
-
-    def _item_gen(self):
-        for i, item in enumerate(self.data):
-            if not hasattr(self, "_first_item_key"):
-                self._first_item_key = i
-            yield i, item
-
-    def _item_key(self, itkey, item):
-        return f"{self.component_type.__name__.lower()}.{itkey}"

-
-
-    # def __setitem__(self, key, value):
-    #     assert isinstance(value,self.component_type)
-    #     super().__setitem__(key, value)
-    #     #reset reference cache
-    #     self._ref_cache = None
-
-
-#     #Tabulation Override
-#     @property
-#     def internal_references(self):
-#         """lists the this_name.comp_key.<attr/prop key>: Ref format to override data_dict"""
-#
-#         if self._ref_cache:
-#             return self._ref_cache
-#
-#         out = {}
-#         out["attributes"] = at = {}
-#         out["properties"] = pr = {}
-#
-#         for itkey,item in self._item_gen():
-#             it_base_key = f'{itkey}'
-#
-#             for key in item.system_properties_classdef():
-#                 k = f'{it_base_key}.{key}'
-#                 pr[k] = Ref(item, key)
-#
-#             for key in item.input_fields():
-#                 k = f'{it_base_key}.{key}'
-#                 at[k] = Ref(item, key, False)
-#
-#         #cache the references
-#         self._ref_cache = out
-#         return out
-
-#     #Tabulation Override
-#     @property
-#     def internal_references(self):
-#         """lists the this_name.comp_key.<attr/prop key>: Ref format to override data_dict"""
-#
-#         if self._ref_cache:
-#             return self._ref_cache
-#
-#         out = {}
-#         out["attributes"] = at = {}
-#         out["properties"] = pr = {}
-#
-#         for it,item in self._item_gen():
-#             it_base_key = f'{self.component_type.__name__.lower()}.{it}'
-#
-#             for key in item.system_properties_classdef():
-#                 k = f'{it_base_key}.{key}'
-#                 pr[k] = Ref(item, key)
-#
-#             for key in item.input_fields():
-#                 k = f'{it_base_key}.{key}'
-#                 at[k] = Ref(item, key, False)
-#
-#         #cache the references
-#         self._ref_cache = out
-#         return out
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/components.html b/docs/_build/html/_modules/engforge/components.html deleted file mode 100644 index ea43e94..0000000 --- a/docs/_build/html/_modules/engforge/components.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - engforge.components — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.components

-from contextlib import contextmanager
-import attr
-import typing
-
-# from engforge.logging import LoggingMixin, log
-from engforge.tabulation import TabulationMixin, system_property
-from engforge.configuration import forge, Configuration
-from engforge.solver import SolveableMixin
-from engforge.properties import class_cache
-from engforge.dynamics import DynamicsMixin
-
-
-import os, sys
-import inspect
-
-# import pathlib
-import random
-import matplotlib.pyplot as plt
-
-
-

-[docs]
-@forge
-class SolveableInterface(Configuration,TabulationMixin,SolveableMixin):
-    """common base betwewn solvable and system"""
-    parent: typing.Union["Component", "System"] = attr.ib(default=None)
-    _last_context: "ProblemExec"
-
-    @property
-    def last_context(self):
-        """get the last context run, or the parent's"""
-        if hasattr(self,"_last_context"):
-            #cleanup parent context
-            if hasattr(self,'_parent_context') and not self.parent.last_context:
-                del self._last_context
-                del self._parent_context
-            else:
-                return self._last_context 
-        elif hasattr(self,'parent') and self.parent and (ctx:=self.parent.last_context):
-            self._last_context = ctx
-            self._parent_context = True
-            return ctx
-        return None

-
-
-#NOTE: components / systems not interchangable, systems are like components but are have solver capabilities
-#TODO: justify separation of components and systems, and not making system a subclass of component. Otherwise make system a subclass of component
-

-[docs]
-@forge
-class Component(SolveableInterface,DynamicsMixin):
-    """Component is an Evaluatable configuration with tabulation, and solvable functionality"""
-    pass

-
-
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/configuration.html b/docs/_build/html/_modules/engforge/configuration.html deleted file mode 100644 index ba1f604..0000000 --- a/docs/_build/html/_modules/engforge/configuration.html +++ /dev/null @@ -1,747 +0,0 @@ - - - - - - engforge.configuration — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.configuration

-import attr, attrs
-
-from engforge.engforge_attributes import AttributedBaseMixin
-from engforge.logging import LoggingMixin, log, change_all_log_levels
-from engforge.properties import *
-from engforge.env_var import EnvVariable
-import randomname
-import datetime
-import copy
-
-
-# make a module logger
-

-[docs]
-class ConfigLog(LoggingMixin):
-    pass

-
-
-log = ConfigLog()
-
-conv_nms = lambda v: v.split(',') if isinstance(v,str) else v
-NAME_ADJ = EnvVariable('FORGE_NAME_ADJ',default=('geometry','size','algorithms','complexity','colors','materials'),type_conv=conv_nms)
-NAME_NOUN = EnvVariable('FORGE_NAME_NOUN',default=('chemistry','astronomy','linear_algebra','geometry','coding','corporate_job','design','car_parts','machine_learning','physics_units'),type_conv=conv_nms)
-FORGE_DEBUG = EnvVariable('FORGE_LOG_LEVEL',default=('chemistry','astronomy','linear_algebra','geometry','coding','corporate_job','design','car_parts','machine_learning','physics_units'),type_conv=conv_nms)
-
-

-[docs]
-def name_generator(instance):
-    """a name generator for the instance"""
-    base = str(instance.__class__.__name__).lower()+'-'
-    if instance.__class__._use_random_name:
-        out =base+ randomname.get_name(adj=NAME_ADJ.secret,noun=NAME_NOUN.secret)
-    else:
-        out = base
-    log.debug(f"generated name: {out}")
-    return out

-
-
-PROTECTED_NAMES = ['solver','dataframe','_anything_changed']
-
-# Wraps Configuration with a decorator, similar to @attrs.define(**options)
-

-[docs]
-def forge(cls=None, **kwargs):
-    """Wrap all Configurations with this decorator with the following behavior
-    1) we use the callback when any property changes
-    2) repr is default
-    3) hash is by object identity"""
-
-    # Define defaults and handle conflicts
-    dflts = dict(repr=False, eq=False, slots=False, kw_only=True, hash=False)
-    for k, v in kwargs.items():
-        if k in dflts:
-            dflts.pop(k)
-
-    if cls is not None:
-        # we can't import system here since cls might be system, so look for any system subclasses
-        if "System" in [c.__name__ for c in cls.mro()]:
-            log.info(f"Configuring System: {cls.__name__}")
-            acls = attr.s(
-                cls,
-                on_setattr=property_changed,
-                field_transformer=signals_slots_handler,
-                **dflts,
-                **kwargs,
-            )
-
-            # must be here since can't inspect till after fields corrected
-            acls.pre_compile()  # custom class compiler
-            acls.validate_class()
-            if acls.__name__ != "Configuration":  # prevent configuration lookup
-                acls.compile_classes()  # compile subclasses
-            return acls
-
-        # Component/Config Flow
-        log.msg(f"Configuring: {cls.__name__}")
-        acls = attr.s(
-            cls,
-            on_setattr=property_changed,
-            field_transformer=comp_transform,
-            **dflts,
-            **kwargs,
-        )
-        if FORGE_DEBUG.in_env:
-            change_all_log_levels(inst=acls,new_log_level=FORGE_DEBUG.secret)        
-        # must be here since can't inspect till after fields corrected
-        acls.pre_compile()  # custom class compiler
-        acls.validate_class()
-        if acls.__name__ != "Configuration":  # prevent configuration lookup
-            acls.compile_classes()  # compile subclasses
-        return acls
-
-    else:
-
-        def f(cls, *args):
-            return forge(cls, **kwargs)
-        
-        f.__name__ ==  "forge_wrapper"
-
-        return f

-
-
-
-

-[docs]
-def meta(title, desc=None, **kwargs):
-    """a convienience wrapper to add metadata to attr.ib
-    :param title: a title that gets formatted for column headers
-    :param desc: a description of the property"""
-    out = {
-        "label": title.replace(".", "_").replace("-", "_").title(),
-        "desc": None,
-        **kwargs,
-    }
-    return out

-
-
-
-# Class Definition Wrapper Methods
-

-[docs]
-def property_changed(instance, variable, value):
-    """a callback for when a property changes, this will set the _anything_changed flag to True, and change value when appropriate"""
-    from engforge.tabulation import TabulationMixin
-    from engforge.problem_context import ProblemExec
-
-    #TODO: determine when, in an active problem if components change, and update refs accordingly!
-
-    if not isinstance(instance, (TabulationMixin)):
-        return value
-    
-    #Establish Active Session
-    session = None
-    if hasattr(ProblemExec.class_cache, "session"):
-        session = ProblemExec.class_cache.session
-
-    if not session and instance._anything_changed:
-        # Bypass Check since we've already flagged for an update
-        if log.log_level <= 2:
-            log.debug(f"already property changed {instance}{variable.name} {value}")
-        return value
-    #log.info(f'property changed {variable.name} {value}')
-
-    if log.log_level <= 6:
-        log.debug(f"checking property changed {instance}{variable.name} {value}")
-
-    #Check if should be updated
-    cur = getattr(instance, variable.name)
-    attrs = attr.fields(instance.__class__) #check identity of variable
-    if not instance._anything_changed and variable in attrs and value != cur:
-        if log.log_level < 5:
-            log.debug(f"changing variables: {variable.name} {value}")
-        instance._anything_changed = True
-
-    elif log.log_level < 4 and variable in attrs:
-        log.warning(
-            f"didnt change variables {variable.name}| {value} == {cur}"
-        )
-    
-    #If active session in dynamic mode and the component is dynamic, flag for matrix update
-    #TODO: determine if dynamic matricies affected by this.
-    
-    if session and session.dynamic_solve and instance.is_dynamic:
-        #log.info(f'dynamics changed')
-        session.dynamics_updated = True #flag for update
-        
-    elif session:
-        #log.info(f'static change')
-        session.dynamics_updated = False
-
-    return value

-
-
-
-# Class Definition Wrapper Methods
-

-[docs]
-def signals_slots_handler(
-    cls, fields, slots=True, signals=True, solvers=True, sys=True, plots=True
-):
-    """
-    creates attributes as per the attrs.define field_transformer use case.
-
-    Customize initalization with slots,signals,solvers and sys flags.
-    """
-    from engforge.problem_context import ProblemExec
-
-    log.debug(f"transforming signals and slots for {cls.__name__}")
-
-    for t in fields:
-        if t.name in PROTECTED_NAMES:
-            raise Exception(f"cannot use {t.name} as a field name, its protected")        
-        if t.type is None:
-            log.warning(f"{cls.__name__}.{t.name} has no type")
-
-    out = []
-    field_names = set([o.name for o in fields])
-    log.debug(f"fields: {field_names}")
-
-    #Add Fields (no underscored fields)
-    in_fields = {f.name: f for f in fields if not f.name.startswith("_") }
-    if "name" in in_fields:
-        name = in_fields.pop("name")
-        out.append(name)
-
-    else:
-        log.warning(f"{cls.__name__} does not have a name!")
-        name = attrs.Attribute(
-            name="name",
-            default=attrs.Factory(name_generator, True),
-            validator=None,
-            repr=True,
-            cmp=None,
-            eq=True,
-            eq_key=None,
-            order=True,
-            order_key=None,
-            hash=None,
-            init=True,
-            metadata=None,
-            type=str,
-            converter=None,
-            kw_only=True,
-            inherited=True,
-            on_setattr=None,
-            alias="name",
-        )
-        out.append(name)
-
-    # Add Slots
-    if slots:
-        for slot_name, slot in cls.slots_attributes().items():
-            at = slot.make_attribute(slot_name, cls)
-            out.append(at)
-
-    # Add Signals
-    if signals:
-        for signal_name, signal in cls.signals_attributes().items():
-            at = signal.make_attribute(signal_name, cls)
-            out.append(at)
-
-    # Add SOLVERS
-    if solvers:
-        for solver_name, solver in cls.solvers_attributes().items():
-            at = solver.make_attribute(solver_name, cls)
-            out.append(at)
-
-        # Add Time
-        for solver_name, solver in cls.transients_attributes().items():
-            # add from cls since not accessible from attrs
-            at = solver.make_attribute(solver_name, cls)
-            out.append(at)
-
-    if plots:
-        for pltname, plot in cls.plot_attributes().items():
-            at = plot.make_attribute(pltname, cls)
-            out.append(at)
-
-        for pltname, plot in cls.trace_attributes().items():
-            at = plot.make_attribute(pltname, cls)
-            out.append(at)
-
-    created_fields = set([o.name for o in out])
-
-    # Merge Fields Checking if we are overriding an attribute with system_property
-    # hack since TabulationMixin isn't available yet
-    if "TabulationMixin" in str(cls.mro()):
-        cls_properties = cls.system_properties_classdef(True)
-    else:
-        cls_properties = {}
-    cls_dict = cls.__dict__.copy()
-    cls.__anony_store = {}
-    # print(f'tab found!! {cls_properties.keys()}')
-    for k, o in in_fields.items():
-        if k not in created_fields:
-            if k in cls_properties and o.inherited:
-                log.warning(
-                    f"{cls.__name__} overriding inherited attr: {o.name} as a system property overriding it"
-                )
-            elif o.inherited and k in cls_dict:
-                log.debug(
-                    f"{cls.__name__} overriding inherited attr: {o.name} as {cls_dict[k]} in cls"
-                )
-                #FIXME: should we deepcopy?
-                cls.__anony_store[k] = sscb = lambda: copy.copy(cls_dict[k])
-                out.append(o.evolve(default=attrs.Factory(sscb)))
-            else:
-                log.msg(f"{cls.__name__} adding attr: {o.name}")
-                out.append(o)
-        else:
-            log.warning(
-                f"{cls.__name__} skipping inherited attr: {o.name} as a custom type overriding it"
-            )
-
-    # Enforce Property Changing
-    # FIXME: is this more reliable than a class wide callback?
-    # real_out = []
-    # for fld in out:
-    #     if fld.type in (int,float,str):
-    #         #log.warning(f"setting property changed on {fld}")
-    #         fld = fld.evolve(on_setattr = property_changed)
-    #         real_out.append(fld)
-    #     else:
-    #         real_out.append(fld)
-    # #return real_out
-    return out

-
-
-
-# alternate initalisers
-comp_transform = lambda c, f: signals_slots_handler(
-    c, f, slots=True, signals=True, solvers=True, sys=False, plots=False
-)
-
-
-
-# TODO: Make A MetaClass for Configuration, and provide forge interface there. Problem with replaceing metaclass later, as in the case of a singleton.
-

-[docs]
-@forge
-class Configuration(AttributedBaseMixin):
-    """Configuration is a pattern for storing attributes that might change frequently, and proivdes the core functionality for a host of different applications.
-
-    Configuration is able to go through itself and its objects and map all included Configurations, just to a specific level.
-
-    Common functionality includes an __on_init__ wrapper for attrs post-init method
-    """
-
-    _temp_vars = None
-
-    _use_random_name: bool = True
-    name: str = attr.ib(
-        default=attrs.Factory(name_generator, True),
-        validator=attr.validators.instance_of(str),
-        kw_only=True,
-    )
-
-    log_fmt = "[%(name)-24s]%(message)s"
-    log_silo = True
-
-    _created_datetime = None
-    _subclass_init: bool = True
-
-    # Configuration Information
-

-[docs]
-    def internal_configurations(self, check_config=True, use_dict=True,none_ok=False) -> dict:
-        """go through all attributes determining which are configuration objects
-        additionally this skip any configuration that start with an underscore (private variable)
-        """
-        from engforge.configuration import Configuration
-        slots = self.slots_attributes()
-
-        if check_config:
-            chk = lambda k, v: isinstance(v, Configuration)
-        else:
-            chk = lambda k, v: k in slots and (none_ok or v is not None)
-
-        obj = self.__dict__
-        if not use_dict:  # slots
-            obj = {k: obj.get(k, None) for k in slots}
-
-        return {
-            k: v for k, v in obj.items() if chk(k, v) and not k.startswith("_")
-        }

-
-
-

-[docs]
-    def copy_config_at_state(
-        self, level=None, levels_deep: int = -1, changed: dict = None, **kw
-    ):
-        """copy the system at the current state recrusively to a certain level, by default copying everything
-        :param levels_deep: how many levels deep to copy, -1 is all
-        :param level: the current level, defaults to 0 if not set
-        """
-        from engforge.configuration import Configuration
-        from engforge.components import SolveableInterface
-
-        if changed is None:
-            # top!
-            changed = {}
-
-        if self in changed:
-            self.debug(f"already changed {self}")
-            return changed[self]
-
-        if level is None:
-            level = 0
-            # at top level add parent to changed to prevent infinte parent recursion
-            changed[self] = None
-
-        # exit early if below the level
-        if level >= levels_deep and levels_deep > 0:
-            self.debug(f"below level {level} {levels_deep} {self}")
-            new_sys = attrs.evolve(self)  # copy as is
-            changed[self] = new_sys
-            return new_sys
-
-        # copy the internal configurations
-        kwcomps = {}
-        for key, config in self.internal_configurations().items():
-            self.debug(f"copying {key} {config} {level} {changed}")
-            # copy the system
-            if config in changed:
-                ccomp = changed[config]
-            else:
-                ccomp = config.copy_config_at_state(
-                    level + 1, levels_deep, changed
-                )
-            kwcomps[key] = ccomp
-
-        # Finally make the new system with changed internals
-        self.debug(f"changing with changes {self} {kwcomps} {kw}")
-        new_sys = attrs.evolve(self, **kwcomps, **kw)
-        changed[self] = new_sys 
-
-        #Finally change references!
-        if isinstance(new_sys, SolveableInterface):
-            new_sys.system_references(recache=True)
-
-        #update the parents
-        if hasattr(self,'parent'):
-            if self.parent in changed:
-                new_sys.parent = changed[self.parent]
-
-        return new_sys

-
-
-

-[docs]
-    def go_through_configurations(
-        self, level=0, levels_to_descend=-1, parent_level=0, only_inst=True,**kw
-    ):
-        """A generator that will go through all internal configurations up to a certain level
-        if levels_to_descend is less than 0 ie(-1) it will go down, if it 0, None, or False it will
-        only go through this configuration
-
-        :return: level,config"""
-        from engforge.configuration import Configuration
-
-        should_yield_level = lambda level: all(
-            [
-                level >= parent_level,
-                any([levels_to_descend < 0, level <= levels_to_descend]),
-            ]
-        )
-
-        if should_yield_level(level):
-            yield "", level, self
-
-        level += 1
-        if "check_config" not in kw:
-            kw["check_config"] = False
-        
-        for key, config in self.internal_configurations(**kw).items():
-            if isinstance(config, Configuration):
-                for skey, level, iconf in config.go_through_configurations(
-                    level, levels_to_descend, parent_level
-                ):
-                    if not only_inst or iconf is not None :
-                        yield f"{key}.{skey}" if skey else key, level, iconf
-            else:
-                if not only_inst or config is not None :
-                    yield key, level, config

-
-
-    # Our Special Init Methodology
-    def __on_init__(self):
-        """Override this when creating your special init functionality, you must use attrs for input variables, this is called after parents are assigned. subclasses are always called after"""
-        pass
-
-    def __pre_init__(self):
-        """Override this when creating your special init functionality, you must use attrs for input variables, this is called before parents are assigned"""
-        pass
-
-    def __attrs_post_init__(self):
-        """This is called after __init__ by attr's functionality, we expose __oninit__ for you to use!"""
-        # Store abs path On Creation, in case we change
-
-        from engforge.components import Component
-
-        self._log = None
-        self._anything_changed = True  # save by default first go!
-        self._created_datetime = datetime.datetime.utcnow()
-
-        # subclass instance instance init causes conflicts in structures ect
-        self.__pre_init__()
-        if self._subclass_init:
-            try:
-                for comp in self.__class__.mro():
-                    if hasattr(comp, "__pre_init__") and comp.__pre_init__ != Configuration.__pre_init__:
-                        comp.__pre_init__(self)
-            except Exception as e:
-                self.error(e, f"error in __pre_init__ {e}")
-
-        # Assign Parents, ensure single componsition
-        #TODO: allow multi-parent, w/wo keeping state, state swap on update()?
-        #TODO: replace parent concept with problem context
-        for compnm, comp in self.internal_configurations(False).items():
-            if isinstance(comp, Component):
-                # TODO: allow multiple parents
-                if (not hasattr(comp, "parent")) and (comp.parent is not None):
-                    self.warning(
-                        f"Component {compnm} already has a parent {comp.parent} copying, and assigning to {self}"
-                    )
-                    setattr(self, compnm, attrs.evolve(comp, parent=self))
-                else:
-                    comp.parent = self
-
-        self.debug(f"created {self.identity}")
-
-        # subclass instance instance init causes conflicts in structures
-        self.__on_init__()
-        if self._subclass_init:
-            try:
-                for comp in self.__class__.mro():
-                    if hasattr(comp, "__on_init__") and comp.__on_init__ != Configuration.__on_init__:
-                        comp.__on_init__(self)
-            except Exception as e:
-                self.error(e, f"error in __on_init__")
-
-

-[docs]
-    @classmethod
-    def validate_class(cls):
-        """A customizeable validator at the end of class creation in forge"""
-        return

-
-
-

-[docs]
-    @classmethod
-    def pre_compile(cls):
-        """an overrideable classmethod that executes when compiled, however will not execute as a subclass"""
-        pass

-
-
-

-[docs]
-    @classmethod
-    def compile_classes(cls):
-        """compiles all subclass functionality"""
-        cls.cls_compile()
-        for subcls in cls.parent_configurations_cls():
-            if subcls.subcls_compile is not Configuration:
-                log.debug(f"{cls.__name__} compiling {subcls.__name__}")
-            subcls.subcls_compile()

-
-
-

-[docs]
-    @classmethod
-    def cls_compile(cls):
-        """compiles this class, override this to compile functionality for this class"""
-        pass

-
-
-

-[docs]
-    @classmethod
-    def subcls_compile(cls):
-        """reliably compiles this method even for subclasses, override this to compile functionality for subclass interfaces & mixins"""
-        pass

-
-
-

-[docs]
-    @classmethod
-    def parent_configurations_cls(cls) -> list:
-        """returns all subclasses that are a Configuration"""
-        return [c for c in cls.mro() if issubclass(c, Configuration)]

-
-
-    # Identity & location Methods
-    @property
-    def filename(self):
-        """A nice to have, good to override"""
-        fil = (
-            self.identity.replace(" ", "_")
-            .replace("-", "_")
-            .replace(":", "")
-            .replace("|", "_")
-            .title()
-        )
-        filename = "".join(
-            [
-                c
-                for c in fil
-                if c.isalpha() or c.isdigit() or c == "_" or c == "-"
-            ]
-        ).rstrip()
-        return filename
-
-    @property
-    def displayname(self):
-        dn = (
-            self.identity.replace("_", " ")
-            .replace("|", " ")
-            .replace("-", " ")
-            .replace("  ", " ")
-            .title()
-        )
-        # dispname = "".join([c for c in dn if c.isalpha() or c.isdigit() or c=='_' or c=='-']).rstrip()
-        return dn
-
-    @property
-    def identity(self):
-        """A customizeable property that will be in the log by default"""
-        if not self.name or self.name == "default":
-            return self.classname.lower()
-        if self.classname in self.name:
-            return self.name.lower()
-        return f"{self.classname}-{self.name}".lower()
-
-    @property
-    def classname(self):
-        """Shorthand for the classname"""
-        return str(type(self).__name__).lower()
-
-    # Structural Orchestration Through Subclassing
-

-[docs]
-    @classmethod
-    def subclasses(cls, out=None):
-        """return all subclasses of components, including their subclasses
-        :param out: out is to pass when the middle of a recursive operation, do not use it!
-        """
-
-        # init the set by default
-        if out is None:
-            out = set()
-
-        for cls in cls.__subclasses__():
-            out.add(cls)
-            cls.subclasses(out)
-
-        return out

-

-
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/dataframe.html b/docs/_build/html/_modules/engforge/dataframe.html deleted file mode 100644 index d160710..0000000 --- a/docs/_build/html/_modules/engforge/dataframe.html +++ /dev/null @@ -1,310 +0,0 @@ - - - - - - engforge.dataframe — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.dataframe

-"""Dataframe Module:
-
-Store data in dataframes and provide a simple interface to manipulate it.
-"""
-
-from contextlib import contextmanager
-import attr
-
-from engforge.common import inst_vectorize, chunks
-from engforge.properties import engforge_prop
-# from engforge.configuration import Configuration, forge
-from engforge.logging import LoggingMixin
-from engforge.typing import *
-from engforge.properties import *
-from typing import Callable
-
-import numpy
-import pandas
-import os
-import collections
-import uuid
-
-
-

-[docs]
-class DataFrameLog(LoggingMixin):
-    pass

-
-
-
-log = DataFrameLog()
-
-
-# Dataframe interrogation functions
-

-[docs]
-def is_uniform(s: pandas.Series):
-    a = s.to_numpy()  # s.values (pandas<0.24)
-    if (a[0] == a).all():
-        return True
-    try:
-        if not numpy.isfinite(a).any():
-            return True
-    except:
-        pass
-    return False

-
-
-
-# key_func = lambda kv: len(kv[0].split('.'))*len(kv[1])
-# length of matches / length of key
-key_func = lambda kv: len(kv[1]) / len(kv[0].split("."))
-# key_func = lambda kv: len(kv[1])
-
-
-# TODO: remove duplicate columns
-# mtches = collections.defaultdict(set)
-# dfv = ecs.dataframe_variants[0]
-# for v1,v2 in itertools.combinations(dfv.columns,2):
-#     if numpy.all(dfv[v1]==dfv[v2]):
-#
-#         mtches[v1].add(v2)
-#         mtches[v2].add(v1)
-
-#TODO: integrate statistical output of dataframe, if at all in problem domain
-#1. stats_mode: mean, median,min,max mode, std, var, skew, kurtosis
-#2. min_mode: mean,median,std,min,max
-#3. sub_mode: store the dataframe completely separately
-

-[docs]
-class dataframe_property(engforge_prop):
-    pass

-
-
-
-#aliases
-dataframe_prop = dataframe_property
-df_prop = dataframe_property
-
-
-

-[docs]
-def determine_split(raw, top: int = 1, key_f=key_func):
-    parents = {}
-
-    for rw in raw:
-        grp = rw.split(".")
-        for i in range(len(grp)):
-            tkn = ".".join(grp[0 : i + 1])
-            parents[tkn] = set()
-
-    for rw in raw:
-        for par in parents:
-            if rw.startswith(par):
-                parents[par].add(rw)
-
-    grps = sorted(parents.items(), key=key_f, reverse=True)[:top]
-    return [g[0] for g in grps]

-
-
-
-

-[docs]
-def split_dataframe(df: pandas.DataFrame) -> tuple:
-    """split dataframe into a dictionary of invariants and a dataframe of variable values
-
-    :returns tuple: constants,dataframe
-    """
-    uniform = {}
-    for s in df:
-        c = df[s]
-        if is_uniform(c):
-            uniform[s] = c[0]
-
-    df_unique = df.copy().drop(columns=list(uniform))
-    return uniform, df_unique if len(df_unique) > 0 else df_unique

-
-
-
-

-[docs]
-class DataframeMixin:
-    dataframe: pandas.DataFrame
-
-    _split_dataframe_func = split_dataframe
-    _determine_split_func = determine_split
-
-

-[docs]
-    def smart_split_dataframe(self, df=None, split_groups=0, key_f=key_func):
-        """splits dataframe between constant values and variants"""
-        if df is None:
-            df = self.dataframe
-        out = {}
-        const, vardf = split_dataframe(df)
-        out["constants"] = const
-        columns = set(vardf.columns)
-        split_groups = min(split_groups, len(columns) - 1)
-        if split_groups == 0:
-            out["variants"] = vardf
-        else:
-            nconst = {}
-            cgrp = determine_split(const, min(split_groups, len(const) - 1))
-            for i, grp in enumerate(sorted(cgrp, reverse=True)):
-                columns = set(const)
-                bad_columns = [c for c in columns if not c.startswith(grp)]
-                good_columns = [c for c in columns if c.startswith(grp)]
-                nconst[grp] = {c: const[c] for c in good_columns}
-                for c in good_columns:
-                    if c in columns:
-                        columns.remove(c)
-            out["constants"] = nconst
-
-            raw = sorted(set(df.columns))
-            grps = determine_split(raw, split_groups, key_f=key_f)
-
-            for i, grp in enumerate(sorted(grps, reverse=True)):
-                columns = set(vardf.columns)
-                bad_columns = [c for c in columns if not c.startswith(grp)]
-                good_columns = [c for c in columns if c.startswith(grp)]
-                out[grp] = vardf.copy().drop(columns=bad_columns)
-                # remove columns from vardf
-                vardf = vardf.drop(columns=good_columns)
-            if vardf.size > 0:
-                out["misc"] = vardf
-        return out

-
-
-    @solver_cached
-    def _split_dataframe(self):
-        """splits dataframe between constant values and variants"""
-        return split_dataframe(self.dataframe)
-
-    @property
-    def dataframe_constants(self):
-        return self._split_dataframe[0]
-
-    @property
-    def dataframe_variants(self):
-        o = self._split_dataframe[1:]
-        if isinstance(o, (list,tuple)):
-            if len(o) == 1:
-                return o[0]
-        return o
-
-    def format_columns(self, dataframe: pandas.DataFrame):
-        dataframe.rename(
-            lambda x: x.replace(".", "_").lower(), axis="columns", inplace=True
-        )
-
-    # Plotting Interface
-    @property
-    def skip_plot_vars(self) -> list:
-        """accesses '_skip_plot_vars' if it exists, otherwise returns empty list"""
-        if hasattr(self, "_skip_plot_vars"):
-            return [var.lower() for var in self._skip_plot_vars]
-        return []
-
-    @property
-    def dataframe(self):
-        """returns the dataframe"""
-        raise NotImplementedError("must be implemented in subclass")

-
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/datastores/data.html b/docs/_build/html/_modules/engforge/datastores/data.html deleted file mode 100644 index fb93eb6..0000000 --- a/docs/_build/html/_modules/engforge/datastores/data.html +++ /dev/null @@ -1,677 +0,0 @@ - - - - - - engforge.datastores.data — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.datastores.data

-from sqlalchemy import *
-from sqlalchemy.ext.declarative import declarative_base
-from sqlalchemy.orm import sessionmaker
-from sqlalchemy.orm import relationship
-from sqlalchemy.orm import backref
-from sqlalchemy.orm import scoped_session
-from sqlalchemy_utils import *
-
-import functools
-
-import os, sys
-import logging
-import numpy
-import time
-import signal
-import functools
-import time
-from urllib.request import urlopen
-from psycopg2.extensions import register_adapter, AsIs
-import psycopg2
-
-import cachetools
-
-from engforge.env_var import EnvVariable
-from engforge.patterns import SingletonMeta, InputSingletonMeta
-from engforge.logging import (
-    LoggingMixin,
-    change_all_log_levels,
-)
-from engforge.locations import client_path
-
-from engforge.common import is_ec2_instance
-from engforge.tabulation import *  # This should be considered a module of data
-
-from sqlalchemy_batch_inserts import enable_batch_inserting
-
-from contextlib import contextmanager
-
-import diskcache
-
-log = logging.getLogger("engforge-data")
-
-# Env Vars
-DB_NAME = EnvVariable("FORGE_DB_NAME", dontovrride=True)
-DB_HOST = EnvVariable("FORGE_DB_HOST", default="localhost", dontovrride=True)
-DB_PORT = EnvVariable("FORGE_DB_PORT", int, default=5432, dontovrride=True)
-DB_USER = EnvVariable("FORGE_DB_USER", default="postgres", dontovrride=True)
-DB_PASS = EnvVariable("FORGE_DB_PASS", default="postgres", dontovrride=True)
-
-
-

-[docs]
-def addapt_numpy_float64(numpy_float64):
-    return AsIs(numpy_float64)

-
-
-
-

-[docs]
-def addapt_numpy_int64(numpy_int64):
-    return AsIs(numpy_int64)

-
-
-
-

-[docs]
-def addapt_numpy_float32(numpy_float32):
-    return AsIs(numpy_float32)

-
-
-
-

-[docs]
-def addapt_numpy_int32(numpy_int32):
-    return AsIs(numpy_int32)

-
-
-
-

-[docs]
-def addapt_numpy_array(numpy_array):
-    return AsIs(tuple(numpy_array))

-
-
-
-register_adapter(numpy.float64, addapt_numpy_float64)
-register_adapter(numpy.int64, addapt_numpy_int64)
-register_adapter(numpy.float32, addapt_numpy_float32)
-register_adapter(numpy.int32, addapt_numpy_int32)
-register_adapter(numpy.ndarray, addapt_numpy_array)
-
-
-# This handles nans (which present as floats)!
-

-[docs]
-def nan_to_null(f):
-    if not numpy.isnan(f) and not numpy.isinf(f):
-        return psycopg2.extensions.Float(f)
-    return AsIs("NULL")

-
-
-
-register_adapter(float, nan_to_null)
-
-DataBase = declarative_base()
-
-# TODO: Get this ray remote decorator working, issues with structure reliability
-# @ray.remote
-# class RemoteFunctionCache():
-
-#     def __init__(self, func, maxsize=1024):
-#         self.func = cachetools.cached(cachetools.LRUCache(maxsize=maxsize))(func)
-
-#     def call(self, key, *args, **kwargs):
-#         return self.func(key,*args, **kwargs)
-
-# class CachingMaybeRemoteFunc:
-#     _cache = None
-
-#     def __init__(self, func,maxsize=1024):
-#         self.func = cachetools.cached(cachetools.LRUCache(maxsize=maxsize))(func)
-
-#     @property
-#     def cache(self):
-#         if self._cache is not None:
-#             return self._cache
-
-#         elif ray.is_initialized():
-#             self._cache = RemoteFunctionCache.remote(self.func,maxsize=maxsize)
-
-#         return self._cache #will be None when not using ray
-
-#     def select_call(self,key,*args, **kwargs):
-#         if self.cache is not None:
-#             log.info(f'getting with remote {key}')
-#             obj = self.cache.call.remote(key, *args, **kwargs)
-#             return obj.get()
-
-#         else:
-#             log.info(f'getting local {key}')
-#             return self.func(key, *args, **kwargs)
-
-#     def __call__(self, key, *args, **kwargs):
-#         log.info(f'__call__ {key}')
-#         out = self.select_call( key, *args, **kwargs )
-#         log.info(f'got value for {key}: {out}')
-#         return out
-
-
-# def ray_cache(func):
-#     return CachingMaybeRemoteFunc(func)
-
-import numpy as np
-import matplotlib.pyplot as pl
-from scipy.fftpack import fft, ifft
-
-
-

-[docs]
-def autocorrelation_fft(x):
-    xp = ifftshift((x - np.average(x)) / np.std(x))
-    (n,) = xp.shape
-    xp = np.r_[xp[: n // 2], np.zeros_like(xp), xp[n // 2 :]]
-    f = fft(xp)
-    p = np.absolute(f) ** 2
-    pi = ifft(p)
-    return np.real(pi)[: n // 2] / (np.arange(n // 2)[::-1] + n // 2)

-
-
-
-

-[docs]
-def autocorrelation_direct(x):
-    maxdelay = int(len(x) / 5)
-    N = len(x)
-    mean = np.average(x)
-    var = np.var(x)
-    xp = (x - mean) / np.sqrt(var)
-    autocorrelation = np.zeros(maxdelay)
-    for r in range(maxdelay):
-        for k in range(N - r):
-            autocorrelation[r] += xp[k] * xp[k + r]
-        autocorrelation[r] /= float(N - r)
-    return autocorrelation

-
-
-
-

-[docs]
-def autocorrelation_numpy(x):
-    xp = (x - np.mean(x)) / np.std(x)
-    result = np.correlate(xp, xp, mode="full")
-    return result[int(result.size / 2) :] / len(xp)

-
-
-
-# def main():
-#     t = np.linspace(0,20,1024)
-#     x = np.exp(-t**2)
-#     pl.plot(t[:200], autocorrelation_fft(x)[:200],label='scipy fft')
-#     pl.plot(t[:200], autocorrelation_direct(x)[:200],label='direct autocorrelation')
-#     pl.plot(t[:200], autocorrelation_numpy(x)[:200],label='numpy correlate')
-#     pl.legend()
-#     pl.show()
-
-
-# @singleton_meta_object
-

-[docs]
-class DiskCacheStore(LoggingMixin, metaclass=SingletonMeta):
-    """A singleton object with safe methods for file access,
-    Aims to prevent large number of file pointers open
-
-    These should be subclassed for each cache location you want"""
-
-    _cache = None
-    size_limit = 10e9  # 10GB
-    alt_path = None
-    cache_class = diskcache.Cache
-    timeout = 1.0
-    cache_init_kwargs = None
-
-    last_expire = None
-    _current_keys = None
-    expire_threshold = 60.0
-
-    retries = 3
-    sleep_time = 0.1
-
-    def __init__(self, **kwargs):
-        if kwargs:
-            self.cache_init_kwargs = kwargs
-        else:
-            self.cache_init_kwargs = {}
-        self.info(f"Created DiskCacheStore In {self.cache_root}")
-        self.cache
-
-    @property
-    def cache_root(self):
-        # TODO: CHECK CACHE IS NOT SYNCED TO DROPBOX
-        if self.alt_path is not None:
-            return os.path.join(
-                client_path(skip_wsl=False), "cache", self.alt_path
-            )
-        return os.path.join(
-            client_path(skip_wsl=False),
-            "cache",
-            "{}".format(type(self).__name__).lower(),
-        )
-
-    @property
-    def cache(self):
-        if self._cache is None:
-            self.debug("setting cache")
-            self._cache = self.cache_class(
-                self.cache_root,
-                timeout=self.timeout,
-                size_limit=self.size_limit,
-                **self.cache_init_kwargs,
-            )
-        return self._cache
-
-

-[docs]
-    def set(self, key=None, data=None, retry=True, ttl=None, **kwargs):
-        """Passes default arguments to set the key:data relationship
-        :param expire: time in seconds to expire the data
-        """
-        if ttl is None:
-            ttl = self.retries  # onstart
-        self.last_expire = None
-
-        try:
-            with self.cache as ch:
-                ch.set(key, data, retry=retry, **kwargs)
-
-        except Exception as e:
-            ttl -= 1
-            if ttl > 0:
-                time.sleep(self.sleep_time * (self.retries - ttl))
-                return self.set(key=key, data=data, retry=True, ttl=ttl)
-            else:
-                self.error(e, "Issue Getting Item From Cache")

-
-
-    # @ray_cache
-

-[docs]
-    def get(self, key=None, on_missing=None, retry=True, ttl=None):
-        """Helper method to get an item, return None it doesn't exist and warn.
-        :param on_missing: a callback to use if the data is missing, which will set the data at the key, and return it
-        """
-        if ttl is None:
-            ttl = self.retries  # onstart
-
-        try:
-            with self.cache as ch:
-                if key in ch:
-                    return ch.get(key, retry=retry)
-                else:
-                    if on_missing is not None:
-                        data = on_missing()
-                        self.set(key=key, data=data)
-                        return data
-                    self.warning("key {} not in cache".format(key))
-            return None
-
-        except Exception as e:
-            ttl -= 1
-            if ttl > 0:
-                time.sleep(self.sleep_time * (self.retries - ttl))
-                return self.get(
-                    key=key, on_missing=on_missing, retry=True, ttl=ttl
-                )
-            else:
-                self.error(e, "Issue Getting Item From Cache")

-
-
-

-[docs]
-    def expire(self):
-        """wrapper for diskcache expire method that only permits expiration on a certain interval
-        :return: bool, True if expired called"""
-        now = time.time()
-        if (
-            self.last_expire is None
-            or now - self.last_expire > self.expire_threshold
-        ):
-            self.cache.expire()
-            self.last_expire = now
-            return True
-        return False

-
-
-    @property
-    def current_keys(self):
-        has_new_keys = self.expire()  # will be updated locally max every 60s
-        if has_new_keys or self._current_keys is None:
-            self._current_keys = set(list(self.cache))
-
-        return self._current_keys
-
-    def __iter__(self):
-        return self.cache.__iter__()
-
-    @property
-    def identity(self):
-        return "{}".format(self.__class__.__name__.lower())
-
-    def __getstate__(self):
-        d = self.__dict__.copy()
-        d["_cache"] = None  # don't pickle file objects!
-        return d
-
-    def __setstate__(self, d):
-        for key, val in d.items():
-            self.__dict__[key] = val
-        self.cache  # create cache

-
-
-
-

-[docs]
-class DBConnection(LoggingMixin, metaclass=InputSingletonMeta):
-    """A database singleton that is thread safe and pickleable (serializable)
-    to get the active instance use DBConnection.instance(**non_default_connection_args)
-    """
-
-    # TODO: Make Threadsafe W/ ThreadPoolExecutor!
-    # we love postgres!
-    _connection_template = (
-        "postgresql://{user}:{passd}@{host}:{port}/{database}"
-    )
-
-    pool_size = 20
-    max_overflow = 0
-    echo = False
-
-    dbname = None
-    host = None
-    user = None
-    passd = None
-    port = 5432
-
-    # Reset
-    connection_string = None
-    engine = None
-    scopefunc = None
-    session_factory = None
-    Session = None
-
-    _batchmode = False
-
-    connect_args = {"connect_timeout": 5}
-
-    def __init__(
-        self, database_name=None, host=None, user=None, passd=None, **kwargs
-    ):
-        """On the Singleton DBconnection.instance(): __init__(*args,**kwargs) will get called, technically you
-        could do it this way but won't be thread safe, or a single instance
-        :param database_name: the name for the database inside the db server
-        :param host: hostname
-        :param user: username
-        :param passd: password
-        :param port: hostname
-        :param echo: if the engine echos or not"""
-        self.info("initalizing db connection")
-        # Get ENV Defaults
-
-        if database_name is not None:
-            self.dbname = database_name
-        else:
-            self.dbname = DB_NAME.secret
-
-        if host is not None:
-            self.host = host
-        else:
-            self.host = HOST = DB_HOST.secret
-
-        if user is not None:
-            self.user = user
-        else:
-            self.user = USER = DB_USER.secret
-
-        if passd is not None:
-            self.info("Getting DB pass arg")
-            self.passd = passd
-        else:
-            self.passd = PASS = DB_PASS.secret
-
-        # Args with defaults
-        if "port" in kwargs:
-            self.port = kwargs["port"]
-        else:
-            self.port = DB_PORT.secret
-
-        if "echo" in kwargs:
-            self.echo = kwargs["echo"]
-        else:
-            self.echo = False
-
-        if "batchmode" in kwargs:
-            self._batchmode = True  # kwargs['batchmode']
-
-        self.resetLog()
-        self.configure()
-
-

-[docs]
-    def configure(self):
-        """A boilerplate configure method"""
-        self.info("Configuring...")
-        self.connection_string = self._connection_template.format(
-            host=self.host,
-            user=self.user,
-            passd=self.passd,
-            port=self.port,
-            database=self.dbname,
-        )
-        extra_args = {}
-        if self._batchmode:
-            extra_args["executemany_mode"] = "values"
-
-        self.engine = create_engine(
-            self.connection_string,
-            pool_size=self.pool_size,
-            max_overflow=self.max_overflow,
-            connect_args={"connect_timeout": 5},
-            **extra_args,
-        )
-        self.engine.echo = self.echo
-
-        # self.scopefunc = functools.partial(context.get, "uuid")
-
-        self.session_factory = sessionmaker(
-            bind=self.engine, expire_on_commit=True
-        )
-        self.Session = scoped_session(self.session_factory)

-
-
-

-[docs]
-    @contextmanager
-    def session_scope(self):
-        """Provide a transactional scope around a series of operations."""
-        if not hasattr(self, "Session"):
-            self.configure()
-        session = self.Session()
-        try:
-            if self._batchmode:
-                enable_batch_inserting(session)
-
-            yield session
-            session.commit()
-        except:
-            session.rollback()
-            raise
-        finally:
-            session.close()
-        del session

-
-
-

-[docs]
-    def rebuild_database(self, confirm=True):
-        """Rebuild database on confirmation, create the database if nessicary"""
-        if not is_ec2_instance():
-            answer = input(
-                "We Are Going To Overwrite The Databse {}\nType 'CONFIRM' to continue:\n".format(
-                    HOST
-                )
-            )
-        else:
-            answer = "CONFIRM"
-
-        if answer == "CONFIRM" or confirm == False:
-            # Create Database If It Doesn't Exist
-            if not database_exists(self.connection_string):
-                self.info("Creating Database")
-                create_database(self.connection_string)
-            else:
-                # Otherwise Just Drop The Tables
-                self.debug("Dropping DB Metadata")
-                DataBase.metadata.drop_all(self.engine)
-            # (Re)Create Tables
-            self.debug("Creating DB Metadata")
-            DataBase.metadata.create_all(self.engine)
-        else:
-            try:
-                raise Exception("Ah ah ah you didn't say the magic word")
-            except Exception as e:
-                self.error(e)

-
-
-

-[docs]
-    def ensure_database_exists(self, create_meta=True):
-        """Check if database exists, if not create it and tables"""
-        self.info(f"checking database existinence... {self.engine}")
-        if not database_exists(self.connection_string):
-            self.info("doesn't exist, creating database!")
-            create_database(self.connection_string)
-            if create_meta:
-                DataBase.metadata.create_all(self.engine)

-
-
-    def cleanup_sessions(self):
-        self.info("Closing All Active Sessions")
-        self.Session.close_all()
-
-    @property
-    def identity(self):
-        return "DB Con: {s.user}@{s.dbname}".format(s=self)
-
-    def __getstate__(self):
-        """Remove active connection objects, they are not picklable"""
-        # TODO: Should we remove credentials? How do we distibute object
-        d = self.__dict__.copy()
-        d["connection_string"] = None
-        d["engine"] = None
-        d["scopefunc"] = None
-        d["session_factory"] = None
-        d["Session"] = None
-        return d
-
-    def __setstate__(self, d):
-        """We reconfigure on opening a pickle"""
-        self.__dict__ = d
-        self.configure()

-
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/dynamics.html b/docs/_build/html/_modules/engforge/dynamics.html deleted file mode 100644 index 7dc2f6c..0000000 --- a/docs/_build/html/_modules/engforge/dynamics.html +++ /dev/null @@ -1,859 +0,0 @@ - - - - - - engforge.dynamics — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.dynamics

-"""Combines the tabulation and component mixins to create a mixin for systems and components that have dynamics, such as state space models, while allowing nonlinear dynamics via matrix modification
-
-This module is intended to work alongside the solver module and the Time integrating attributes, and will raise an error if a conflict is detected.
-
-The DynamicsMixin works by establishing a state matricies A, B, C, and D, which are used to define the dynamics of the system. The state matrix A is the primary matrix, and is used to define the state dynamics of the system. The input matrix B is used to define the input dynamics of the system. The output matrix C is used to define the output dynamics of the system. The feedthrough matrix D is used to define the feedthrough dynamics of the system.
-
-As opposed to the Time attribute, which modifies the state of the system, the DynamicsMixin copies the initial values of the state and input which then are integrated over time. At predefined intervals the control and output will stored in the tabulation.
-
-#TODO: The top level system will collect the underlying dynamical systems and combine them to an index and overall state space model. This will allow for the creation of a system of systems, and the ability to create a system of systems with a single state space model.
-
-#TODO: integration is done by the solver, where DynamicSystems have individual solver control, solver control is set for a smart default scipy 
-"""
-
-from engforge.configuration import Configuration, forge
-from engforge.tabulation import TabulationMixin
-from engforge import properties as prop
-from engforge.attributes import ATTR_BASE
-from engforge.properties import instance_cached, solver_cached
-from engforge.system_reference import Ref
-from engforge.problem_context import ProblemExec
-from engforge.solveable import (
-    SolveableMixin,
-    refmin_solve,
-    refset_get,
-    refset_input,
-)
-
-
-from collections import OrderedDict
-import numpy as np
-import pandas
-import expiringdict
-import attr, attrs
-
-
-# Index maps are used to translate between different indexes (local & global)
-
-

-[docs]
-def valid_mtx(arr):
-    if arr is None:
-        return False
-    elif arr.size == 0:
-        return 0
-    return True

-
-
-##TODO: compile problems using index_map
-#TODO: move to problem module
-

-[docs]
-class INDEX_MAP:
-    oppo = {str: int, int: str}
-
-    def __init__(self, datas: list):
-        self.data = [
-            data if not data.startswith(".") else data[1:] for data in datas
-        ]
-        self.index = {}
-
-    def get(self, key):
-        if key.startswith("."):
-            key = key[1:]
-        if key not in self.index:
-            self.index[key] = self.data.index(key)
-        return self.index[key]
-
-    def __getitem__(self, key):
-        if key.startswith("."):
-            key = key[1:]
-        return self.get(key)
-
-

-[docs]
-    def __call__(self, key):
-        if key.startswith("."):
-            key = key[1:]
-        return self.get(key)

-
-
-    @staticmethod
-    def indify(arr, *args):
-        return [
-            arr[arg] if isinstance(arg, int) else arr.index(arg) for arg in args
-        ]
-
-    def remap_indexes_to(self, new_index, *args, invert=False, old_data=None):
-        if old_data is None:
-            old_data = self.data
-        opt1 = {arg: self.indify(old_data, arg)[0] for arg in args}
-        opt2 = {
-            arg: self.indify(old_data, val)[0]
-            if (not isinstance(val, str))
-            else val
-            for arg, val in opt1.items()
-        }
-        oop1 = {
-            arg: self.indify(new_index, val)[0] for arg, val in opt2.items()
-        }
-        oop2 = {
-            arg: self.indify(new_index, val)[0]
-            if (invert != isinstance(val, self.oppo[arg.__class__]))
-            else val
-            for arg, val in oop1.items()
-        }
-        return oop2

-
-
-
-
-
-
-# Quickly create a state space model
-# TODO: How to add delay, and feedback?
-# TODO: How to add control and limits in general?
-# TODO: add time as a state variable
-

-[docs]
-@forge
-class DynamicsMixin(Configuration, SolveableMixin):
-    """dynamic mixin for components and systems that have dynamics, such as state space models, while allowing nonlinear dynamics via matrix modification. This mixin is intended to work alongside the solver module and the Time integrating attributes, and will raise an error if a conflict is detected #TODO."""
-
-    #time: float = attrs.field(default=0.0)
-
-    dynamic_state_vars: list = []#attrs.field(factory=list)
-    dynamic_input_vars: list =  []#attrs.field(factory=list)
-    dynamic_output_vars: list =  []#attrs.field(factory=list)
-
-    # state variables
-    dynamic_A = None
-    dynamic_B = None
-    dynamic_C = None
-    dynamic_D = None
-    dynamic_F = None
-    dynamic_K = None
-
-    # Static linear state
-    static_A= None
-    static_B= None
-    static_C= None
-    static_D= None
-    static_F= None
-    static_K= None
-
-    # TODO:
-    # dynamic_control_module = None
-    # control_interval:float = 0.0 ##TODO: how often to update the control
-    # TODO: how often to update the physics, 0 is everytime
-    update_interval: float =  0
-    #delay_ms: float = attrs.field(default=None)
-    nonlinear: bool = False
-
-    # TODO: add integration state dynamic cache to handle relative time steps
-    # TODO: add control module with PID control and pole placement design
-
-    #### State Space Model
-    def __pre_init__(self, **kwargs):
-        """override this method to define the class"""
-        # fields =
-        fields = attrs.fields_dict(self.__class__)
-        system_property = self.system_properties_def
-        for p in self.dynamic_state_vars:
-            assert p in fields, f"state var {p} not in attr: {fields}"
-        for p in self.dynamic_output_vars:
-            assert p in fields, f"output var {p} not in attr: {fields}"
-        for p in self.dynamic_input_vars:
-            assert p in fields, f"input var {p} not in attr: {fields}"
-
-    @property
-    def time(self):
-        #convience function 
-        ctx = getattr(self,'last_context',None)
-        if ctx:
-            time = getattr(ctx,'_time',0)
-        else:
-            time = 0
-        return time
-
-    @instance_cached
-    def is_dynamic(self):
-        if self.dynamic_state_vars:
-            return True
-        return False
-
-    @instance_cached
-    def dynamic_state_size(self):
-        return len(self.dynamic_state_vars)
-
-    @instance_cached
-    def dynamic_input_size(self):
-        return len(self.dynamic_input_vars)
-
-    @instance_cached
-    def dynamic_output_size(self):
-        return len(self.dynamic_output_vars)
-
-    @property
-    def dynamic_state(self) -> np.array:
-        return np.array(
-            [getattr(self, var, np.nan) for var in self.dynamic_state_vars]
-        )
-
-    @property
-    def dynamic_input(self) -> np.array:
-        return np.array(
-            [getattr(self, var, np.nan) for var in self.dynamic_input_vars]
-        )
-
-    @property
-    def dynamic_output(self) -> np.array:
-        return np.array(
-            [getattr(self, var, np.nan) for var in self.dynamic_output_vars]
-        )
-
-
-

-[docs]
-    def create_state_matrix(self, **kwargs) -> np.ndarray:
-        """creates the state matrix for the system"""
-        return np.zeros((self.dynamic_state_size, self.dynamic_state_size))

-
-
-

-[docs]
-    def create_input_matrix(self, **kwargs) -> np.ndarray:
-        """creates the input matrix for the system, called B"""
-        return np.zeros((self.dynamic_state_size, max(self.dynamic_input_size, 1)))

-
-
-

-[docs]
-    def create_output_matrix(self, **kwargs) -> np.ndarray:
-        """creates the input matrix for the system, called C"""
-        return np.zeros((max(self.dynamic_output_size, 1), self.dynamic_state_size))

-
-
-

-[docs]
-    def create_feedthrough_matrix(self, **kwargs) -> np.ndarray:
-        """creates the input matrix for the system, called D"""
-        return np.zeros((max(self.dynamic_output_size, 1), max(self.dynamic_input_size, 1)))

-
-
-

-[docs]
-    def create_state_constants(self, **kwargs) -> np.ndarray:
-        """creates the input matrix for the system, called F"""
-        return np.zeros(self.dynamic_state_size)

-
-
-

-[docs]
-    def create_output_constants(self, **kwargs) -> np.ndarray:
-        """creates the input matrix for the system, called O"""
-        return np.zeros(self.dynamic_output_size)

-
-
-

-[docs]
-    def create_dynamic_matricies(self, **kw):
-        """creates a dynamics object for the system"""
-        # State + Control
-        self.static_A = self.create_state_matrix(**kw)
-        self.static_B = self.create_input_matrix(**kw)
-        # Output
-        self.static_C = self.create_output_matrix(**kw)
-        self.static_D = self.create_feedthrough_matrix(**kw)
-        # Constants
-        self.static_F = self.create_state_constants(**kw)
-        self.static_K = self.create_output_constants(**kw)
-
-        if self.nonlinear:
-            self.update_dynamics(0, self.dynamic_state, self.dynamic_input)

-
-
-    # Nonlinear Support
-    # Override these callbacks to modify the state space model
-

-[docs]
-    def update_state(self, t, A, X) -> np.ndarray:
-        """override"""
-        return A

-
-
-

-[docs]
-    def update_input(self, t, B, X, U) -> np.ndarray:
-        """override"""
-        return B

-
-
-

-[docs]
-    def update_output_matrix(self, t, C, X) -> np.ndarray:
-        """override"""
-        return C

-
-
-

-[docs]
-    def update_feedthrough(self, t, D, X, U) -> np.ndarray:
-        """override"""
-        return D

-
-
-

-[docs]
-    def update_state_constants(self, t, F, X) -> np.ndarray:
-        """override"""
-        return F

-
-
-

-[docs]
-    def update_output_constants(self, t, O, X) -> np.ndarray:
-        """override"""
-        return O

-
-
-

-[docs]
-    def update_dynamics(self, t, X, U):
-        """Updates dynamics when nonlinear is enabled, otherwise it will do nothing"""
-        if not self.nonlinear:
-            return
-
-        # try: #NOTE: try catch adds a lot of overhead
-        # State + Control
-        self.dynamic_A = self.update_state(t, self.static_A, X)
-        self.dynamic_B = self.update_input(t, self.static_B, X, U)
-
-        # Output
-        self.dynamic_C = self.update_output_matrix(t, self.static_C, X)
-        self.dynamic_D = self.update_feedthrough(t, self.static_D, X, U)
-
-        # Constants
-        self.dynamic_F = self.update_state_constants(t, self.static_F, X)
-        self.dynamic_K = self.update_output_constants(t, self.static_K, X)
-
-        if self.log_level <=4:
-            self.info(f'update_dynamics A:{self.dynamic_A} B:{self.dynamic_B} C:{self.dynamic_C} D:{self.dynamic_D} F:{self.dynamic_F} K:{self.dynamic_K}| time:{t} X:{X} U:{U}')

-
-
-        # except Exception as e:
-        #     self.warning(f'update dynamics failed! A:{self.dynamic_A} B:{self.dynamic_B} C:{self.dynamic_C} D:{self.dynamic_D} F:{self.dynamic_F} K:{self.dynamic_K}| time:{t} X:{X} U:{U}')
-        #     raise e         
-
-    # linear and nonlinear system level IO
-
-

-[docs]
-    def rate(self, t, dt, X, U, *args, **kwargs):
-        """simulate the system over the course of time.
-
-        Args:
-            dt (float): interval to integrate over in time
-            X (np.ndarray): state input
-            U (np.ndarray): control input
-            subsystems (bool, optional): simulate subsystems. Defaults to True.
-
-        Returns:
-            dataframe: tabulated data
-        """
-        if self.nonlinear:
-            return self.rate_nonlinear(t, dt, X, U, *args, **kwargs)
-        else:
-            return self.rate_linear(t, dt, X, U, *args, **kwargs)            

-
-
-

-[docs]
-    def rate_linear(self, t, dt, X, U=None):
-        """simulate the system over the course of time. Return time differential of the state."""
-        
-        O = 0
-        if valid_mtx(self.static_A) and valid_mtx(X):
-            O = self.static_A @ X
-
-        if valid_mtx(U) and valid_mtx(self.static_B):
-            O += self.static_B @ U
-
-        if valid_mtx(self.static_F):
-            O += self.static_F
-
-        return O

-
-
-

-[docs]
-    def linear_output(self, t, dt, X, U=None):
-        """simulate the system over the course of time. Return time differential of the state.
-
-        Args:
-            dt (float): interval to integrate over in time
-            X (np.ndarray): state input
-            U (np.ndarray): control input
-
-        Returns:
-            np.array: time differential of the state
-        """
-        O = 0
-        if valid_mtx(self.static_C) and valid_mtx(X):
-            O = self.static_C @ X
-
-        if valid_mtx(U) and valid_mtx(self.static_D):
-            O += self.static_D @ U
-
-        if valid_mtx(self.static_K):
-            O += self.static_K
-        return O

-
-
-

-[docs]
-    def rate_nonlinear(self, t, dt, X, U=None, update=True):
-        """simulate the system over the course of time. Return time differential of the state.
-
-        Args:
-            t (float): time
-            dt (float): interval to integrate over in time
-            X (np.ndarray): state input
-            U (np.ndarray): control input
-
-        Returns:
-            np.array: time differential of the state
-        """
-        if update:
-            self.update_dynamics(t, X, U)
-        
-        O = 0
-        if valid_mtx(self.dynamic_A) and valid_mtx(X):
-            O = O+self.dynamic_A @ X
-
-        if valid_mtx(U) and valid_mtx(self.dynamic_B):
-            O = O+self.dynamic_B @ U
-
-        if valid_mtx(self.dynamic_F):
-            O = O+self.dynamic_F
-        return O

-
-
-

-[docs]
-    def nonlinear_output(self, t, dt, X, U=None, update=True):
-        """simulate the system over the course of time. Return time differential of the state.
-
-        Args:
-            dt (float): interval to integrate over in time
-            X (np.ndarray): state input
-            U (np.ndarray): control input
-
-        Returns:
-            np.array: time differential of the state
-        """
-        if update:
-            self.update_dynamics(t, X, U)
-        
-        O = 0
-        if valid_mtx(self.dynamic_C)and valid_mtx(X):
-            O = O+self.dynamic_C @ X
-
-        if valid_mtx(U) and valid_mtx(self.dynamic_D):
-            O = O+self.dynamic_D @ U
-
-        if valid_mtx(self.dynamic_K):
-            O = O+self.dynamic_K
-        return O

-
-
-

-[docs]
-    def set_time(self, t, system=True,subcomponents=True):
-        """sets the time of the system and context"""
-        pass        
-        #set components
-        #if subcomponents:
-        #    for cdyn_name, comp in self.comp_times.items():
-        #        comp.set_value(t)
-
-        # if system: #set system time only
-        #     self.time = t
-
-
-    #@instance_cached #TODO: cache on solver due to changes of components
-    #def comp_times(self) -> dict:
-        """returns a dictionary of time references to components which will be set to the current time"""

-
-        # return {k: Ref(comp,'time',False,True) for k,l,comp in self.go_through_configurations() if isinstance(comp,DynamicsMixin)}
-
-    # optimized convience funcitons
-

-[docs]
-    def nonlinear_step(self, t, dt, X, U=None, set_Y=False):
-        """Optimal nonlinear steps"""
-        #self.time = t #important for simulation, moved to context.integrate
-        self.update_dynamics(t, X, U)
-        
-        dXdt = self.rate_nonlinear(t, dt, X, U, update=False)
-        out = self.nonlinear_output(t, dt, X, U, update=False)
-
-        if set_Y:
-            for i, p in enumerate(self.dynamic_output_vars):
-                self.Yt_ref[p].set_value(out[p])
-
-        return dXdt

-
-
-

-[docs]
-    def linear_step(self, t, dt, X, U=None, set_Y=False):
-        """Optimal nonlinear steps"""
-        #self.time = t #important for simulation, moved to context.integrate
-        self.update_dynamics(t, X, U)
-        dXdt = self.rate_linear(t, dt, X, U)
-        out = self.linear_output(t, dt, X, U)
-
-        if set_Y:
-            for i, p in enumerate(self.dynamic_output_vars):
-                self.Yt_ref[p].set_value(out[p])
-
-        return dXdt

-
-
-    def step(self, t, dt, X, U=None, set_Y=False):
-        try:
-            if self.nonlinear:
-                return self.nonlinear_step(t, dt, X, U, set_Y=set_Y)
-            else:
-                return self.linear_step(t, dt, X, U, set_Y=set_Y)
-            
-        except Exception as e:
-            self.warning(f'update dynamics failed {e}! A:{self.dynamic_A} B:{self.dynamic_B} C:{self.dynamic_C} D:{self.dynamic_D} F:{self.dynamic_F} K:{self.dynamic_K}| time:{t} X:{X} U:{U} setY:{set_Y}')
-            raise e
-
-    #Solver Refs
-    #TODO: move to problem context
-    @property
-    def Xt_ref(self):
-        """alias for state values"""
-        d = [(var, Ref(self, var)) for var in self.dynamic_state_vars]
-        return OrderedDict(d)
-
-    @property
-    def Yt_ref(self):
-        """alias for output values"""
-        d = [(var, Ref(self, var)) for var in self.dynamic_output_vars]
-        return OrderedDict(d)
-
-    @property
-    def Ut_ref(self):
-        """alias for input values"""
-        d = [(var, Ref(self, var)) for var in self.dynamic_input_vars]
-        return OrderedDict(d)
-    
-    @property
-    def dXtdt_ref(self):
-        """a dictionary of state var rates"""
-        d = [(var, self.ref_dXdt(var)) for var in self.dynamic_state_vars]
-        return OrderedDict(d)
-
-    @solver_cached
-    def cache_dXdt(self):
-        """caches the time differential of the state,
-        uses current state of X and U to determine the dXdt
-        """
-
-        #we need to check the active session to determine if we should refresh the problem matrix
-        if hasattr(ProblemExec.class_cache, "session"):
-            session = ProblemExec.class_cache.session
-            if session and session.dynamic_solve and self.is_dynamic:
-                if session.dxdt != True: #integration update is handeled, all others are some kind of SS.
-                    self.create_dynamic_matricies()
-
-        ctx = getattr(self,'last_context',None)
-        
-        if ctx:
-            time = getattr(ctx,'_time',0)
-            lt = getattr(ctx, "_last_time", 0)
-        else:
-            time = 0
-            lt = 0
-
-        dt = max(time - lt, 0)
-        step = self.step(time, dt, self.dynamic_state, self.dynamic_input)
-        if self.log_level <= 10:
-            self.debug(f"cache dXdt {time} {lt} {dt}| {step}")        
-        return step
-
-

-[docs]
-    def ref_dXdt(self, name: str):
-        """returns the reference to the time differential of the state"""
-        vars = self.dynamic_state_vars
-        assert name in vars, f"name {name} not in state vars"
-        inx = vars.index(name)
-        accss = lambda sys,prob: self.cache_dXdt[inx]
-        accss.__name__ = f"ref_dXdt_{name}"
-        return Ref(self, accss)

-
-    
-
-

-[docs]
-    def determine_nearest_stationary_state(
-        self, t=0, X=None, U=None
-    ) -> np.ndarray:
-        """determine the nearest stationary state"""
-
-        if X is None:
-            X = self.dynamic_state
-        if U is None:
-            U = self.dynamic_input
-
-        if self.nonlinear:
-            self.update_dynamics(t, X, U)
-            Mb = self.dynamic_B @ U if self.dynamic_input_size > 0 else 0
-            Mx = self.dynamic_F + Mb
-            return np.linalg.solve(self.dynamic_A, -Mx)
-
-        # static state
-        Mb = self.static_B @ U if self.dynamic_input_size > 0 else 0
-        Mx = Mb + self.static_F
-        return np.linalg.solve(self.static_A, -Mx)

-
-
-    def __hash__(self):
-        return hash(id(self))

-
-
-
-

-[docs]
-@forge
-class GlobalDynamics(DynamicsMixin):
-    """This object is inherited by configurations that collect other dynamicMixins and orchestrates their simulation, and steady state analysis
-
-    #TODO: establish bounds in solver
-    """
-
-

-[docs]
-    def setup_global_dynamics(self, **kwargs):
-        """recursively creates numeric matricies for the simulation"""
-        for skey,lvl,conf in self.go_through_configurations():
-            if isinstance(conf,DynamicsMixin) and conf.is_dynamic:
-                conf.create_dynamic_matricies(**kwargs)

-
-    
-
-

-[docs]
-    def sim_matrix(self, eval_kw=None, sys_kw=None, **kwargs):
-        """simulate the system over the course of time.
-        return a dictionary of dataframes
-        """
-        #
-        #from engforge.solver import SolveableMixin
-
-        dt = kwargs.pop('dt',0.001)
-        endtime = kwargs.pop('endtime',10)
-
-        with ProblemExec(self,kwargs,level_name='simmtx',dxdt=True,copy_system=True) as pbx:
-            if isinstance(self, SolveableMixin):
-                #adapt simulate to use the solver            
-                sim = lambda Xo,*args, **kw: self.simulate(
-                    dt, endtime,Xo, eval_kw=eval_kw, sys_kw=sys_kw,  **kw
-                )
-                out = self._iterate_input_matrix(
-                    sim,
-                    eval_kw=eval_kw,
-                    sys_kw=sys_kw,
-                    return_results=True,
-                    **kwargs,
-                )
-            else:
-                out =  self.simulate(dt, endtime, eval_kw=eval_kw, sys_kw=sys_kw)
-        return out

-
-
-    #TODO: swap between vars and constraints depending on dxdt=True
-

-[docs]
-    def simulate(
-        self,
-        dt,
-        endtime,
-        X0=None,
-        cb=None,
-        eval_kw=None,
-        sys_kw=None,
-        min_kw=None,
-        run_solver=False,
-        return_system=False,
-        return_data=False,
-        return_all=False,
-        debug_fail=False,
-        **kwargs,
-    ) -> pandas.DataFrame:
-        """runs a simulation over the course of time, and returns a dataframe of the results.
-
-        A copy of this system is made, and the simulation is run on the copy, so as to not affect the state of the original system.
-
-        #TODO: 
-        """
-        min_kw_dflt = {"method": "SLSQP"}
-        #'tol':1e-6,'options':{'maxiter':100}}
-        # min_kw_dflt = {'doset':True,'reset':False,'fail':True}
-        if min_kw is None:
-            min_kw = min_kw_dflt.copy()
-        else:
-            min_kw_dflt.update(min_kw)
-        mkw = min_kw_dflt
-
-        #force transient
-        kwargs['dxdt'] = True
-
-        #variables if failed
-        pbx,system = None,self
-        try:
-
-            #Time Iteration Context
-            data = []
-            with ProblemExec(system,kwargs,level_name='sim',dxdt=True,copy_system=True,run_solver=run_solver,post_callback=cb) as pbx:
-                self._sim_ans = pbx.integrate(endtime=endtime,dt=dt,X0=X0,eval_kw=eval_kw,sys_kw=sys_kw,**kwargs)
-                system = pbx.system #hello copy
-
-                #data = [{"time": k, **v} for k, v in  pbx.data.items()]
-
-                #this will affect the context copy, not self
-                pbx.exit_to_level('sim',False) 
-
-            # convert to list with time
-            #df = pandas.DataFrame(data)
-            #self.format_columns(df)
-            df = pbx.dataframe
-
-            #TODO: move to context
-            if return_all:
-                return system,(data if return_data else df)
-            if return_system:
-                return system        
-            if return_data:
-                return data        
-            return df
-
-        except Exception as e:
-            self.error(e,f"simulation failed, return (sys,prob)")
-            if debug_fail:
-                return system,pbx
-            raise e

-

-
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/eng/costs.html b/docs/_build/html/_modules/engforge/eng/costs.html deleted file mode 100644 index 876c8b1..0000000 --- a/docs/_build/html/_modules/engforge/eng/costs.html +++ /dev/null @@ -1,965 +0,0 @@ - - - - - - engforge.eng.costs — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.eng.costs

-
-"""Defines a CostModel & Economics Component that define & orchestrate cost accounting respectively.
-
-CostModels can have a `cost_per_item` and additionally calculate a `cumulative_cost` from internally defined `CostModel`s.
-
-CostModel's can have cost_property's which detail how and when a cost should be applied & grouped. By default each CostModel has a `cost_per_item` which is reflected in `item_cost` cost_property set on the `initial` term as a `unit` category. Multiple categories of cost are also able to be set on cost_properties as follows
-
-```
-@forge
-class Widget(Component,CostModel):
-
-    @cost_property(mode='initial',category='capex,manufacturing')
-    def cost_of_XYZ(self):
-        return ...
-```
-
-Economics models sum CostModel.cost_properties recursively on the parent they are defined. Economics computes the grouped category costs for each item recursively as well as summary properties like annualized values and levalized cost. Economic output is determined by a `fixed_output` or overriding `calculate_production(self,parent)` to dynamically calculate changing economics based on factors in the parent.
-
-Default costs can be set on any CostModel.Slot attribute, by using default_cost(<slot_name>,<cost>) on the class, this will provide a default cost for the slot if no cost is set on the instance. Custom costs can be set on the instance with custom_cost(<slot_name>,<cost>). If cost is a CostModel, it will be assigned to the slot if it is not already assigned.
-
-The economics term_length applies costs over the term, using the `cost_property.mode` to determine at which terms a cost should be applied.
-
-@forge
-class Parent(System,CostModel)
-
-    econ = Slot.define(Economics) #will calculate parent costs as well
-    cost = Slot.define(Widget) #slots automatically set to none if no input provided
-
-Parent(econ=Economics(term_length=25,discount_rate=0.05,fixed_output=1000))
-
-
-"""
-
-from engforge.components import Component
-from engforge.configuration import forge,Configuration
-from engforge.tabulation import TabulationMixin, system_property
-from engforge.system_reference import Ref
-from engforge.properties import instance_cached,solver_cached,cached_system_property
-from engforge.logging import LoggingMixin
-from engforge.component_collections import ComponentIter
-import typing
-import attrs
-import uuid
-import numpy
-import collections
-import pandas
-
-

-[docs]
-class CostLog(LoggingMixin):pass

-
-log = CostLog()
-
-#Cost Term Modes are a quick lookup for cost term support
-global COST_TERM_MODES,COST_CATEGORIES
-COST_TERM_MODES = {'initial': lambda inst,term: True if term < 1 else False,
-                   'maintenance': lambda inst,term: True if term >= 1 else False,
-                   'always': lambda inst,term: True}
-
-category_type = typing.Union[str,list]
-COST_CATEGORIES = set(('misc',))
-
-
-
-

-[docs]
-class cost_property(system_property):
-    """A thin wrapper over `system_property` that will be accounted by `Economics` Components and apply term & categorization
-
-    `cost_property` should return a float/int always and will raise an error if the return annotation is different, although annotations are not required and will default to float.
-
-    #Terms:
-    Terms start counting at 0 and can be evald by the Economic.term_length
-    cost_properties will return their value as system_properties do without regard for the term state, however a CostModel's costs at a term can be retrived by `costs_at_term`. The default mode is for `initial` cost
-
-    #Categories:
-    Categories are a way to report cost categories and multiple can be applied to a cost. Categories are grouped by the Economics system at reported in bulk by term and over the term_length
-    
-    """
-
-    cost_categories: list = None
-    term_mode: str = None
-
-    _all_modes: dict = COST_TERM_MODES
-    _all_categories:set = COST_CATEGORIES
-
-    def __init__(self, fget=None, fset=None, fdel=None, doc=None, desc=None, label=None, stochastic=False, mode:str='initial',category:category_type=None):
-        """extends system_property interface with mode & category keywords
-        :param mode: can be one of `initial`,`maintenance`,`always` or a function with signature f(inst,term) as an integer and returning a boolean True if it is to be applied durring that term.
-        """
-        super().__init__(fget, fset, fdel, doc, desc, label, stochastic)
-        if isinstance(mode,str):
-            mode = mode.lower()
-            assert mode in COST_TERM_MODES, f'mode: {mode} is not in {set(COST_TERM_MODES.keys())}'
-            self.term_mode = mode
-        elif callable(mode):
-            fid = str(uuid.uuid4())
-            self.__class__._all_modes[fid] = mode
-            self.term_mode = fid
-        else:
-            raise ValueError(f'mode: {mode} must be cost term str or callable')
-
-
-        if category is not None:
-            if isinstance(category,str):
-                self.cost_categories = category.split(',')
-            elif isinstance(category,list):
-                self.cost_categories = category
-            else:
-                raise ValueError(f'categories: {category} not string or list')
-            for cc in self.cost_categories:
-                self.__class__._all_categories.add(cc)
-        else:
-            self.cost_categories = ['misc']
-
-    def apply_at_term(self,inst,term):
-        if term < 0:
-            raise ValueError(f'negative term!')
-        if self.__class__._all_modes[self.term_mode](inst,term):
-            return True
-        return False
-
-

-[docs]
-    def get_func_return(self, func):
-        """ensures that the function has a return annotation, and that return annotation is in valid sort types"""
-        anno = func.__annotations__
-        typ = anno.get("return", None)
-        if typ is not None and not typ in (int, float):
-            raise Exception(
-                f"system_property input: function {func.__name__} must have valid return annotation of type: {(int,float)}"
-            )
-        else:
-            self.return_type = float

-

-
-
-

-[docs]
-@forge
-class CostModel(Configuration,TabulationMixin): 
-    """CostModel is a mixin for components or systems that reports its costs through the `cost` system property, which by default sums the `item_cost` and `sub_items_cost`.
-
-    `item_cost` is determined by `calculate_item_cost()` which by default uses: `cost_per_item` field to return the item cost, which defaults to `numpy.nan` if not set. Nan values are ignored and replaced with 0.
-    
-    `sub_items_cost` system_property summarizes the costs of any component in a Slot that has a `CostModel` or for SlotS which CostModel.declare_cost(`slot`,default=numeric|CostModelInst|dict[str,float])
-    """
-    _slot_costs: dict #TODO: insantiate per class
-
-    cost_per_item: float = attrs.field(default=numpy.nan)
-
-    def __on_init__(self):
-        self.set_default_costs()
-        self.debug(f'setting default costs {self._slot_costs}')
-
-

-[docs]
-    def update_dflt_costs(self):
-        """updates internal default slot costs if the current component doesn't exist or isn't a cost model, this is really a component method but we will use it never the less.
-        
-        This should be called from Component.update() if default costs are used
-        """
-        if self._slot_costs:
-            current_comps = self.internal_components()
-            for k,v in self._slot_costs.items():
-                #Check if the cost model will  be accessed
-                no_comp = k not in current_comps
-                is_cost = not no_comp and isinstance(current_comps[k],CostModel)
-                dflt_is_cost_comp = all([isinstance(v,CostModel),isinstance(v,Component)])
-                if no_comp and not is_cost and dflt_is_cost_comp:
-                    self.debug('Updating default {k}')
-                    v.update(self)

-
-                 
-

-[docs]
-    def set_default_costs(self):
-        """set default costs if no costs are set"""
-        inter_config = self.internal_configurations()
-        for k,dflt in self._slot_costs.items():
-            if k not in inter_config and isinstance(dflt,CostModel):
-                setattr(self,k,attrs.evolve(dflt,parent=self))
-            elif k not in inter_config and isinstance(dflt,type) and issubclass(dflt,CostModel):
-                self.warning(f'setting default cost {k} from costmodel class, provide a default instance instead!')
-                setattr(self,k,dflt())
-
-        #Reset cache
-        self.internal_components(True)

-
-    
-

-[docs]
-    @classmethod
-    def subcls_compile(cls):
-        assert not issubclass(cls,ComponentIter), 'component iter not supported'
-        log.debug(f'compiling costs {cls}')
-        cls.reset_cls_costs()

-
-
-    @classmethod
-    def reset_cls_costs(cls):
-        cls._slot_costs = {}
-
-
-

-[docs]
-    @classmethod
-    def default_cost(cls,slot_name:str,cost:typing.Union[float,'CostModel'],warn_on_non_costmodel=True):
-        """Provide a default cost for Slot items that are not CostModel's. Cost is applied class wide, but can be overriden with custom_cost per instance"""
-        assert not isinstance(cost,type), f'insantiate classes before adding as a cost!'
-        assert slot_name in cls.slots_attributes(), f'slot {slot_name} doesnt exist'
-        assert isinstance(cost,(float,int,dict)) or isinstance(cost,CostModel), 'only numeric types or CostModel instances supported'
-
-        atrb = cls.slots_attributes()[slot_name]
-        atypes = atrb.type.accepted
-        if warn_on_non_costmodel and not any([issubclass(at,CostModel) for at in atypes]):
-            log.warning(f'assigning cost to non CostModel based slot {slot_name}')
-
-        cls._slot_costs[slot_name] = cost

-
-
-        #IDEA: create slot if one doesn't exist, for dictionaries and assign a ComponentDict+CostModel in wide mode?
-
-

-[docs]
-    def custom_cost(self,slot_name:str,cost:typing.Union[float,'CostModel'],warn_on_non_costmodel=True):
-        """Takes class costs set, and creates a copy of the class costs, then applies the cost numeric or CostMethod in the same way but only for that instance of"""
-        assert not isinstance(cost,type), f'insantiate classes before adding as a cost!'
-        assert slot_name in self.slots_attributes(), f'slot {slot_name} doesnt exist'
-        assert isinstance(cost,(float,int,dict)) or isinstance(cost,CostModel), 'only numeric types or CostModel instances supported'
-
-        atrb = self.__class__.slots_attributes()[slot_name]
-        atypes = atrb.type.accepted
-        if warn_on_non_costmodel and not any([issubclass(at,CostModel) for at in atypes]):
-            self.warning(f'assigning cost to non CostModel based slot {slot_name}')
-
-        #convert from classinfo    
-        if self._slot_costs is self.__class__._slot_costs:
-            self._slot_costs =  self.__class__._slot_costs.copy()
-        self._slot_costs[slot_name] = cost
-        self.set_default_costs()

-
-    
-        #if the cost is a cost model, and there's nothing assigned to the slot, assign it
-        # if assign_when_missing and isinstance(cost,CostModel):
-        #     if hasattr(self,slot_name) and getattr(self,slot_name) is None:
-        #         self.info(f'assigning custom cost {slot_name} with {cost}')
-        #         setattr(self,slot_name,cost)
-        #     elif hasattr(self,slot_name):
-        #         self.warning(f'could not assign custom cost to {slot_name} with {cost}, already assigned to {getattr(self,slot_name)}')
-
-
-

-[docs]
-    def calculate_item_cost(self)->float:
-        """override this with a parametric model related to this systems attributes and properties"""
-        return self.cost_per_item

-
-    
-    @system_property
-    def sub_items_cost(self)->float:
-        """calculates the total cost of all sub-items, using the components CostModel if it is provided, and using the declared_cost as a backup"""
-        return self.sub_costs()
-
-    @cost_property(mode='initial',category='unit')
-    def item_cost(self)->float:
-        calc_item = self.calculate_item_cost()
-        return numpy.nansum([0,calc_item])
-
-    @system_property
-    def combine_cost(self)->float:
-        return self.sum_costs()
-    
-    @system_property
-    def itemized_costs(self)->float:
-        """sums costs of cost_property's in this item that are present at term=0"""
-        initial_costs = self.costs_at_term(0)
-        return numpy.nansum( list(initial_costs.values()) )
-    
-    @system_property
-    def future_costs(self)->float:
-        """sums costs of cost_property's in this item that do not appear at term=0"""
-        initial_costs = self.costs_at_term(0,False)
-        return numpy.nansum(list(initial_costs.values()))
-
-

-[docs]
-    def sum_costs(self,saved:set=None,categories:tuple=None,term=0):
-        """sums costs of cost_property's in this item that are present at term=0, and by category if define as input"""
-        if saved is None:
-            saved = set((self,)) #item cost included!
-        elif self not in saved:
-            saved.add(self)
-        itemcst = list(self.dict_itemized_costs(saved,categories,term).values())
-        csts = [self.sub_costs(saved,categories,term),numpy.nansum(itemcst)]
-        return numpy.nansum(csts)

-
-
-    def dict_itemized_costs(self,saved:set=None,categories:tuple=None,term=0,test_val = True)->dict:
-        ccp = self.class_cost_properties()
-        costs = {k: obj.__get__(self) if obj.apply_at_term(self,term)==test_val else 0 for k,obj in ccp.items() if categories is None or any([cc in categories for cc in obj.cost_categories])}
-        return costs
-         
-    
-

-[docs]
-    def sub_costs(self,saved:set=None,categories:tuple=None,term=0):
-        """gets items from CostModel's defined in a Slot attribute or in a slot default, tolerrant to nan's in cost definitions"""
-        if saved is None:
-            saved = set()
-
-        sub_tot = 0
-    
-        for slot in self.slots_attributes():
-            comp = getattr(self,slot)
-
-            if comp in saved:
-                #print(f'skipping {slot}:{comp}')
-                continue
-
-            elif isinstance(comp,Configuration):
-                saved.add(comp)
-
-            if isinstance(comp,CostModel):
-                sub = comp.sum_costs(saved,categories,term)
-                log.debug(f'{self.identity} adding: {comp.identity if comp else comp}: {sub}+{sub_tot}')
-                cst = [sub_tot,sub]
-                sub_tot = numpy.nansum(cst)
-
-            
-            elif slot in self._slot_costs and (categories is None or 'unit' in categories) and term==0:
-                #Add default costs from direct slots
-                dflt = self._slot_costs[slot]
-                sub = eval_slot_cost(dflt,saved)                
-                log.debug(f'sub: {self.identity} adding slot: {comp.identity if comp else comp}.{slot}: {sub}+{sub_tot}')
-                cst= [sub_tot,sub]
-                sub_tot  = numpy.nansum(cst)
-
-            #add base class slot values when comp was nonee
-            if comp is None:
-                #print(f'skipping {slot}:{comp}')
-                comp_cls = self.slots_attributes()[slot].type.accepted
-                for cc in comp_cls:
-                    if issubclass(cc,CostModel):
-                        if cc._slot_costs:
-                            for k,v in cc._slot_costs.items():
-                                sub = eval_slot_cost(v,saved)
-                                log.debug(f'sub: {self.identity} adding dflt: {slot}.{k}: {sub}+{sub_tot}')
-                                cst= [sub_tot,sub]
-                                sub_tot = numpy.nansum(cst)
-                            break #only add once
-                    
-
-        return sub_tot

-
-
-    #Cost Term & Category Reporting
-

-[docs]
-    def costs_at_term(self,term:int,test_val=True)->dict:
-        """returns a dictionary of all costs at term i, with zero if the mode 
-        function returns False at that term"""
-        ccp = self.class_cost_properties()
-        return {k: obj.__get__(self) if obj.apply_at_term(self,term)==test_val else 0 for k,obj in ccp.items()}        

-
-
-

-[docs]
-    @classmethod
-    def class_cost_properties(cls)->dict:
-        """returns cost_property objects from this class & subclasses"""
-        return {k:v for k,v in cls.system_properties_classdef().items() if isinstance(v,cost_property)}     

-
-    
-    @property
-    def cost_properties(self)->dict:
-        """returns the current values of the current properties"""
-        ccp = self.class_cost_properties()
-        return {k:obj.__get__(self) for k,obj in ccp.items()}
-    
-    @property
-    def cost_categories(self):
-        """returns itemized costs grouped by category"""
-        base = {cc:0 for cc in self.all_categories()}
-        for k,obj in self.class_cost_properties().items():
-            for cc in obj.cost_categories:
-                base[cc] += obj.__get__(self)
-        return base
-
-    def cost_categories_at_term(self,term:int):
-        base = {cc:0 for cc in self.all_categories()}
-        for k,obj in self.class_cost_properties().items():
-            if obj.apply_at_term(self,term):
-                for cc in obj.cost_categories:
-                    base[cc] += obj.__get__(self)    
-        return base            
-
-    @classmethod
-    def all_categories(self):
-        return COST_CATEGORIES

-
-
-cost_type = typing.Union[float,int,CostModel,dict]
-

-[docs]
-def eval_slot_cost(slot_item:cost_type,saved:set=None):
-    sub_tot = 0
-    log.debug(f'evaluating slot: {slot_item}')
-    if isinstance(slot_item,(float,int)):
-        sub_tot += numpy.nansum([slot_item,0])
-    elif isinstance(slot_item,CostModel):
-        sub_tot += numpy.nansum([slot_item.sum_costs(saved),0])
-    elif isinstance(slot_item,type) and issubclass(slot_item,CostModel):
-        log.warning(f'slot {slot_item} has class CostModel, using its `item_cost` only, create an instance to fully model the cost')
-        sub_tot = numpy.nansum([sub_tot,slot_item.cost_per_item ])
-    elif isinstance(slot_item,dict):
-        sub_tot += numpy.nansum(list(slot_item.values()))
-    return sub_tot

-
-
-

-[docs]
-def gend(deect:dict):
-    for k,v in deect.items():
-        if isinstance(v,dict):
-            for kk,v in gend(v):
-                yield f'{k}.{kk}',v
-        else:
-            yield k,v

-
-
-
-
-    
-parent_types = typing.Union[Component,'System']
-
-#TODO: automatically apply economics at problem level if cost_model present, no need for parent econ lookups
-

-[docs]
-@forge
-class Economics(Component): 
-    """Economics is a component that summarizes costs and reports the economics of a system and its components in a recursive format"""
-
-    term_length: int = attrs.field(default=0)
-    discount_rate: float = attrs.field(default=0.0)
-    fixed_output: float = attrs.field(default=numpy.nan)
-    output_type: str = attrs.field(default='generic')
-    terms_per_year: int = attrs.field(default=1)
-
-    _calc_output: float = None
-    _costs: float  = None
-    _cost_references: dict = None
-    _cost_categories: dict = None
-    _comp_categories: dict = None
-    _comp_costs: dict = None
-    parent:parent_types
-
-    def __on_init__(self):
-        self._cost_categories = collections.defaultdict(list)
-        self._comp_categories = collections.defaultdict(list)
-        self._comp_costs = dict()        
-
-

-[docs]
-    def update(self,parent:parent_types):
-        
-        if self.log_level <= 5 :
-            self.msg(f'econ updating costs: {parent}',lvl=5)
-        
-        self.parent = parent
-
-        #this is kinda expensive to do every time, but we need to do it to get the costs
-        self._gather_cost_references(parent)
-        self._calc_output = self.calculate_production(parent,0)
-        self._costs = self.calculate_costs(parent)
-
-        if self._calc_output is None:
-            self.warning(f'no economic output!')
-        if self._costs is None:
-            self.warning(f'no economic costs!')

-
-
-

-[docs]
-    def calculate_production(self,parent,term)->float:
-        """must override this function and set economic_output"""
-        return numpy.nansum([0,self.fixed_output])

-
-
-

-[docs]
-    def calculate_costs(self,parent)->float:
-        """recursively accounts for costs in the parent, its children recursively."""
-        return self.sum_cost_references()

-
-    
-    #Reference Utilitly Functions   
-    def sum_cost_references(self):
-        cst = 0
-        for k,v in self._cost_references.items():        
-            if k.endswith('item_cost'):
-                val = v.value()
-                if self.log_level < 2 : self.msg(f'add item cost: {k}|{val}')    
-                cst += val
-            else:
-                if self.log_level < 2 : self.msg(f'skip cost: {k}')
-        return cst
-
-    def sum_references(self,refs):
-        return numpy.nansum([r.value() for r in refs])
-        
-    def get_prop(self,ref):
-        if ref.use_dict:
-            return ref.key
-        elif ref.key in ref.comp.class_cost_properties():
-            return ref.comp.class_cost_properties()[ref.key]
-        # elif ref.key in ref.comp.system_properties_classdef():
-        #     return ref.comp.system_properties_classdef()[ref.key]
-        # else:
-        #     raise KeyError(f'ref key doesnt exist as property: {ref.key}')
-
-    def term_fgen(self,comp,prop):
-        if isinstance(comp,dict):
-            return lambda term: comp[prop] if term == 0 else 0
-        return lambda term: prop.__get__(comp) if prop.apply_at_term(comp,term) else 0
-
-    def sum_term_fgen(self,ref_group):
-        term_funs = [self.term_fgen(ref.comp,self.get_prop(ref)) 
-                            for ref in ref_group]
-        return lambda term: numpy.nansum([t(term) for t in term_funs])        
-
-    #Gather & Set References (the magic!)
-    #TODO: update internal_references callback to problem
-

-[docs]
-    def internal_references(self,recache=True,numeric_only=False):
-        """standard component references are """
-        d = self._gather_references()
-        self._create_term_eval_functions()
-        #Gather all internal economic variables and report costs
-        props = d['properties']
-        
-        #calculate lifecycle costs
-        lc_out = self.lifecycle_output
-
-        if self._cost_references:
-            props.update(**self._cost_references)
-
-        if self._cost_categories:
-            for key,refs in self._cost_categories.items():
-                props[key] = Ref(self._cost_categories,key,False,False,eval_f=self.sum_references)
-
-        if self._comp_categories:
-            for key,refs in self._comp_categories.items():
-                props[key] = Ref(self._comp_categories,key,False,False,eval_f=self.sum_references)    
-
-        for k,v in lc_out.items():
-            props[k] = Ref(lc_out,k,False,False)
-    
-        return d

-
-
-    @property
-    def lifecycle_output(self)->dict:
-        """return lifecycle calculations for lcoe"""
-        totals = {}
-        totals['category'] = lifecat = {}
-        totals['annualized'] = annul = {}
-        summary = {}
-        out = {'summary':summary,'lifecycle':totals}
-
-        lc = self.lifecycle_dataframe
-        for c in lc.columns:
-            if 'category' not in c and 'cost' not in c:
-                continue
-            tot = lc[c].sum()
-            if 'category' in c:
-                c_ = c.replace('category.','')
-                lifecat[c_] = tot
-            else:
-                totals[c] = tot
-            annul[c] = tot * self.terms_per_year / (self.term_length+1)
-
-        summary['total_cost'] = lc.term_cost.sum()
-        summary['years'] = lc.year.max()+1
-        LC = lc.levalized_cost.sum()
-        LO = lc.levalized_output.sum()
-        summary['levalized_cost'] =  LC / LO if LO != 0 else numpy.nan
-        summary['levalized_output'] = LO / LC if LC != 0 else numpy.nan 
-
-        out2 = dict(gend(out))
-        self._term_output = out2
-        return self._term_output
-
-
-    @property
-    def lifecycle_dataframe(self) -> pandas.DataFrame:
-        """simulates the economics lifecycle and stores the results in a term based dataframe"""    
-        out = []
-
-        if self.term_length == 0:
-            rng = [0]
-        else:
-            rng = list(range(0,self.term_length))
-        
-        for i in rng:
-            t = i
-            row = {'term':t,'year':t/self.terms_per_year}
-            out.append(row)
-            for k,sum_f in self._term_comp_category.items():
-                row[k] = sum_f(t)
-            for k,sum_f in self._term_cost_category.items():
-                row[k] = sum_f(t)
-            for k,sum_f in self._term_comp_cost.items():
-                row[k] = sum_f(t)
-            row['term_cost'] = tc = numpy.nansum([v(t) for v in self._term_comp_cost.values()])
-            row['levalized_cost'] = tc * (1+self.discount_rate)**(-1*t)
-            row['output'] = output =  self.calculate_production(self.parent,t)
-            row['levalized_output'] = output * (1+self.discount_rate)**(-1*t)
-
-
-        return pandas.DataFrame(out)
-
-
-    def _create_term_eval_functions(self):
-        """uses reference summation grouped by categories & component"""
-        self._term_comp_category = {}
-        if self._comp_categories:
-            for k,vrefs in self._comp_categories.items():
-                self._term_comp_category[k] = self.sum_term_fgen(vrefs)
-
-        self._term_cost_category = {}
-        if self._cost_categories:
-            for k,vrefs in self._cost_categories.items():
-                self._term_cost_category[k] = self.sum_term_fgen(vrefs)
-
-        self._term_comp_cost = {}
-        if self._comp_costs:
-            for k, ref in self._comp_costs.items():
-                prop = self.get_prop(ref)
-                self._term_comp_cost[k] = self.term_fgen(ref.comp,prop)
-        
-
-    def _gather_cost_references(self,parent:'System'):
-        """put many tabulation.Ref objects into a dictionary to act as additional references for this economics model.
-        
-        References are found from a walk through the parent slots through all child slots"""
-        self._cost_references = CST = {}
-        comps = {}
-        comp_set = set()
-
-        #reset data 
-        self._cost_categories = collections.defaultdict(list)
-        self._comp_categories = collections.defaultdict(list)
-        self._comp_costs = dict()
-
-        for key,level,conf in parent.go_through_configurations(check_config=False):
-            #skip self
-            if conf is self:
-                continue
-
-            bse = f'{key}.' if key else ''
-            #prevent duplicates'
-            if conf in comp_set:
-                continue
-                
-            elif isinstance(conf,Configuration):
-                comp_set.add(conf)
-            else:
-                comp_set.add(key)
-
-            _base = key.split('.')
-            kbase = '.'.join(_base[:-1])
-            comp_key = _base[-1]
-            
-            self.debug(f'checking {key} {comp_key} {kbase}')
-
-            #Get Costs Directly From the cost model instance
-            if isinstance(conf,CostModel):
-                comps[key] = conf
-                self.debug(f'adding cost model for {kbase}.{comp_key}')
-                self._extract_cost_references(conf,bse)
-                
-            #Look For defaults!
-            #1. try looking for already parsed components (top down)
-            elif kbase and kbase in comps:
-                child = comps[kbase]
-                if isinstance(child,CostModel) and comp_key in child.parent._slot_costs:
-                    self.debug(f'adding cost for {kbase}.{comp_key}')
-                    compcanidate = child._slot_costs[comp_key]
-                    if isinstance(compcanidate,CostModel):
-                        self.debug(f'dflt child costmodel {kbase}.{comp_key}')
-                        self._extract_cost_references(compcanidate,bse+'cost.')
-                    else:                    
-                        _key=bse+'cost.item_cost'
-                        self.debug(f'dflt child cost for {kbase}.{comp_key}')
-                        CST[_key] = ref = Ref(child._slot_costs,comp_key,False,False, eval_f = eval_slot_cost)
-                        cc = 'unit'
-                        self._comp_costs[_key] = ref
-                        self._cost_categories['category.'+cc].append(ref)
-                        self._comp_categories[bse+'category.'+cc].append(ref)
-            
-            #2. try looking at the parent
-            elif isinstance(parent,CostModel) and kbase == '' and comp_key in parent._slot_costs:
-                
-                compcanidate = parent._slot_costs[comp_key]
-                if isinstance(compcanidate,CostModel):
-                    self.debug(f'dflt parent cost model for {kbase}.{comp_key}')
-                    self._extract_cost_references(compcanidate,bse+'cost.')
-                else:
-                    self.debug(f'dflt parent cost for {kbase}.{comp_key}')
-                    _key=bse+'cost.item_cost'
-                    CST[_key] = ref = Ref(parent._slot_costs,comp_key,False,False, eval_f = eval_slot_cost)
-                    cc = 'unit'
-                    self._comp_costs[_key] = ref
-                    self._cost_categories['category.'+cc].append(ref)
-                    self._comp_categories[bse+'category.'+cc].append(ref)
-
-            else:
-                self.debug(f'unhandled cost: {key}')
-                    
-        self._cost_references = CST
-        self._anything_changed = True
-        return CST
-    
-    def _extract_cost_references(self,conf:'CostModel',bse:str):
-        #Add cost fields
-        _key = bse+'item_cost'
-        CST = self._cost_references
-        if self.log_level < 5:
-            self.msg(f'extracting costs from {bse}|{conf.identity}',lvl=5)
-
-        #cost properties of conf item
-        for cost_nm,cost_prop in conf.class_cost_properties().items():
-            _key=bse+'cost.'+cost_nm
-            CST[_key] = ref = Ref(conf,cost_nm,True,False)
-            self._comp_costs[_key] = ref
-
-            #If there are categories we'll add references to later sum them
-            if cost_prop.cost_categories:
-                for cc in cost_prop.cost_categories:
-                    self._cost_categories['category.'+cc].append(ref)
-                    self._comp_categories[bse+'category.'+cc].append(ref)
-            else:
-                #we'll reference it as misc
-                cc = 'misc'
-                self._cost_categories['category.'+cc].append(ref)
-                self._comp_categories[bse+'category.'+cc].append(ref)
-
-        comps_act = conf.internal_components()
-        if self.log_level < 10: self.msg(f'{conf.identity if conf else conf} active components: {comps_act}',lvl=5)
-        #add slot costs with current items (skip class defaults)
-        for slot_name, slot_value in conf._slot_costs.items():
-            #Skip items that are internal components
-            if slot_name in comps_act:
-                self.debug(f'skipping slot {slot_name}')
-                continue
-            else:
-                self.debug(f'adding slot {conf}.{slot_name}')
-            #Check if current slot isn't occupied
-            cur_slot = getattr(conf,slot_name)
-            _key = bse+slot_name+'.cost.item_cost'
-            if not isinstance(cur_slot,Configuration) and _key not in CST:
-                CST[_key] = ref = Ref(conf._slot_costs,slot_name,False,False,eval_f = eval_slot_cost)
-
-                cc = 'unit'
-                self._comp_costs[_key] = ref
-                self._cost_categories['category.'+cc].append(ref)
-                self._comp_categories[bse+'category.'+cc].append(ref)
-            
-            elif _key in CST:
-                self.debug(f'skipping key {_key}')
-
-        #add base class slot values when comp was none
-        for compnm,comp in conf.internal_configurations(False,none_ok=True).items():
-            if comp is None:
-                if self.log_level < 5: 
-                    self.msg(f'{conf} looking up base class costs for {compnm}',lvl=5)
-                comp_cls = conf.slots_attributes()[compnm].type.accepted
-                for cc in comp_cls:
-                    if issubclass(cc,CostModel):
-                        if cc._slot_costs:
-                            if self.log_level < 5: 
-                                self.msg(f'{conf} looking up base slot cost for {cc}')
-                            for k,v in cc._slot_costs.items():
-                                _key=bse+compnm+'.'+k+'.cost.item_cost'
-                                if _key in CST:
-                                    if self.log_level < 10: 
-                                        self.debug(f'{conf} skipping dflt key {_key}')
-                                    #break #skip if already added
-                                    continue
-
-                                if isinstance(v,CostModel):
-                                    self._extract_cost_references(v,bse+compnm+'.'+k+'.')
-                                else:
-                                    if self.log_level < 10: 
-                                        self.debug(f'adding missing cost for {conf}.{compnm}')
-                                    CST[_key] = ref = Ref(cc._slot_costs,k,False,False,eval_f = eval_slot_cost)
-
-                                    cc = 'unit'
-                                    self._comp_costs[_key] = ref
-                                    self._cost_categories['category.'+cc].append(ref)
-                                    self._comp_categories[bse+'category.'+cc].append(ref)
-                                
-                            break #only add once 
-
-            elif isinstance(comp,CostModel):
-                if self.log_level < 10: 
-                    self.debug(f'{conf} using actual costs for {comp}')
-
-    @property
-    def cost_references(self):
-        return self._cost_references
-
-    @system_property
-    def combine_cost(self)->float:
-        if self._costs is None:
-            return 0
-        return self._costs
-    
-    @system_property
-    def output(self)->float:
-        if self._calc_output is None:
-            return 0
-        return self._calc_output

-
-
-#TODO: add costs for iterable components (wide/narrow modes)
-# if isinstance(conf,ComponentIter):
-#     conf = conf.current
-#     #if isinstance(conf,CostModel):
-#     #    sub_tot += conf.item_cost
-# if isinstance(conf,ComponentIter):
-#     item = conf.current
-#     if conf.wide:
-#         items = item
-#     else:
-#         items = [items]
-# else:
-#     items = [conf]
-#for conf in items:
-
-
-# if isinstance(self,CostModel):
-#     sub_tot += self.item_cost
-
-#accomodate ComponentIter in wide mode
-# if isinstance(self,ComponentIter):
-#     item = self.current
-#     if self.wide:
-#         items = item
-#     else:
-#         items = [items]
-# else:
-#     items = [self]
-
-#accomodate ComponentIter in wide mode
-#for item in items:
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/eng/fluid_material.html b/docs/_build/html/_modules/engforge/eng/fluid_material.html deleted file mode 100644 index c486179..0000000 --- a/docs/_build/html/_modules/engforge/eng/fluid_material.html +++ /dev/null @@ -1,406 +0,0 @@ - - - - - - engforge.eng.fluid_material — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.eng.fluid_material

-from engforge.configuration import Configuration, forge
-from engforge.components import Component, system_property, forge
-
-
-import matplotlib
-import random
-import attr, attrs
-import numpy
-import inspect
-import sys
-
-import CoolProp
-from CoolProp.CoolProp import PropsSI
-import fluids
-import abc
-
-
-# TODO: add a exact fluid state (T,P) / (Q,P) in the concept of processes for each thermodynamic operation (isothermal,isobaric,heating...ect)
-
-STD_PRESSURE = 1e5  # pa
-STD_TEMP = 273 + 15
-
-
-

-[docs]
-@forge
-class FluidMaterial(Component):
-    """Placeholder for pressure dependent material, defaults to ideal water"""
-
-    P = attrs.field(default=STD_PRESSURE, type=float)
-    T = attrs.field(default=STD_TEMP, type=float)
-
-    @abc.abstractproperty
-    def density(self):
-        """default functionality, assumed gas with eq-state= gas constant"""
-        return 1000.0
-
-    @abc.abstractproperty
-    def viscosity(self):
-        """ideal fluid has no viscosity"""
-        return 1e-10
-
-    @abc.abstractproperty
-    def surface_tension(self):
-        return 1e-10

-
-
-    # TODO: enthalpy
-
-
-

-[docs]
-@forge
-class IdealGas(FluidMaterial):
-    """Material Defaults To Gas Properties, so eq_of_state is just Rgas, no viscosity, defaults to air"""
-
-    gas_constant = attrs.field(default=287.0, type=float)
-
-    @system_property
-    def density(self) -> float:
-        """default functionality, assumed gas with eq-state= gas constant"""
-        return self.P / (self.gas_constant * self.T)
-
-    @system_property
-    def viscosity(self) -> float:
-        """ideal fluid has no viscosity"""
-        return 1e-10

-
-
-    # @system_property
-    # def surface_tension(self):
-    #     return 0.0
-
-
-IdealAir = type("IdealAir", (IdealGas,), {"gas_constant": 287.0})
-IdealH2 = type("IdealH2", (IdealGas,), {"gas_constant": 4124.2})
-IdealOxygen = type("IdealOxygen", (IdealGas,), {"gas_constant": 259.8})
-IdealSteam = type("IdealSteam", (IdealGas,), {"gas_constant": 461.5})
-
-# @forge
-# class PerfectGas(FluidMaterial):
-#     '''A Calorically Perfect gas with viscosity'''
-#     eq_of_state = attrs.field()
-#     P = attrs.field(default=STD_PRESSURE, type=float)
-
-#     @system_property
-#     def density(self):
-#             '''default functionality, assumed gas with eq-state= gas constant'''
-#         return self.eq_of_state.density(T=self.T,P=self.P)
-
-#     @system_property
-#     def viscosity(self):
-#         '''ideal fluid has no viscosity'''
-#         return self.eq_of_state.viscosity(T=self.T,P=self.P)
-
-
-

-[docs]
-@forge
-class CoolPropMaterial(FluidMaterial):
-    """Uses coolprop equation of state"""
-
-    material: str
-
-    # TODO: handle phase changes with internal _quality that you can add heat to
-    _surf_tension_K = None
-    _surf_tension_Nm = None
-    _state = None
-
-    @property
-    def state(self):
-        if hasattr(self, "_force_state"):
-            return self._force_state
-        if self._state and not self.anything_changed:
-            return self._state
-        else:
-            tsat = self.Tsat
-            if abs(self.T - tsat) < 1e-4:
-                self._state = ("Q", 0, "P", self.P, self.material)
-            elif self.T > tsat:
-                self._state = ("T|gas", self.T, "P", self.P, self.material)
-            else:
-                self._state = ("T|liquid", self.T, "P", self.P, self.material)
-
-        return self._state
-
-    @system_property
-    def density(self) -> float:
-        """default functionality, assumed gas with eq-state= gas constant"""
-        return PropsSI("D", *self.state)
-
-    @system_property
-    def enthalpy(self) -> float:
-        return PropsSI("H", *self.state)
-
-    @system_property
-    def viscosity(self) -> float:
-        return PropsSI("V", *self.state)
-
-    @system_property
-    def surface_tension(self) -> float:
-        """returns liquid surface tension"""
-        if self._surf_tension_K and self._surf_tension_Nm:
-            X = self._surf_tension_K
-            Y = self._surf_tension_Nm
-            l = Y[0]
-            r = Y[-1]
-            return numpy.interp(self.T, xp=X, fp=Y, left=l, right=r)
-
-        self.debug("no surface tension model! returning 0")
-        return 0.0
-
-    @system_property
-    def thermal_conductivity(self) -> float:
-        """returns liquid thermal conductivity"""
-        return PropsSI("CONDUCTIVITY", *self.state)
-
-    @system_property
-    def specific_heat(self) -> float:
-        """returns liquid thermal conductivity"""
-        return PropsSI("C", *self.state)
-
-    @system_property
-    def Tsat(self) -> float:
-        return PropsSI("T", "Q", 0, "P", self.P, self.material)
-
-    @system_property
-    def Psat(self) -> float:
-        try:
-            return PropsSI("P", "Q", 0, "T", self.T, self.material)
-        except:
-            return numpy.nan
-
-

-[docs]
-    def __call__(self, *args, **kwargs):
-        """calls coolprop module with args adding the material"""
-        args = (*args, self.material)
-        return PropsSI(*args)

-

-
-
-
-# TODO: add water suface tenstion
-T_K = [
-    273.15,
-    278.15,
-    283.15,
-    293.15,
-    303.15,
-    313.15,
-    323.15,
-    333.15,
-    343.15,
-    353.15,
-    363.15,
-    373.15,
-    423.15,
-    473.15,
-    523.15,
-    573.15,
-    623.15,
-    647.25,
-]
-ST_NM = [
-    0.0756,
-    0.0749,
-    0.0742,
-    0.0728,
-    0.0712,
-    0.0696,
-    0.0679,
-    0.0662,
-    0.0644,
-    0.0626,
-    0.0608,
-    0.0589,
-    0.0482,
-    0.0376,
-    0.0264,
-    0.0147,
-    0.0037,
-    0.0,
-]
-
-
-Water = type(
-    "Water",
-    (CoolPropMaterial,),
-    {"material": "Water", "_surf_tension_K": T_K, "_surf_tension_Nm": ST_NM},
-)
-Air = type("Air", (CoolPropMaterial,), {"material": "Air"})
-Oxygen = type("Oxygen", (CoolPropMaterial,), {"material": "Oxygen"})
-Hydrogen = type("Hydrogen", (CoolPropMaterial,), {"material": "Hydrogen"})
-Steam = type(
-    "Steam",
-    (CoolPropMaterial,),
-    {
-        "material": "IF97:Water",
-        "_surf_tension_K": T_K,
-        "_surf_tension_Nm": ST_NM,
-    },
-)
-SeaWater = type(
-    "SeaWater",
-    (CoolPropMaterial,),
-    {"material": "MITSW", "_surf_tension_K": T_K, "_surf_tension_Nm": ST_NM},
-)
-
-# Create some useful mixed models
-
-
-

-[docs]
-@forge
-class CoolPropMixture(CoolPropMaterial):
-    """coolprop mixture of two elements... can only use T/Q, P/Q, T/P calls to coolprop"""
-
-    material1 = "Air"
-    materail2 = "Water"
-    _X = 1.0  # 1.0 > mole fraction of material > 0
-
-    @system_property
-    def material(self) -> str:
-        Xm = self._X
-        return f"{self.material1}[{Xm}]&{self.materail2}[{1.0-Xm}]"
-
-    @classmethod
-    def setup(cls):
-        try:
-            CoolProp.apply_simple_mixing_rule(
-                cls.material, cls.material2, "linear"
-            )
-        except Exception as e:
-            pass
-            # self.error(e,'issue setting mixing rule, but continuting.')
-
-    @system_property
-    def Mmass1(self) -> float:
-        return PropsSI("M", "T", self.T, "P", self.P, self.material1)
-
-    @system_property
-    def Mmass2(self) -> float:
-        return PropsSI("M", "T", self.T, "P", self.P, self.material2)
-
-

-[docs]
-    def update_mass_ratios(self, m1, m2):
-        """add masses or massrates and molar ratio will be updated"""
-        x1 = m1 / self.Mmass1
-        x2 = m2 / self.Mmass2
-        xtot = x1 + x2
-        self._X = x1 / xtot

-

-
-
-
-AirWaterMix = type("AirWaterMix", (CoolPropMixture,), {})
-AirWaterMix.setup()
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/eng/geometry.html b/docs/_build/html/_modules/engforge/eng/geometry.html deleted file mode 100644 index 88c5838..0000000 --- a/docs/_build/html/_modules/engforge/eng/geometry.html +++ /dev/null @@ -1,1097 +0,0 @@ - - - - - - engforge.eng.geometry — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.eng.geometry

-"""These exist as in interface to sectionproperties from PyNite"""
-
-from engforge.configuration import Configuration, forge, LoggingMixin
-from engforge.properties import (
-    cached_system_property,
-    system_property,
-    instance_cached,
-)
-from engforge.typing import Options
-from engforge.eng.prediction import PredictionMixin
-from engforge.env_var import EnvVariable
-import numpy
-import attr, attrs
-
-from scipy import optimize as skopt
-
-from sklearn import svm
-
-from sectionproperties.pre.geometry import Geometry
-from sectionproperties.pre.pre import Material as sec_material
-from sectionproperties.analysis.section import Section
-import sectionproperties.pre.library.primitive_sections as sections
-import numpy as np
-import shapely
-import attr, attrs
-import functools
-import itertools
-import multiprocessing as mp
-import threading
-import random
-import pandas
-import pickle
-import hashlib
-import tempfile,os
-import json
-
-# generic cross sections from
-# https://mechanicalbase.com/area-moment-of-inertia-calculator-of-certain-cross-sectional-shapes/
-temp_path = os.path.join(tempfile.gettempdir(),'shapely_sections')
-section_cache = EnvVariable('FORGE_SECTION_CACHE',default = temp_path,desc='directory to cache section properties')
-if 'FORGE_SECTION_CACHE' not in os.environ and not os.path.exists(temp_path):
-    os.mkdir(temp_path)
-
-section_cache.info(f'loading section from {section_cache.secret}')
-
-

-[docs]
-class GeometryLog(LoggingMixin):
-    pass

-
-log = GeometryLog()
-
-
-

-[docs]
-def conver_np(inpt):
-    if isinstance(inpt,np.ndarray):
-        return inpt
-    elif isinstance(inpt,(list,tuple)):
-        return np.array(inpt)
-    elif isinstance(inpt,(int,float)):
-        return np.array([inpt])
-    else:
-        raise ValueError(f'got non numpy array/float: {inpt}')

-
-
-
-
-

-[docs]
-@attrs.define(slots=False)
-class ParametricSpline:
-    """a multivariate spline defined by uniform length vector input, with points P1,P2 and their slopes P1ds,P2ds"""
-
-    P1=attrs.field(converter=conver_np)
-    P2=attrs.field(converter=conver_np)
-    P1ds=attrs.field(converter=conver_np)
-    P2ds=attrs.field(converter=conver_np)
-
-    def __attrs_post_init__(self):
-        assert len(self.P1) == len(self.P2)
-        assert len(self.P1ds) == len(self.P2ds)
-        assert len(self.P1) == len(self.P1ds)
-
-    @functools.cached_property
-    def a0(self):
-        return self.P1
-
-    @functools.cached_property
-    def a1(self):
-        return self.P1ds
-
-    @functools.cached_property
-    def a2(self):
-        return 3*(self.P2-self.P1 ) - 2*self.P1ds - self.P2ds
-    
-    @functools.cached_property
-    def a3(self):
-        return (self.P2ds - self.P1ds - 2*self.a2)/3.
-    
-    def coords(self,s:float):
-        if isinstance(s,(float,int)):
-            assert s <= 1
-            assert 0 <= s
-            return self._coords(s)
-        elif isinstance(s,(list,tuple,numpy.ndarray)):
-            assert max(s) <= 1
-            assert min(s) >= 0
-            ol = [self._coords(si) for si in s]
-            return numpy.array(ol)
-        else:
-            raise ValueError(f'non array/float input {s}')
-
-    def _coords(self,s:float):
-        return self.a0 + self.a1*s + self.a2*s**2 +self.a3*s**3

-
-
-
-
-# TODO: cache SectionProperty sections and develop auto-mesh refinement system.
-
-

-[docs]
-@forge
-class Profile2D(Configuration,PredictionMixin):
-    name: str = attr.ib(default="generic cross section")
-
-    # provide relative interface over
-    y_bounds: tuple = None
-    x_bounds: tuple = None
-
-    @property
-    def A(self):
-        return 0
-
-    @property
-    def Ao(self):
-        """outside area, over ride for hallow sections"""
-        return self.A
-
-    @property
-    def Ixx(self):
-        return 0
-
-    @property
-    def Iyy(self):
-        return 0
-
-    @property
-    def J(self):
-        return 0
-
-    def display_results(self):
-        self.info("mock section, no results to display")
-
-    def plot_mesh(self):
-        self.info("mock section, no mesh to plot")
-
-    def calculate_stress(self, N, Vx, Vy, Mxx, Myy, M11, M22, Mzz):
-        # TODO: Implement stress object, make fake mesh, and mock?
-        # sigma_n = N / self.A
-        # sigma_bx = self.Myy * self.max_y / self.Ixx
-        # sigma_by = self.Mxx * self.max_x / self.Iyy
-        self.warning(f'calculating stress in simple profile!')
-        return np.nan
-
-    def estimate_stress(self, N, Vx, Vy, Mxx, Myy, M11, M22, Mzz):
-        # TODO: Implement stress object, make fake mesh, and mock?
-        # sigma_n = N / self.A
-        # sigma_bx = self.Myy * self.max_y / self.Ixx
-        # sigma_by = self.Mxx * self.max_x / self.Iyy
-        self.warning(f'estimating stress in simple profile!')
-        return np.nan

-
-
-
-

-[docs]
-@forge
-class Rectangle(Profile2D):
-    """models rectangle with base b, and height h"""
-
-    b: float = attr.ib()
-    h: float = attr.ib()
-    name: str = attr.ib(default="rectangular section")
-
-    def __on_init__(self):
-        self.y_bounds = (self.h / 2, -self.h / 2)
-        self.x_bounds = (self.b / 2, -self.b / 2)
-
-    @property
-    def A(self):
-        return self.h * self.b
-
-    @property
-    def Ixx(self):
-        return self.b * self.h**3.0 / 12.0
-
-    @property
-    def Iyy(self):
-        return self.h * self.b**3.0 / 12.0
-
-    @property
-    def J(self):
-        return (self.h * self.b) * (self.b**2.0 + self.h**2.0) / 12

-
-
-
-

-[docs]
-@forge
-class Triangle(Profile2D):
-    """models a triangle with base, b and height h"""
-
-    b: float = attr.ib()
-    h: float = attr.ib()
-    name: str = attr.ib(default="rectangular section")
-
-    def __on_init__(self):
-        self.y_bounds = (self.h / 2, -self.h / 2)
-        self.x_bounds = (self.b / 2, -self.b / 2)
-
-    @property
-    def A(self):
-        return self.h * self.b / 2.0
-
-    @property
-    def Ixx(self):
-        return self.b * self.h**3.0 / 36.0
-
-    @property
-    def Iyy(self):
-        return self.h * self.b**3.0 / 36.0
-
-    @property
-    def J(self):
-        return (self.h * self.b) * (self.b**2.0 + self.h**2.0) / 12

-
-
-
-

-[docs]
-@forge
-class Circle(Profile2D):
-    """models a solid circle with diameter d"""
-
-    d: float = attr.ib()
-    name: str = attr.ib(default="rectangular section")
-
-    def __on_init__(self):
-        self.x_bounds = self.y_bounds = (self.d / 2, -self.d / 2)
-
-    @property
-    def A(self):
-        return (self.d / 2.0) ** 2.0 * numpy.pi
-
-    @property
-    def Ixx(self):
-        return numpy.pi * (self.d**4.0 / 64.0)
-
-    @property
-    def Iyy(self):
-        return numpy.pi * (self.d**4.0 / 64.0)
-
-    @property
-    def J(self):
-        return numpy.pi * (self.d**4.0 / 32.0)

-
-
-
-

-[docs]
-@forge
-class HollowCircle(Profile2D):
-    """models a hollow circle with diameter d and thickness t"""
-
-    d: float = attr.ib()
-    t: float = attr.ib()
-    name: str = attr.ib(default="rectangular section")
-
-    def __on_init__(self):
-        self.y_bounds = (self.d / 2, -self.d / 2)
-        self.x_bounds = (self.d / 2, -self.d / 2)
-
-    @property
-    def di(self):
-        return self.d - self.t * 2
-
-    @property
-    def Ao(self):
-        """outside area, over ride for hallow sections"""
-        return (self.d**2.0) / 4.0 * numpy.pi
-
-    @property
-    def A(self):
-        return (self.d**2.0 - self.di**2.0) / 4.0 * numpy.pi
-
-    @property
-    def Ixx(self):
-        return numpy.pi * ((self.d**4.0 - self.di**4.0) / 64.0)
-
-    @property
-    def Iyy(self):
-        return numpy.pi * ((self.d**4.0 - self.di**4.0) / 64.0)
-
-    @property
-    def J(self):
-        return numpy.pi * ((self.d**4.0 - self.di**4.0) / 32.0)

-
-
-
-# ADVANCED CUSTOM SECTIONS
-

-[docs]
-def get_mesh_size(inst):
-    if isinstance(inst.shape, Geometry):
-        shape = inst.shape.geom
-    else:
-        shape = inst.shape
-    
-    dec = inst.mesh_extent_decimation
-    x, y = shape.exterior.coords.xy
-    dx = abs(max(x) - min(x))
-    dy = abs(max(y) - min(y))
-    ddx = np.abs(np.diff(x))
-    ddx = ddx[ddx > inst.min_mesh_size].tolist()
-    ddy = np.abs(np.diff(y))
-    ddy = ddy[ddy > inst.min_mesh_size].tolist()
-    
-    A = shape.area
-    dAmin = A *0.95/ (inst.goal_elements)
-
-    cans = [dx / dec, dy / dec]
-    if ddx:
-        cans.append(min(ddx))
-    if ddy:
-        cans.append(min(ddy))
-
-    ms = max(min(cans),inst.min_mesh_size)
-    return max(ms**2.,dAmin) #length to area conversion

-
-
-    
-

-[docs]
-def calculate_stress(section, n=0, vx=0, vy=0, mxx=0, myy=0, mzz=0,raw=False,row=False,record=True,value=True)->float:
-    """returns the maximum vonmises stress in the section and returns the ratio of the allowable stress, also known as the failure fracion
-    :param raw: if raw is true, the stress object is returned, otherwise the failure fraction is returned
-    """
-    inp = dict(n=n, vx=vx, vy=vy, mxx=mxx, myy=myy, mzz=mzz)
-
-    stress = section._sec.calculate_stress(**inp).get_stress()[0]
-    fail_stress = section.determine_failure_stress(stress)
-    inp['fail_stress'] = fail_stress
-    inp['fail_frac'] = ff =  fail_stress / section.material.allowable_stress
-    inp['fails'] = int(ff >= 1)
-
-    if record:
-        section.record_stress(inp)
-    
-    if value:
-        return fail_stress
-    
-    if raw:
-        return stress
-    
-    if row:
-        return inp
-    
-    return ff

-
-
-

-[docs]
-@forge(hash=False)
-class ShapelySection(Profile2D):
-    """a 2D profile that takes a shapely section to calculate section properties, use a sectionproperties section with hidden variable `_geo` to bypass shape calculation"""
-
-    name: str = attrs.field(default="shapely section")
-    shape: shapely.Polygon = attrs.field()
-
-    #Mesh sizing
-    coarse: bool = attrs.field(default=False)
-    mesh_extent_decimation = attrs.field(default=100)
-    min_mesh_angle: float = attrs.field(default=20) #below 20.7 garunteed to work
-    min_mesh_size: float = attrs.field(default=1E-5) #multiply by min
-    goal_elements: float = attrs.field(default=1000) #multiply by min
-    _mesh_size: float = attrs.field(default=attrs.Factory(get_mesh_size, True))
-
-    material: sec_material = attrs.field(default=None)
-    failure_mode = Options('von_mises','max_norm','maximum_strain')
-
-    #Stress classification & prediction
-    prediction: bool = attr.field(default=False)
-    prediction_goal_error: float = attrs.field(default=0.025)
-    max_records: list = attr.field(default=10000)
-    prediction_records: list
-    near_margin=0.1
-    max_margin=1.5
-    save_threshold=0.90
-    max_rec_parm = 'fail_frac'
-
-    _use_symmetric: bool = attrs.field(default=True)
-    _prediction_parms = ['n','vx','vy','mxx','myy','mzz']
-    _do_print: bool = attrs.field(default=False)
-    _sec: Section = None
-    _geo: Geometry  = None
-    _A: float
-    _symmetric: bool
-    _subclass_init: bool = False
-
-    def __on_init__(self):
-        self.init_with_material(self.material)
-            
-        if self.prediction:
-            self.add_prediction_record({'n':0,'vx':0,'vy':0,'mxx':0,'myy':0,'mzz':0,'fails':0,'fail_frac':0})
-            self._symmetric = self.check_symmetric()
-            if self._symmetric and self._use_symmetric:
-                self._prediction_models = {'fails':{'mod':svm.SVC(C=2000,gamma=0.1,probability=True),'N':0},'fail_frac':{'mod':svm.SVR(C=5,gamma=0.5),'N':0}}
-            else:
-                self._prediction_models = {'fails':{'mod':svm.SVC(C=5000,gamma=5,probability=True),'N':0},'fail_frac':{'mod':svm.SVR(C=10,gamma=0.5),'N':0}}
-            # self.determine_failure_front(pareto_front=False)
-            # self.basis_expand(expand_values=[0.75,0.5,0.1],Nparm=3,est=True)
-
-

-[docs]
-    def training_callback(self,models):
-        """when training is complete save the model to a pickle with `ShapelySection_<hash>.pkl`"""
-        score = models['fail_frac']['train_score']
-        Nscore = models['fail_frac']['N']
-        test_score = score * Nscore #compare to meta file
-
-        #Opt out of saving if score is below threshold
-        if score < self.save_threshold:
-            return
-        #Opt out of saving if score is worse than previous
-        if os.path.exists(self.meta_path):
-            with open(self.meta_path,'r') as f:
-                meta = json.load(f)
-            if test_score < meta['test_score']:
-                self.info(f'new model score {test_score} is worse than {meta["test_score"]}, not saving')
-                return
-
-        new_meta = {'test_score':test_score,'N':Nscore,'train_score':score}
-        #add a meta json file to show info regarding data (num points better ect)
-        with open(self.meta_path,'w') as f:
-            json.dump(new_meta,f)
-
-        #Finally save the geometry
-        self.info(f'saving model with score: {Nscore}x{score}=>{test_score}')
-        fil = self.cache_path
-        with open(fil,'wb') as f:
-            pickle.dump(self,f)
-        self.info(f'saved section to {fil}')

-
-
-    
-
-    @property
-    def section_cache(self) -> str:
-        return section_cache.secret
-
-    @property
-    def cache_name(self) -> str:
-        return f'ShapelySection_{self.hash_id()}.pkl'
-
-    @property
-    def meta_name(self) -> str:
-        return f'ShapelySection_meta_{self.hash_id()}.json'        
-
-    @property
-    def cache_path(self):
-        return os.path.join(self.section_cache,self.cache_name)
-
-    @property
-    def meta_path(self):
-        return os.path.join(self.section_cache,self.meta_name)
-
-    @classmethod
-    def from_cache(cls,hash_id):
-        cchc = section_cache.secret
-        log.info(f'loading section {hash_id} from cache {cchc}')
-        fil = os.path.join(cchc,f'ShapelySection_{hash_id}.pkl')
-        with open(fil,'rb') as f:
-            model = pickle.load(f)
-        return model
-
-    def prediction_weights(self,df,window,initial_weight=10):
-        weights = numpy.ones(min(len(df),window))
-        weights[0] = initial_weight**2 #zero value is important!
-        weights[:getattr(self,'N_base',100)] = initial_weight #then base values
-        if hasattr(self,'N_pareto'):
-            weights[:getattr(self,'N_pareto')] = initial_weight**0.5 #then pareto values
-        #Dont emphasise fit above max margin
-        dm = (df.fail_frac - self.max_margin).to_numpy()
-        penalize_inx = (dm>0)
-        weights[penalize_inx] = np.maximum(1.0/((1.0+dm[penalize_inx])),0.1)
-        return weights   
-
-    def _subsample_data(self,X,y,window,weights):
-        """subsamples the data to the window size"""
-        inx = getattr(self,'N_pareto',getattr(self,'N_base',window))
-        x1 = X.iloc[:inx]
-        y1 = y.iloc[:inx]
-        w1 = weights[:inx]
-        if inx != window:
-            x2 = X.iloc[inx:].sample(frac=0.5)
-            y2 = y.iloc[x2.index]
-            w2 = weights[x2.index]
-            return pandas.concat((x1,x2)),pandas.concat((y1,y2)),numpy.concatenate((w1,w2))
-        return X.iloc[:window],y.iloc[:window],weights[:window]      
-
-    def reset_prediction(self):
-        self._fitted = False
-        self._basis = None
-        self._training_history = None
-        self._running_error = None
-        self.add_prediction_record({'n':0,'vx':0,'vy':0,'mxx':0,'myy':0,'mzz':0,'fails':0,'fail_frac':0})
-        #self._symmetric = self.check_symmetric()
-
-    @property
-    def mesh_size(self):
-        return self._mesh_size
-    
-    @property
-    def _prediction_record(self):
-        """not a property of state, just return an empty dict, we add record manually"""
-        return {}
-    
-    @mesh_size.setter
-    def mesh_size(self, value):
-        #print(f'setting mesh size to {value}')
-        #BUG: something going on with setattrs on mesh_size, setting to None, hacky fix to set __dict__ directly 
-        _mesh_size = max(value,self.min_mesh_area)
-        self.__dict__['_mesh_size'] = _mesh_size
-        self.mesh_section()
-
-    def init_with_material(self, material=None):
-        if self._sec is not None:
-            raise Exception(f"already initalized!")
-        
-        if isinstance(self.shape,Geometry):
-            self._geo = self.shape
-            if self._geo.material and self.material:
-                self.warning(f'overriding material {self._geo.material} with {self.material}')
-                self._geo.material = self.material
-            elif self._geo.material:
-                self.info(f'setting beam material from section')
-                self.material = self._geo.material
-            elif self.material:
-                self._geo.material  = self.material
-        elif isinstance(self.shape,shapely.Polygon):
-            self._geo = Geometry(self.shape, self.material)
-        else:
-            raise ValueException(f'got invalid shape: {self.shape}')
-        
-        self.calculate_mesh_size()
-        self.mesh_section()
-
-    def calculate_mesh_size(self):
-         self.mesh_size = get_mesh_size(self)
-
-    @property
-    def min_mesh_area(self):
-        if isinstance(self.shape, Geometry):
-            shape = self.shape.geom
-        else:
-            shape = self.shape        
-        A = shape.area
-        dAmin = A *0.95/ (self.goal_elements)
-        return dAmin
-        
-

-[docs]
-    def mesh_section(self):    
-        """caches section properties and mesh""" 
-        self._cross_section = None #reset cross section 
-        self._mesh = self._geo.create_mesh(mesh_sizes=self.mesh_size, coarse=self.coarse,min_angle=self.min_mesh_angle)
-        self._sec = Section(self._geo)
-        self._sec.calculate_geometric_properties()
-        self._sec.calculate_warping_properties()
-        self._sec.calculate_frame_properties()
-
-        self._A = self._sec.get_area()
-        if self.material:
-            self._Ixx, self._Iyy, self._Ixy = self._sec.get_eic(e_ref=self.material)
-            self._J = self._sec.get_ej()
-        else:
-            self._Ixx, self._Iyy, self._Ixy = self._sec.get_ic()
-            self._J = self._sec.get_j()
-
-        self.calculate_bounds()

-
-
-
-    def calculate_bounds(self):
-        self.info(f"calculating shape bounds!")
-        xcg, ycg = self._geo.calculate_centroid()
-        minx, maxx, miny, maxy = self._geo.calculate_extents()
-        self.y_bounds = (miny - ycg, maxy - ycg)
-        self.x_bounds = (minx - xcg, maxx - xcg)
-
-    @property
-    def A(self):
-        return self._A
-
-    @property
-    def Ao(self):
-        """outside area, over ride for hallow sections"""
-        return self.A
-
-    @property
-    def Ixx(self):
-        return self._Ixx
-
-    @property
-    def Iyy(self):
-        return self._Iyy
-
-    @property
-    def J(self):
-        return self._J
-
-    @property
-    def Ixy(self):
-        return self._Ixy
-
-    def display_results(self):
-        self.info("mock section, no results to display")
-
-    def plot_mesh(self):
-        self._sec.display_mesh_info()
-        
-
-    def plot_mesh(self):
-        return self._sec.plot_centroids()
-
-    def calculate_stress(self, n=0, vx=0, vy=0, mxx=0, myy=0, mzz=0,**kw)->float:
-        return calculate_stress(self,n=n, vx=vx, vy=vy, mxx=mxx, myy=myy, mzz=mzz,**kw)
-        
-

-[docs]
-    def estimate_stress(self, n=0, vx=0, vy=0, mxx=0, myy=0, mzz=0,value=False,calc_margin=2,min_est_records=100,calc_every=25,pre_train_margin=2,force_calc=False)->float:
-        """uses a support vector machine to estimate stresses and returns the ratio of the allowable stress, also known as the failure fracion if prediction is set to True, otherwise calculates stress"""
-        
-        Nrec = 0
-        under_size = True    
-        if self.prediction:
-            pr = self.prediction_records
-            Nrec = len(pr) if pr else 0
-            under_size = Nrec <= min_est_records     
-
-        do_calc = not self.prediction or not self._fitted or under_size
-        if do_calc or force_calc:
-            if self._do_print and self.prediction:
-                print(f'calc till {len(self.prediction_records)} <= {min_est_records}')
-            stress = calculate_stress(self,n=n, vx=vx, vy=vy, mxx=mxx, myy=myy, mzz=mzz,value=value)
-            return stress 
-        else:
-            parms = self._prediction_parms
-            data = dict(n=n,vx=vx,vy=vy,mxx=mxx,myy=myy,mzz=mzz)
-            
-            #Format data for prediction
-            if self._symmetric and self._use_symmetric:
-                inp = {k:abs(data[k]/v) for k,v in zip(parms,self._basis)}
-            else:
-                inp = {k:data[k]/v for k,v in zip(parms,self._basis)}
-            X = pandas.DataFrame([inp])
-            val = self._prediction_models['fail_frac']['mod'].predict(X)[0]
-
-            #Provide margin of error and use estimate where possible
-            if not self.trained:
-                #calc when in doubt   
-                calc_margin = calc_margin*pre_train_margin 
-            
-
-            #calculate stress if close to failure within saftey margin
-            err = 1-val
-            mrg = self.fail_frac_criteria(calc_margin=calc_margin)
-            do_calc = abs(err)<=mrg or all([calc_every,(Nrec%calc_every)==0])
-            oob = val <= self.max_margin and self.check_out_of_domain(data,0.1)
-            if self._do_print:
-                self.info(f'{"calc" if do_calc or oob else "est"} stress {abs(err):5.3f}>{mrg*calc_margin:5.3f}| {calc_margin} | oob {oob}')
-
-            if do_calc:
-                return self.calculate_stress(n=n, vx=vx, vy=vy, mxx=mxx, myy=myy, mzz=mzz,value=value)
-
-            elif oob:
-                # if self._do_print:
-                #     self.info(f'out of domain {val:5.3f}<={self.max_margin:5.3f}')
-                return self.calculate_stress(n=n, vx=vx, vy=vy, mxx=mxx, myy=myy, mzz=mzz,value=value)
-            
-
-                
-            #otherwise prediction is value
-            if value:
-                return val * self.material.allowable_stress
-
-            return val

-
-        
-    def fail_frac_criteria(self,calc_margin=2,min_rec=1000):
-        MargRec = max(min_rec/len(self._prediction_records),1)
-
-        if self._training_history:
-            score = self._training_history[-1]['fail_frac']['scr']
-        else:
-            score = self._prediction_models['fail_frac']['train_score']
-
-        mrg = max(abs((1-score)),self.prediction_goal_error)
-        return mrg*calc_margin*MargRec
-    
-

-[docs]
-    def estimate_failure(self, n=0, vx=0, vy=0, mxx=0, myy=0, mzz=0)->float:
-        """uses a support vector machine to estimate stresses and returns a number zero or one to indicate failure, if prediction is set to True, otherwise calculates stress"""
-        if not self.prediction or not self._fitted:
-            ff = calculate_stress(self,n=n, vx=vx, vy=vy, mxx=mxx, myy=myy, mzz=mzz,row=True,value=False)
-            return ff['fails']
-        else:
-            #TODO: add logic to determine if calculation should be done close to failure
-          
-            parms = self._prediction_parms
-            data = dict(n=n,vx=vx,vy=vy,mxx=mxx,myy=myy,mzz=mzz)
-            if self._symmetric and self._use_symmetric:
-                inp = {k:abs(data[k]/v) for k,v in zip(parms,self._basis)}
-            else:
-                inp = {k:data[k]/v for k,v in zip(parms,self._basis)}
-            X = pandas.DataFrame([inp])
-            return self._prediction_models['fails']['mod'].predict(X)[0]  

-
-
-

-[docs]
-    def record_stress(self,stress_dict):
-        """determines if stress record should be added to prediction_records"""
-        if not self.prediction:
-            return
-        if len(self.prediction_records) > self.max_records:
-            return
-        #Add the data to the stress records
-        #TODO: add logic to determine if stress record should be added to prediction_records
-        ff = stress_dict['fail_frac']
-        if ff == 0:
-            #null included
-            return
-
-        #Convert to positive domain
-        if self._symmetric and self._use_symmetric:
-            stress_dict = {k:abs(v) for k,v in stress_dict.items()}
-        
-        if not getattr(self,'N_base',None):
-            max_margin = None
-        else:
-            max_margin = self.max_margin
-        
-        if self.near_margin and abs(ff-1) < self.near_margin:
-            #near failure always add to map resolution
-            self.add_prediction_record(stress_dict)
-        elif max_margin and ff < max_margin*2:
-            #under max marging
-            self.add_prediction_record(stress_dict,False,0.1)
-        elif not self.near_margin and not max_margin:
-            #no checks
-            self.add_prediction_record(stress_dict,False)

-
-            
-
-

-[docs]
-    def determine_failure_stress(self,stress_obj):
-        """uses the failure mode to compare to allowable stress"""
-        if self.failure_mode == 'von_mises':
-            return stress_obj['sig_vm'].max()
-        elif self.failure_mode == 'max_norm':
-            return np.nan #TODO: make this work
-        elif self.failure_mode == 'maximum_strain':
-            return np.nan #TODO: make this work
-        else:
-            raise ValueError(f'invalid failure mode: {self.failure_mode}')

-
-
-

-[docs]
-    def fail_learning(self,X,parm,base_kw,mult=1):
-        '''optimizes stress until failure, given base_kw arguments for extra parameters'''
-        base_kw = base_kw.copy()
-        inpt = {parm:mult*X}
-        base_kw.update(inpt)
-        
-        base_kw['value'] = False #override value for calcstress to fail frac
-        ff = self.calculate_stress(**base_kw).item()
-        return 1 - ff

-
-
-    def solve_fail(self,fail_parm,base_kw,guess=None,tol=1E-4,mult=1):
-        if guess is None:
-            guess = 1000*random.random()
-        kw = {}
-        # if self._basis is not None:
-        #     fpinx = self._prediction_parms.index(fail_parm)
-        #     bracket = (0,self._basis[fpinx]*1.25)
-        #     kw['bracket']  = bracket
-            
-        ans = skopt.root_scalar( self.fail_learning , x0=guess*0.1, x1=guess, xtol = tol, args=(fail_parm,base_kw,mult))#,**kw)
-        if self._do_print:
-            self.info(f'{mult}x{fail_parm:<6}| success: {ans.converged} , ans:{ans.root}, base: {base_kw}')
-        else:
-            self.debug(f'{mult}x{fail_parm:<6}| success: {ans.converged} , ans:{ans.root}, base: {base_kw}')
-        if ans.converged:
-            return ans.root
-        return 1E6
-
-    #Determine Outer Bound Of Failures
-    def determine_failure_front(self,pareto_inx = [0.5,0.1],pareto_front=False):
-        self.info(f'determining failure front for cross section, with pareto inx: {pareto_inx}')
-        null_kw = {}
-        if self._symmetric:
-            mvec = [1]
-        else:
-            mvec = [-1,1]
-        
-        if self._basis is None:
-            self.info(f'determining normalization basis')
-            res = {}
-            for mult in mvec:
-                res[mult] = {}
-                for p in self._prediction_parms:
-                    res[mult][p] = self.solve_fail(p,null_kw,mult)
-
-            self._basis = np.array([max([abs(v.get(p,1E6))  for k,v in res.items() ]) for p in self._prediction_parms])
-
-            self.N_base = len(self.prediction_records)
-
-        #Second Pareto Value Calc
-        if pareto_front:
-            for mult in mvec:
-                for aux_frac in pareto_inx:
-                    #TODO: expand parato combos past 2
-                    for fail_parm,aux_parm in itertools.combinations(self._prediction_parms,2):
-                        ainx = self._prediction_parms.index(aux_parm)
-                        aux_val = self._basis[ainx]*aux_frac
-                        base_kw = {aux_parm:aux_val}
-                        finx = self._prediction_parms.index(fail_parm)
-                        guesstimate = self._basis[finx]*(1-aux_frac)
-                        self.solve_fail(fail_parm,base_kw,guess=guesstimate,mult=mult)
-                        if not self._symmetric:
-                            self.solve_fail(fail_parm,base_kw,guess=guesstimate,mult=-1*mult) #alternato
-    
-            self.N_pareto = len(self.prediction_records)
-    
-

-[docs]
-    def basis_expand(self,expand_values=[0.9,0.75,0.5,0.1,0.01],Nparm=4,est=True,normalize=True):
-        """run combinations of parameters and permutations of weights against the basis values to populate the stress records, by default using estimation logic to speed up the process"""
-        i = 0
-        Nparm = min(min(Nparm,len(self._prediction_parms)),len(expand_values))
-        for parms in itertools.combinations(self._prediction_parms,Nparm):
-            for weight in itertools.permutations(expand_values,Nparm):
-                wt = sum(weight)
-                q = max(wt,1) if normalize else 1
-                inxs = [self._prediction_parms.index(p) for p in parms]
-                base_kw = {p:w*self._basis[i]/q for p,w,i in zip(parms,weight,inxs)}
-                
-                #print(base_kw)
-                if est:
-                    self.estimate_stress(**base_kw)
-                else:
-                    self.calculate_stress(**base_kw)
-                i+=1
-                if i%100 == 0:
-                    self.info(f'basis expansion... {i}')

-
-                    
-
-    def random_force_input(self,exp_mg=12,exp_min=6,min_ex=1,max_ex=3):
-        porp = np.random.random(size=6)**np.random.randint(numpy.random.randint(min_ex,max_ex),numpy.random.randint(exp_min,exp_mg),size=(6,))
-        stress = porp * self._basis
-        return {k:v for k,v in zip(self._prediction_parms,stress)}        
-        
-

-[docs]
-    def train_until_valid(self,print_interval=50,max_iter=1000,est=False):
-        """trains the prediction models until the error is below the goal error"""
-        i = 0
-        goal = self.prediction_goal_error
-        while not self.trained:
-            inp = self.random_force_input()
-            if est:
-                self.estimate_stress(**inp)
-            else:
-                self.calculate_stress(**inp)
-            
-            if i % print_interval == 0:
-                self.info(f'training... current error: {self._training_history[-1]}')
-            i+= 1
-            if i >= max_iter:
-                self.info(f'training... max iterations reached')
-                return

-
-            
-    
-    #Geometric Prediction Solutions
-

-[docs]
-    def check_symmetric(self,precision=3,Nincr=180):
-        """checks if the section is symmetric about the x and y axis, by finding the intersection of """
-        if isinstance(self.shape, Geometry):
-            shape = self.shape.geom
-        else:
-            shape = self.shape
-        x,y = (np.array(v) for v in shape.exterior.coords.xy)
-        xc = shape.centroid.x
-        yc = shape.centroid.y
-        dx= x-xc
-        dy= y-yc
-
-        dth = np.arctan2(dx,dy)
-        rth = (dx**2 + dy**2)**0.5
-        inx = np.cumsum(np.ones(dth.size))-1
-
-        Nincr = 1000
-        Imax = inx.max()
-        inx2 = np.linspace(0,Imax,Nincr)
-        oppo = lambda i: (i+Imax/2)%Imax
-
-        R = np.interp(inx2,inx,rth)
-        T = np.interp(inx2,inx,dth)
-        X = np.cos(T)*R
-        Y = np.sin(T)*R
-
-        #finds set of radius at a given angle
-        def find_radii(targetth):
-            """targetth must be positive from 0->pi"""
-            r = (dth - targetth)
-            #print(r)
-            if np.all(r < 0):
-                r = r + np.pi
-            elif np.all(r > 0):
-                r = r - np.pi
-            sgn = np.concatenate([ r[1:]*r[:-1], [r[0]*r[-1]] ] )
-            possibles = np.where( sgn < 0)[0]
-            #print(f'\n{targetth}')
-            out = set()
-            for poss in possibles:
-                poss2 = int((poss+1)%Imax)
-                x_ = np.array([r[poss],r[poss2]])
-                y_ = np.array([inx[poss],inx[poss2]])
-                itarget = (0 - x_[0])*(y_[1]-y_[0])/(x_[1]-x_[0]) + y_[0]
-                r_ = np.interp(itarget,inx2,R)
-                out.add(round(r_,precision))
-                #print(itarget,r_)
-            return out
-
-        #check symmetry from 0-180 deg
-        syms = []
-        for targetth in np.linspace(0,np.pi,Nincr):
-            o1 = find_radii(targetth)
-            o2 = find_radii(targetth-np.pi)
-            sym_point = len(o1.intersection(o2)) >= 1
-            syms.append(sym_point)
-            
-        return np.all(syms)

-
-    
-
-    def __hash__(self):
-        """uniqueness based on geometry and material"""
-        #print('hash shape...')
-        if isinstance(self.shape, Geometry):
-            shape = self.shape.geom
-        else:
-            shape = self.shape        
-        vals = (shape.wkb_hex,str(hash(self.material)),str(self.goal_elements),str(self.min_mesh_angle) )
-        h=hashlib.md5()
-        for hv in vals:
-            h.update(hv.encode())
-        return int(h.hexdigest(),16)  
-        
-

-[docs]
-    def hash_id(self)->str:
-        """string for saving to persisting"""
-        return str(hash(self))

-

-
-            
-ALL_CROSSSECTIONS = [
-    cs for cs in locals() if type(cs) is type and issubclass(cs, Profile2D)
-]
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/eng/pipes.html b/docs/_build/html/_modules/engforge/eng/pipes.html deleted file mode 100644 index 12e5698..0000000 --- a/docs/_build/html/_modules/engforge/eng/pipes.html +++ /dev/null @@ -1,1369 +0,0 @@ - - - - - - engforge.eng.pipes — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.eng.pipes

-"""We'll use the QP formulation to develop a fluid analysis system for fluids
-start with single phase and move to others
-
-
-1) Pumps Power = C x Q x P 
-2) Compressor = C x (QP) x (PR^C2 - 1)
-3) Pipes = dP = C x fXL/D x V^2 / 2g
-4) Pipe Fittings / Valves = dP = C x V^2 (fXL/D +K)   |   K is a constant, for valves it can be interpolated between closed and opened
-5) Splitters & Joins: Handle fluid mixing
-6) Phase Separation (This one is gonna be hard)
-7) Heat Exchanger dP = f(V,T) - phase change issues
-8) Filtration dP = k x Vxc x (Afrontal/Asurface) "linear"
-"""
-
-from engforge.components import Component
-from engforge.configuration import forge
-from engforge.system_reference import Ref
-from engforge.tabulation import (
-    system_property,
-    NUMERIC_VALIDATOR,
-    STR_VALIDATOR,
-)
-from engforge.eng.fluid_material import FluidMaterial
-from engforge.common import G_grav_constant
-from engforge.attr_slots import *
-from engforge.attr_signals import *
-from engforge.logging import LoggingMixin
-from engforge.system import System
-from engforge.properties import *
-
-
-import networkx as nx
-
-import attr, attrs
-
-import numpy
-import fluids
-
-import attrs
-
-
-

-[docs]
-class PipeLog(LoggingMixin):
-    pass

-
-
-
-log = PipeLog()
-
-#TODO: add compressibility effects
-

-[docs]
-@forge
-class PipeNode(Component):
-    x: float = attrs.field()
-    y: float = attrs.field()
-    z: float = attrs.field()
-
-    _segments: list  # created on init
-
-    def __on_init__(self):
-        self._segments = []
-
-    def add_segment(self, pipe: "PipeFlow"):
-        if pipe not in self.segments:
-            self._segments.append(pipe)
-        else:
-            self.warning(f"pipe already added: {pipe}")
-
-    @property
-    def segments(self):
-        return self._segments
-
-    @system_property
-    def sum_of_flows(self) -> float:
-        out = 0
-        for pipe_seg in self._segments:
-            if self is pipe_seg.node_s:
-                out -= pipe_seg.Q
-            elif self is pipe_seg.node_e:
-                out += pipe_seg.Q
-        return out

-
-
-
-

-[docs]
-@forge
-class PipeFlow(Component):
-    D: float = attrs.field()
-    v: float = attrs.field(default=0)
-    material = Slot.define(FluidMaterial)
-
-    def set_flow(self, flow):
-        v = flow / self.A
-        self.v = v
-
-    # Geometric Propreties
-    @system_property
-    def A(self) -> float:
-        """:returns: the cross sectional area of pipe in [m2]"""
-        return 3.1415 * (self.D / 2.0) ** 2.0
-
-    @system_property
-    def C(self) -> float:
-        """:returns: the sectional circmerence of pipe"""
-        return 3.1415 * self.D
-
-    # Fluid Propreties
-    @system_property
-    def Q(self) -> float:
-        """:returns: the volumetric flow through this pipe in [m3/s]"""
-        return self.A * self.v
-
-    @system_property
-    def Mf(self) -> float:
-        """:returns: the massflow through this pipe in [kg/s]"""
-        return self.density * self.Q
-
-    @system_property
-    def reynoldsNumber(self) -> float:
-        """:returns: the flow reynolds number"""
-        o = abs(self.density * self.v * self.D / self.viscosity)
-        return max(o, 1)
-
-    # Material Properties Exposure
-    @system_property
-    def density(self) -> float:
-        return self.material.density
-
-    @system_property
-    def viscosity(self) -> float:
-        return self.material.viscosity
-
-    @system_property
-    def enthalpy(self) -> float:
-        return self.material.enthalpy
-
-    @system_property
-    def T(self) -> float:
-        return self.material.T
-
-    @T.setter
-    def T(self, new_T):
-        self.material.T = new_T
-
-    @system_property
-    def P(self) -> float:
-        return self.material.P
-
-    @P.setter
-    def P(self, new_P):
-        self.material.P = new_P
-
-    @property
-    def dP_f(self):
-        """The loss of pressure in the pipe due to pressure"""
-        raise NotImplemented()
-
-    @property
-    def dP_p(self):
-        """The loss of pressure in the pipe due to potential"""
-        raise NotImplemented()
-
-    @property
-    def dP_tot(self):
-        raise NotImplemented()
-
-    @property
-    def Fvec(self):
-        """returns the fluidized vector for 1D CFD for continuity:0, and momentum:1"""
-        # TODO: add energy eq
-        # TODO: 1D CFD Pipe Network Solver :)
-        return [
-            self.density * self.v,
-            self.density * self.v**2.0 + self.P,
-        ]  # TODO: include Txx

-
-
-
-

-[docs]
-@forge
-class Pipe(PipeFlow, Component):
-    node_s = Slot.define(PipeNode, default_ok=False)
-    node_e = Slot.define(PipeNode, default_ok=False)
-    roughness: float = attrs.field(default=0.0)
-    bend_radius: float = attrs.field(default=None)
-
-    straight_method = "Clamond"
-    laminar_method = "Schmidt laminar"
-    turbulent_method = "Schmidt turbulent"
-
-    def __on_init__(self):
-        self.node_s.add_segment(self)
-        self.node_e.add_segment(self)
-
-    @system_property
-    def Lx(self) -> float:
-        return self.node_e.x - self.node_s.x
-
-    @system_property
-    def Ly(self) -> float:
-        return self.node_e.y - self.node_s.y
-
-    @system_property
-    def Lz(self) -> float:
-        return self.node_e.z - self.node_s.z
-
-    @system_property
-    def Lhz(self) -> float:
-        """:returns: The length of pipe element in the XY plane"""
-        return numpy.sqrt(self.Lx**2.0 + self.Ly**2.0)
-
-    @system_property
-    def L(self) -> float:
-        """:returns: The absolute length of pipe element"""
-        return numpy.sqrt(self.Lx**2.0 + self.Ly**2.0 + self.Lz**2.0)
-
-    @system_property
-    def inclination(self) -> float:
-        """:returns: the inclination angle in degrees"""
-        return numpy.rad2deg(numpy.arctan2(self.Lz, self.Lhz))
-
-    @system_property
-    def friction_factor(self) -> float:
-        """The friction factor considering bend radius"""
-        if self.bend_radius is None:
-            re = self.reynoldsNumber
-            return fluids.friction.friction_factor(
-                re, self.roughness, Method=self.straight_method
-            )
-        else:
-            re = self.reynoldsNumber
-            dc = self.D * self.bend_radius
-            return fluids.friction.friction_factor_curved(
-                re,
-                self.D,
-                dc,
-                self.roughness,
-                laminar_method=self.laminar_method,
-                turbulent_method=self.turbulent_method,
-            )
-
-    @system_property
-    def Kpipe(self) -> float:
-        """The loss coeffient of this pipe section"""
-        return self.friction_factor * self.L / self.D
-
-    @system_property
-    def dP_f(self) -> float:
-        """The loss of pressure in the pipe due to pressure"""
-        return self.sign * self.density * self.v**2.0 * self.Kpipe / 2.0
-
-    @system_property
-    def dP_p(self) -> float:
-        """The loss of pressure in the pipe due to potential"""
-        return self.density * self.Lz * 9.81
-
-    @system_property
-    def dP_tot(self) -> float:
-        return self.dP_f + self.dP_p
-
-    @system_property
-    def sign(self) -> int:
-        return numpy.sign(self.v)

-
-
-
-# Specalized Nodes
-

-[docs]
-class FlowNode(PipeNode):
-    """Base For Boundary Condition Nodes of"""
-
-    @system_property
-    def dP_f(self) -> float:
-        return 0.0
-
-    @system_property
-    def dP_p(self) -> float:
-        return 0.0
-
-    @system_property
-    def dP_tot(self) -> float:
-        return 0.0

-
-
-
-

-[docs]
-@forge
-class PipeFitting(FlowNode, PipeFlow):
-    Kfitting = attr.ib(default=0.1, type=float)
-
-    @system_property
-    def dP_f(self) -> float:
-        """The loss of pressure in the pipe due to pressure"""
-        return self.density * self.v**2.0 * self.Kfitting / 2.0
-
-    @system_property
-    def dP_p(self) -> float:
-        """The loss of pressure in the pipe due to potential"""
-        return 0.0
-
-    @system_property
-    def dP_tot(self) -> float:
-        return self.dP_f + self.dP_p

-
-
-
-# TODO: Add in fitting numbers:
-#https://neutrium.net/fluid-flow/pressure-loss-from-fittings-excess-head-k-method/
-# https://neutrium.net/fluid-flow/discharge-coefficient-for-nozzles-and-orifices/
-"""                          Fitting                      Types       K
-0                       45° Elbow         Standard (R/D = 1)    0.35
-1                       45° Elbow    Long Radius (R/D = 1.5)    0.20
-2                90° Elbow Curved         Standard (R/D = 1)    0.75
-3                90° Elbow Curved    Long Radius (R/D = 1.5)    0.45
-4      90° Elbow Square or Mitred                        NaN    1.30
-5                       180° Bend               Close Return    1.50
-6                Tee, Run Through             Branch Blanked    0.40
-7                   Tee, as Elbow            Entering in run    1.00
-8                   Tee, as Elbow         Entering in branch    1.00
-9             Tee, Branching Flow                        NaN    1.00
-10                       Coupling                        NaN    0.04
-11                          Union                        NaN    0.04
-12                     Gate valve                 Fully Open    0.17
-13                     Gate valve                   3/4 Open    0.90
-14                     Gate valve                   1/2 Open    4.50
-15                     Gate valve                   1/4 Open   24.00
-16                Diaphragm valve                 Fully Open    2.30
-17                Diaphragm valve                   3/4 Open    2.60
-18                Diaphragm valve                   1/2 Open    4.30
-19                Diaphragm valve                   1/4 Open   21.00
-20        Globe valve, Bevel Seat                 Fully Open    6.00
-21        Globe valve, Bevel Seat                   1/2 Open    9.50
-22  Globe Valve, Composition seat                 Fully Open    6.00
-23  Globe Valve, Composition seat                   1/2 Open    8.50
-24                      Plug disk                 Fully Open    9.00
-25                      Plug disk                   3/4 Open   13.00
-26                      Plug disk                   1/2 Open   36.00
-27                      Plug disk                   1/4 Open  112.00
-28                    Angle valve                 Fully Open    2.00
-29       Y valve or blowoff valve                 Fully Open    3.00
-30                      Plug cock                \theta = 5°    0.05
-31                      Plug cock               \theta = 10°    0.29
-32                      Plug cock               \theta = 20°    1.56
-33                      Plug cock               \theta = 40°   17.30
-34                      Plug cock               \theta = 60°  206.00
-35                Butterfly valve                \theta = 5°    0.24
-36                Butterfly valve               \theta = 10°    0.52
-37                Butterfly valve               \theta = 20°    1.54
-38                Butterfly valve               \theta = 40°   10.80
-39                Butterfly valve               \theta = 60°  118.00
-40                    Check valve                      Swing    2.00
-41                    Check valve                       Disk   10.00
-42                    Check valve                       Ball   70.00
-43                     Foot valve                        NaN   15.00
-44                    Water meter                       Disk    7.00
-45                    Water meter                     Piston   15.00
-46                    Water meter  Rotary (star-shaped disk)   10.00
-47                    Water meter              Turbine-wheel    6.00"""
-
-
-#
-

-[docs]
-@forge
-class FlowInput(FlowNode):
-    flow_in: float = attrs.field(default=0.0)
-
-    @system_property
-    def sum_of_flows(self) -> float:
-        out = self.flow_in
-        for pipe_seg in self._segments:
-            if self is pipe_seg.node_s:
-                out -= pipe_seg.Q
-            elif self is pipe_seg.node_e:
-                out += pipe_seg.Q
-        return out

-
-
-
-#
-# class PressureInput(FlowNode):
-#     pressure_in: float = attrs.field()
-#
-# class PressureOut(FlowNode):
-#     pressure_out: float = attrs.field()
-
-
-

-[docs]
-@forge
-class Pump(Component):
-    """Simulates a pump with power input, max flow, and max pressure by assuming a flow characteristic"""
-
-    max_flow: float = attrs.field()
-    max_pressure: float = attrs.field()
-    # throttle: float
-
-    @property
-    def design_flow_curve(self):
-        """:returns: a tuple output of flow vector, and pressure vector"""
-        flow = numpy.linspace(0, self.max_flow)
-        return flow, self.max_pressure * (1 - (flow / self.max_flow) ** 2.0)
-
-

-[docs]
-    def dPressure(self, current_flow):
-        """The pressure the pump generates"""
-        flow, dP = self.design_flow_curve
-        assert current_flow >= 0, "Flow must be positive"
-        assert current_flow <= self.max_flow, "Flow must be less than max flow"
-        return numpy.interp(current_flow, flow, dP)

-
-
-

-[docs]
-    def power(self, current_flow):
-        """The power used considering in watts"""
-        return self.dPressure(current_flow) * current_flow

-

-
-
-
-

-[docs]
-@forge
-class PipeSystem(System):
-    in_node = Slot.define(PipeNode)
-    graph: nx.Graph
-    items: dict
-
-    def __on_init__(self):
-        self.items = {}
-        self.flow_solvers = {}
-        self.pipe_flow = {}
-        self.create_graph_from_pipe_or_node(self.in_node)
-        self.assemble_solvers()
-
-    def assemble_solvers(self):
-        for i, cycle in enumerate(nx.cycle_basis(self.graph)):
-            cycle_attr_name = f"_cycle_redisual_{i}"
-            pipes = []
-            self.info(f"found cycle: {cycle}")
-            for cs, cl in zip(cycle, cycle[1:] + [cycle[0]]):
-                pipe = self.graph.get_edge_data(cs, cl)["pipe"]
-                mult = 1
-                if cs == pipe.node_e.system_id:
-                    # reverse
-                    mult = -1
-                pipes.append((pipe, mult))
-
-            def res_func():
-                out = 0
-                for pipe, mult in pipes:
-                    out += mult * pipe.dP_tot
-                return out / 1000.0
-
-            setattr(self, cycle_attr_name, res_func)
-            self.flow_solvers[cycle_attr_name] = Ref(self, cycle_attr_name)
-
-        bf = lambda kv: len(kv[1].segments)
-        for nid, node in sorted(self.nodes.items(), key=bf):
-            if len(node.segments) > 1:
-                self.flow_solvers[nid] = Ref(node, "sum_of_flows")
-            elif not isinstance(node, FlowInput):
-                self.info(f"deadend: {node.identity}")
-                # self.flow_solvers[nid] = Ref(node,'sum_of_flows')
-
-        for nid, node in self.nodes.items():
-            if isinstance(node, FlowInput):
-                self.flow_solvers[nid] = Ref(node, "sum_of_flows")
-
-        for pid, pipe in self.pipes.items():
-            self.pipe_flow[pid] = Ref(pipe, "v")
-
-    @property
-    def _X(self):
-        return {k: v for k, v in self.pipe_flow.items()}
-
-    @property
-    def _F(self):
-        return {k: v for k, v in self.flow_solvers.items()}
-
-    @instance_cached
-    def F_keyword_order(self):
-        """defines the order of inputs in ordered mode for calcF"""
-        return {i: k for i, k in enumerate(self.flow_solvers)}
-
-    @property
-    def nodes(self):
-        return {k: v for k, v in self.items.items() if isinstance(v, PipeNode)}
-
-    @property
-    def pipes(self):
-        return {k: v for k, v in self.items.items() if isinstance(v, Pipe)}
-
-    # Pipe System Composition
-

-[docs]
-    def add_to_graph(self, graph, node_or_pipe) -> str:
-        """recursively add node or pipe elements"""
-
-        idd = node_or_pipe.system_id
-
-        # Early Exit
-        if idd in self.items:
-            return idd
-
-        elif graph.has_node(idd):
-            return idd
-
-        log.info(f"adding {idd}")
-
-        if isinstance(node_or_pipe, PipeNode):
-            if not graph.has_node(idd):
-                graph.add_node(idd, sys_id=idd, node=node_or_pipe)
-                self.items[idd] = node_or_pipe
-
-            for seg in node_or_pipe.segments:
-                self.add_to_graph(graph, seg)
-
-        elif isinstance(node_or_pipe, Pipe):
-            nodes = node_or_pipe.node_s
-            nodee = node_or_pipe.node_e
-
-            if not graph.has_node(nodes.system_id):
-                nsid = self.add_to_graph(graph, nodes)
-            else:
-                nsid = nodes.system_id
-
-            if not graph.has_node(nodee.system_id):
-                neid = self.add_to_graph(graph, nodee)
-            else:
-                neid = nodee.system_id
-
-            if not graph.has_edge(nsid, neid):
-                graph.add_edge(nsid, neid, sys_id=idd, pipe=node_or_pipe)
-                self.items[idd] = node_or_pipe
-
-        else:
-            raise ValueError(f"not a node or pipe: {node_or_pipe}")
-
-        return idd

-
-
-

-[docs]
-    def create_graph_from_pipe_or_node(self, node_or_pipe) -> nx.Graph:
-        """Creates a networkx graph from a pipe or node"""
-
-        self.graph = nx.Graph()
-
-        if isinstance(node_or_pipe, PipeNode):
-            self.add_to_graph(self.graph, node_or_pipe)
-
-        elif isinstance(node_or_pipe, Pipe):
-            self.add_to_graph(self.graph, node_or_pipe)
-
-        else:
-            raise ValueError(f"not a node or pipe: {node_or_pipe}")
-
-        return self.graph

-
-
-    def draw(self):
-        try:
-            from pyvis.network import Network
-
-            net = Network(directed=False)
-
-            net.from_nx(self.graph)
-            net.show("process_graph.html")
-
-        except:
-            pos = pos = nx.spring_layout(self.graph)
-            nx.draw(self.graph, pos=pos)
-            labels = nx.draw_networkx_labels(self.graph, pos=pos)

-
-
-
-
-
-#TODO: update compressibility:
-# 
-# import control as ct
-# import numpy as np
-# from engforge.components import Component, forge
-# from matplotlib.pylab import *
-# 
-# DT_DFLT = 1E-3
-# @forge(auto_attribs=True)
-# class Accumulator(Component):
-# 
-#     Rt: float = 5000
-#     Pref: float = 1E6
-#     Lref: float = 5
-#     Aact: float = 5
-#     Cact: float = 0.1
-#     Mact: float = 0.1
-#     Pmax: float = 7E8
-#     tlast: float = 0
-#     Kwall: float = 1
-# 
-#     lim_marg: float = 0.01
-#     min_dt: float = DT_DFLT
-# 
-#     model: 'InputOutputSystem' = None
-# 
-#     discrete: bool = True
-#     pressure_mode: bool = False #false is flow based
-# 
-#     def __on_init__(self):
-#         #handle defined pressure mode
-#         if self.pressure_mode:
-#             if not self.discrete:
-#                 self.model =  ct.NonlinearIOSystem(self.pr_update_accumulator,self.pr_accumulator_output,inputs=('Pi',),outputs=('Pc','Qc','Pout'),states=('x','v'),name= self.name if self.name else 'accumul    ator')
-#             else:
-#                 self.model =  ct.NonlinearIOSystem(self.pr_discrete_update_accumulator,self.pr_accumulator_output,inputs=('Pi',),outputs=('Pc','Qc','Pout'),states=('x','v'),name= self.name if self.name else 'accumulator',dt=True)
-#         else:
-#             if not self.discrete:
-#                 self.model =  ct.NonlinearIOSystem(self.w_update_accumulator,self.w_output,inputs=('Qc',),outputs=('Pc','Pout'),states=('x'),name= self.name if self.name else 'accumulator')
-#             else:
-#                 self.model =  ct.NonlinearIOSystem(self.w_discrete_update_accumulator, self.w_output,inputs=('Qc',),outputs=('Pc','Pout'),states=('x'),name= self.name if self.name else 'accumulator',dt=True)                
-#                 
-#     def w_update_accumulator(self,t,x,u,params):
-#         Rt = params.get('Rt',self.Rt) #Pa/(m3/s)
-#         Pref = params.get('Pref',self.Pref)
-#         Lref = params.get('Lref',self.Lref)
-#         Aact = params.get('Aact',self.Aact)
-#         Cact = params.get('Cact',self.Cact)
-#         Mact = params.get('Mact',self.Mact)
-#         Kwall = params.get('Kwall',self.Kwall)
-#         Pmax = params.get('Pmax',self.Pmax)
-# 
-#         qin  = u[0]
-#         
-#         xact   = x[0]
-#         #Pi  = x[0]
-#         
-#         if self.discrete and isinstance(self.model.dt,float):
-#             self.dt = dt = self.model.dt
-# 
-#         else: #infer dt
-#             if t >= self.tlast+self.min_dt:
-#                 self.dt = dt = max(abs(t - self.tlast),self.min_dt)
-#                 self.tlast = t
-#             else:
-#                 self.dt = dt = getattr(self,'dt',self.min_dt)
-# 
-#         #determine rate of x change (positive compresses accumulator (x->0))
-#         xdot = -qin/Aact
-# 
-#         xmin = Pref*Lref/Pmax
-# 
-#         #limit xdot to prevent over/under shoot
-#         if xact + dt * xdot > Lref*(1-self.lim_marg):
-#             xdot = (Lref-xact)/dt
-#         elif xact + dt * xdot < xmin:
-#             xdot = (xmin-xact)/dt
-# 
-#         return xdot
-#     
-#     def w_discrete_update_accumulator(self,t,x,u,params):
-#         v = self.w_update_accumulator(t,x,u,params)
-#         dt = self.model.dt
-# 
-#         if self.discrete and isinstance(self.model.dt,float):
-#             dt = self.model.dt
-#         else:
-#             dt = self.dt
-# 
-#         xnew= x[0] + v*dt
-# 
-#         return xnew
-#     
-#     def w_output(self,t,x,u,params):
-#         Rt = params.get('Rt',self.Rt) #Pa/(m3/s)
-#         Pref = params.get('Pref',self.Pref)
-#         Lref = params.get('Lref',self.Lref)
-#         Aact = params.get('Aact',self.Aact)
-#         Cact = params.get('Cact',self.Cact)
-#         Mact = params.get('Mact',self.Mact)
-#         Kwall = params.get('Kwall',self.Kwall)
-#         Pmax = params.get('Pmax',self.Pmax)
-# 
-#         qin  = u[0]
-#         
-#         xact   = x[0]   
-# 
-#         xmin = Pref*Lref/Pmax
-# 
-#         Pcomp = Pref*Lref / max(xmin,xact)             
-# 
-#         #junction pressure is higher than pcomp when accumulator is compressed
-#         Pi = Pcomp + qin*Rt
-# 
-#         return [Pcomp,Pi]
-#         
-# 
-#                 
-# 
-#     def pr_update_accumulator(self,t,x,u,params):
-#         """takes the current accumulator position, external pressure, and accumulator constants to determine the rate of change of accumulator position"""
-#         Rt = params.get('Rt',self.Rt) #Pa/(m3/s)
-#         Pref = params.get('Pref',self.Pref)
-#         Lref = params.get('Lref',self.Lref)
-#         Aact = params.get('Aact',self.Aact)
-#         Cact = params.get('Cact',self.Cact)
-#         Mact = params.get('Mact',self.Mact)
-#         Kwall = params.get('Kwall',self.Kwall)
-#         Pmax = params.get('Pmax',self.Pmax)
-# 
-#         Pi = u[0]
-#         #print(x,u)
-#         xact = x[0]
-#         v    = x[1]
-# 
-#         if self.discrete and isinstance(self.model.dt,float):
-#             self.dt = dt = self.model.dt
-# 
-#         else: #infer dt
-#             if t >= self.tlast+self.min_dt:
-#                 self.dt = dt = max(abs(t - self.tlast),self.min_dt)
-#                 self.tlast = t
-#             else:
-#                 self.dt = dt = getattr(self,'dt',self.min_dt)
-# 
-#         xmin = Pref*Lref/Pmax
-# 
-#         Pcomp = Pref*Lref / max(max(xmin,xact),Lref)
-#         dP = Pcomp-Pi
-#         sgn = np.sign(dP)
-# 
-#         #FIXME: remove since dP is based on equillibritum
-#         #xeq = max(min(Pref*Lref/Pi,Lref),xmin)
-#         #K = 0*self.Kwall*(xeq-xact)/Lref
-#         K = 0
-# 
-#         xdot =  sgn * ( abs(dP) / ( Rt * Aact**2.))**0.5/Lref
-#         dvdt = ((xdot-v) - K)/Mact - Cact*Aact*v*abs(v)/Mact
-# 
-#         x_proj = v * dt + xact
-# 
-#         #Consider projected limits
-#         if x_proj >= Lref*(1-self.lim_marg):
-#             vin = v
-#             v = (Lref-xact)/dt#,-1*Lref/10/dt)
-#             dvdt = (v-vin)/dt
-# 
-#         elif x_proj <= xmin: 
-#             vin = v
-#             v = (0 - xact)/dt
-#             dvdt = (v-vin)/dt
-# 
-#         return v,dvdt
-# 
-#     def pr_discrete_update_accumulator(self,t,x,u,params):
-#         v,dvdt = self.pr_update_accumulator(t,x,u,params)
-#         dt = self.model.dt
-# 
-#         if self.discrete and isinstance(self.model.dt,float):
-#             dt = self.model.dt
-#         else:
-#             dt = self.dt
-# 
-#         xnew= x[0] + v*dt
-#         vnew = x[1] + dvdt*dt
-# 
-#         return xnew,vnew
-# 
-#     def pr_accumulator_output(self,t,x,u,params):
-#         """returns accumulator pressure and flow (in positive)"""    
-#         Rt = params.get('Rt',self.Rt) #Pa/(m3/s)
-#         Pref = params.get('Pref',self.Pref)
-#         Lref = params.get('Lref',self.Lref)
-#         Aact = params.get('Aact',self.Aact)
-#         Cact = params.get('Cact',self.Cact)
-#         Mact = params.get('Mact',self.Mact)
-#         Pmax = params.get('Pmax',self.Pmax)
-#         #dt = params.get('dt',self.dt)
-# 
-#         Pi = u[0]
-#         xact = x[0]
-#         v    = x[1]
-# 
-#         xmin = Pref*Lref/Pmax
-#         Pcomp = Pref*Lref / max(xmin,xact)
-#         Q = v*Aact
-#         return [Pcomp,Q,Pi]
-#     
-# @forge(auto_attribs=True)
-# class Motor(Component):
-#     """Nonlinear motor with parasitics with fixed displacement"""
-# 
-#     I: float = 1
-#     D: float = 1E-6
-#     Cd: float = 0.0
-#     Ckloss: float = 0
-#     f: float = 0.0
-#     N: float = 1000
-# 
-#     min_dt: float = DT_DFLT
-#     model: 'InputOutputSystem' = None
-#     discrete: bool = True
-#     tlast = 0   
-# 
-#     def __on_init__(self):
-#         #print(self.name)
-#         if not self.discrete:
-#             self.model = ct.NonlinearIOSystem(self.update_motor, self.motor_output, inputs=('P1','P2'), outputs=('Trq','Q','Pwr','Pin','Pout'), state=('w',), name=self.name if self.name else 'motor')         
-#         else:
-#             self.model = ct.NonlinearIOSystem(self.discrete_update_motor, self.motor_output, inputs=('P1','P2'), outputs=('Trq','Q','Pwr','Pin','Pout'), state=('w',), name=self.name if self.name else 'motor',dt=True) 
-#             self.tlast = 0   
-# 
-#     def update_motor(self,t,x,u,params):
-#         """updates the motor acceleration based on pressure differential and nonlinear parasitics"""
-#         I = params.get('I',self.I)
-#         D = params.get('D',self.D)
-#         Cd = params.get('Cd',self.Cd)
-#         Ckloss = params.get('Ckloss',self.Ckloss)
-#         f = params.get('f',self.f)
-#         N = params.get('N',self.N)
-#         
-#         P1 = u[0]
-#         P2 = u[1]
-#         w = x[0]
-# 
-#         Q = D*(w/(2*3.14159))
-#         dPq = np.sign(Q)*Ckloss*Q**2
-#         
-#         dw_torque = (D/(2*np.pi))* ((P1 - P2)-dPq)
-#         dw_friction = w*f*N
-#         dw_drag = w*abs(w)*Cd
-#         
-#         return (dw_torque - dw_friction - dw_drag)/I
-#     
-#     def discrete_update_motor(self,t,x,u,params):
-#         dw = self.update_motor(t,x,u,params)
-# 
-# 
-#         if self.discrete and isinstance(self.model.dt,float):
-#             self.dt = dt = self.model.dt
-# 
-#         else: #infer dt
-#             if t >= self.tlast+self.min_dt:
-#                 self.dt = dt = max(abs(t - self.tlast),self.min_dt)
-#                 self.tlast = t
-#             else:
-#                 self.dt = dt = getattr(self,'dt',self.min_dt)
-# 
-#         return x[0] + dw*self.dt
-#         
-#     def motor_output(self,t,x,u,params):
-#         """calculates torque, flow and power output"""
-#         I = params.get('I',self.I)
-#         D = params.get('D',self.D)
-#         Cd = params.get('Cd',self.Cd)
-#         Ckloss = params.get('Ckloss',self.Ckloss)
-#         f = params.get('f',self.f)
-#         N = params.get('N',self.N)
-#         
-#         P1 = u[0]
-#         P2 = u[1]
-#         w = x[0]
-#         
-#         Q = (w/2*3.14159)*D
-#         dPq = np.sign(Q)*Ckloss*Q**2
-# 
-#         dP = (P1 - P2) - dPq
-# 
-#         Trq = D * dP / (2*3.14159)
-#         Pwr = dP * Q
-#         return [Trq, Q, Pwr,P1,P2]   
-# 
-# 
-# @forge(auto_attribs=True)
-# class Actuator(Component):
-#     Ap: float = 1
-#     mp: float = 0.5
-#     bp: float = 0.1
-#     Kwall: float = 1000
-#     Lstroke: float = 1   
-#     
-#     min_dt = DT_DFLT
-#     lim_marg = 0.01
-#     
-#     lim = None # true if high, false if low and none otherwise
-# 
-#     model: 'InterConnectedSystem' = None
-# 
-#     discrete: bool = True
-# 
-#     tlast = 0
-# 
-#     def __on_init__(self):
-#         if self.discrete:
-#             self.model = ct.NonlinearIOSystem(self.discrete_update_fnc,self.output_fnc,state=('x','v'),outputs=('Q1','Q2','P1','P2'),inputs=('F','P1','P2'),dt=True,name=self.name if self.name else 'actuator')
-# 
-#         else:
-#             self.model = ct.NonlinearIOSystem(self.update_fnc,self.output_fnc,state=('x','v'),outputs=('Q1','Q2','P1','P2'),inputs=('F','P1','P2'),name=self.name if self.name else 'actuator')
-# 
-#             
-# 
-#     def update_fnc(self,t,x,u,params):
-#         Ap = params.get('Ap',self.Ap)
-#         mp = params.get('mp',self.mp)
-#         bp = params.get('bp',self.bp)
-#         Kwall = params.get('Kwall',self.Kwall)
-#         Lstroke = params.get('Lstroke',self.Lstroke)
-# 
-#         xpos = x[0]
-#         v = x[1]
-# 
-#         f = u[0]
-#         p1 = u[1]
-#         p2 = u[2]
-#         
-#         if self.discrete and isinstance(self.model.dt,float):
-#             dt = self.model.dt
-#             self.dt = dt
-# 
-#         else: #infer dt
-#             if t >= self.tlast+self.min_dt:
-#                 self.dt = dt = max(abs(t - self.tlast),self.min_dt)
-#                 self.tlast = t
-#             else:
-#                 self.dt = dt = getattr(self,'dt',self.min_dt)
-# 
-#         if xpos > Lstroke:
-#             #print('kpos')
-#             K = self.Kwall*(xpos-Lstroke)
-#         elif xpos < 0:
-#             #print('kneg')
-#             K = self.Kwall*(xpos - 0)
-#         else:
-#             K = 0
-#         
-#         daf = f - (p1-p2)*Ap
-#         dad = bp*v*abs(v)
-#         dvdt = (daf - dad - K*daf)/mp    
-# 
-#         x_proj = v * dt + xpos
-#         
-#         if x_proj >= Lstroke*(1-self.lim_marg):
-#             vin = v
-#             v = (Lstroke-xpos)/dt
-#             dvdt = min((v-vin)/dt,dvdt)
-#     
-#         elif x_proj <= self.lim_marg: 
-#             vin = v
-#             v = (0 - xpos)/dt
-#             dvdt = max((v-vin)/dt,dvdt)
-# 
-# 
-#         return [v,dvdt]
-#     
-#     def discrete_update_fnc(self,t,x,u,params):
-#         v,dvdt = self.update_fnc(t,x,u,params)
-#         if self.discrete and isinstance(self.model.dt,float):
-#             dt = self.model.dt
-#         else:
-#             dt = self.dt
-# 
-#         if hasattr(self,'last_a'):
-#             dvdt = (self.last_a + dvdt)/2
-#             v = (self.last_v + v)/2
-# 
-#         vnew = v + dvdt*dt
-#         newx = x[0] + v*dt
-# 
-#         if newx < 0:
-#             newx = 0
-#             if vnew < 0:
-#                 vnew = 0
-# 
-#         elif newx > self.Lstroke:
-#             newx = self.Lstroke
-#             if vnew > 0:
-#                 vnew = 0
-# 
-#         self.last_x = newx
-#         self.last_v = vnew
-#         self.last_a = dvdt
-# 
-#         return newx, vnew
-# 
-#     def output_fnc(self,t,x,u,params):
-#         Ap = params.get('Ap',self.Ap)
-# 
-#         v = x[1]
-# 
-#         Q1 = -1*v * Ap
-#         Q2 = v * Ap
-# 
-#         return [Q1,Q2,u[1],u[2]]
-#         
-# 
-# @forge(auto_attribs=True)
-# class Pipe(Component):
-#     '''models pressure change and flow Q from nodes with pressure P1->P2'''
-#     Kp:float = 1 #TODO: better friction model
-#     
-#     flow_input: bool = False
-#     model: 'InputOutputSystem' = None
-# 
-#     def __on_init__(self):
-#         if not self.flow_input:
-#             self.model = ct.NonlinearIOSystem(self.pipe_flow,self.pipe_flow_output,state=('Q'),inputs=('P1','P2'),outputs=('P1o','P2o','Q'),dt=True,name=self.name if self.name else 'pipe')
-#         else:
-#             self.model = ct.NonlinearIOSystem(self.pipe_pressure,self.pipe_pressure_output,state=('P2'),inputs=('P1','Q'),outputs=('P1o','P2','Q'),dt=True,name=self.name if self.name else 'pipe')
-# 
-#     def pipe_flow(self,t,x,u,params):
-#         Kp = params.get('Kp',self.Kp)
-#         p1 = u[0]
-#         p2 = u[1]
-#         dP = (p2-p1)
-#         return -1*np.sign(dP)*(abs(dP)/Kp)**0.5
-#         
-#     def pipe_pressure(self,t,x,u,params):
-#         Kp = params.get('Kp',self.Kp)
-#         p1 = u[0]
-#         q = u[1]
-#         return -1*np.sign(q)*Kp*q**2 + p1
-#         
-#     def pipe_flow_output(self,t,x,u,params):
-#         return [u[0],u[1],x[0]]
-#         
-#     def pipe_pressure_output(self,t,x,u,params):
-#         return [u[0],x[0],u[1]]
-# 
-# 
-# @forge(auto_attribs=True)
-# class Valve(Component):
-#     Ao: float = 0.1 #area
-#     ts: float = 30/1000. #seconds
-#     rho: float = 1000
-#     Cd: float = 0.1
-#     discrete_control: bool = True    # contorl signal is zero or one, vs a goal
-#     
-#     tlast = 0
-#     min_dt:float = 1E-3
-# 
-#     def update_alpha(self,t,x,u,params):        
-#         ts = params.get('ts',self.ts)
-#         uctl = u[0]
-#         alpha = x[0]
-#         
-#         if t >= self.tlast+self.min_dt:
-#             self.dt = dt = max(abs(t - self.tlast),self.min_dt)
-#             self.tlast = t
-#         else:
-#             self.dt = dt = getattr(self,'dt',self.min_dt)
-# 
-#         dA = 1.0 / ts
-#         
-#         if self.discrete_control:
-#             if uctl==1:
-#                 if alpha < 1-dA*dt:
-#                     return dA
-#                 else:
-#                     return 1-alpha
-#             elif uctl==0:
-#                 if alpha > dA*dt:
-#                     return dA
-#                 else:
-#                     return 0-alpha
-#         else:
-#             vctl = min(max(uctl,0),1)
-#             d = (uctl-alpha)/dt
-#             dv = max(min(d,dA),-dA)
-#             return dv
-#                 
-#         
-#     def get_flow(self,t,x,u,params):
-#         rho = params.get('rho',self.rho)
-#         ts = params.get('ts',self.ts)
-#         Cd = params.get('Cd',self.Cd)
-#         Ao = params.get('Ao',self.Ao)
-# 
-#         alpha = x[0]
-#         if alpha < 0.05:
-#             return 0.0 #avoid divide by zero in area
-#         
-#         dP = u[1] 
-#         Av = Ao*min(max(alpha,0),1)
-#         return np.sign(dP)*Cd*Av*((2/rho)*abs(dP))**0.5
-# 
-# @forge(auto_attribs=True)
-# class PipeJunction(Component):
-#     
-#     n_pipes: int = 2
-#     Vi: float = 1
-#     B: float = 300E3
-#     
-#     min_dt = DT_DFLT
-#     model: 'InputOutputSystem' = None
-#     discrete:bool = True
-#     
-#     def __on_init__(self):
-#         state = ('P',)
-#         inputs = tuple(f'Q{i+1}' for i in range(self.n_pipes))
-#         outins = tuple(f'Qout{i+1}' for i in range(self.n_pipes))
-#         outputs = tuple(list(state)+list(outins)+['dQ'])
-#         if self.discrete:
-#             self.model = ct.NonlinearIOSystem(self.discrete_pressure_update,self.output,inputs=inputs,outputs=outputs,state=state,dt=True,name=self.name if self.name else 'junction')
-#             self.tlast = 0
-#         else:
-#             self.model = ct.NonlinearIOSystem(self.pressure_update,self.output,inputs=inputs,outputs=outputs,state=state,name=self.name if self.name else 'junction')
-#             
-#     def pressure_update(self,t,x,u,params):
-#         #TODO: update compressibility from temp / pressure ect.
-#         B = params.get('B',self.B)
-#         Vi = params.get('Vi',self.Vi)
-#         sumQ = sum(u)
-#         dPdt = (B/Vi)*sumQ
-#         return dPdt
-#         
-#     def discrete_pressure_update(self,t,x,u,params):
-#         dPdt = self.pressure_update(t,x,u,params)
-#         if self.discrete and isinstance(self.model.dt,float):
-#             dt = self.model.dt
-#             self.dt = dt
-# 
-#         else: #infer dt
-#             if t >= self.tlast+self.min_dt:
-#                 self.dt = dt = max(abs(t - self.tlast),self.min_dt)
-#                 self.tlast = t
-#             else:
-#                 self.dt = dt = getattr(self,'dt',self.min_dt)
-#         return self.dt*dPdt + x[0]
-#         
-#     def output(self,t,x,u,parms):
-#         return tuple([x[0]]+list(u)+[sum(u)])
-#       
-
-
-
-
-
-
-
-
-
-
-
-
-
-if __name__ == "__main__":
-    N = 10
-
-    rho = 1000.0
-    f = 0.015
-    L = 1.0
-    Po = 1e5
-
-    A = 1.0 * ones(N)
-    u = 0.0 * ones(N)
-    p = Po * ones(N)
-
-    Pin = 1.1e5
-    Uin = lambda Ps: sqrt((Pin - Ps) / (rho * 2.0))
-
-    def F(i):
-        ui = u[i]
-        ps = p[i]
-        F1 = rho * ui
-        F2 = F1 * ui + ps
-        return F1, F2
-
-    def J(i):
-        return 0.0, -rho * f
-
-    def decodeF(F1, F2):
-        up = F1 / rho
-        pp = F2 - rho * up**2.0
-        return up, pp
-
-    plast = p.copy()
-    ulast = u.copy()
-    it = 0
-    started = False
-    while not started or (plast - p).mean() > 1e-3 or (ulast - u).mean() > 1e-3:
-        started = True
-
-        plast = p.copy()
-        ulast = u.copy()
-
-        for i in range(N):
-            if i == 0:  # inlet
-                ps = p[i]
-                ui = Uin(ps)
-                u[i] = ui
-
-            # STATUS
-            F1, F2 = F(i)
-            J1, J2 = J(i)
-
-            # PREDICT i+1
-            dF1, dF2 = J1, J2
-            Fp1, Fp2 = F1 + dF1 * L, F2 + dF2 * L
-
-            up1, pp1 = decodeF(Fp1, Fp2)
-
-            # CORRECTOR i+1
-            Jp1, Jp2 = 0.0, -rho * f
-            dpF1, dpF2 = Jp1, Jp2
-
-            # avgGradients
-            dF1n, dF2n = 0.5 * (dpF1 + dF1), 0.5 * (dpF2 + dF2)
-
-            # Calculate i+1 actual
-            Fn1, Fn2 = F1 + dF1n * L, F2 + dF2n * L
-
-            un, pn = decodeF(Fn1, Fn2)
-            if N - 1 > i:
-                u[i + 1] = un
-                p[i + 1] = pn
-
-        for i in reversed(range(N)):
-            # if i == 0: #inlet
-            #    ps = p[i]
-            #    ui = Uin(ps)
-            #    u[i] = ui
-
-            if i == N - 1:
-                p[i] = Po
-
-            # STATUS
-            F1, F2 = F(i)
-            J1, J2 = J(i)
-
-            # PREDICT i+1
-            dF1, dF2 = J1, J2
-            Fp1, Fp2 = F1 + dF1 * L, F2 + dF2 * L
-
-            up1, pp1 = decodeF(Fp1, Fp2)
-
-            # CORRECTOR i+1
-            Jp1, Jp2 = 0.0, -rho * f
-            dpF1, dpF2 = Jp1, Jp2
-
-            # avgGradients
-            dF1n, dF2n = 0.5 * (dpF1 + dF1), 0.5 * (dpF2 + dF2)
-
-            # Calculate i+1 actual
-            Fn1, Fn2 = F1 + dF1n * L, F2 + dF2n * L
-
-            un, pn = decodeF(Fn1, Fn2)
-            if N - 1 > i:
-                u[i - 1] = un
-                p[i - 1] = pn
-
-        print(u)
-        print(p)
-        it += 1
-        if it >= 2:
-            break
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/eng/prediction.html b/docs/_build/html/_modules/engforge/eng/prediction.html deleted file mode 100644 index 9fe869f..0000000 --- a/docs/_build/html/_modules/engforge/eng/prediction.html +++ /dev/null @@ -1,467 +0,0 @@ - - - - - - engforge.eng.prediction — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.eng.prediction

-"""a module that defines PredictionMixin which uses sklearn to make predictions about results"""
-#core data
-import numpy
-import numpy as np
-import time
-import pandas
-import random
-
-#store average and variance in a dict
-base_stat = {'avg':0,'var':0}
-    
-
-

-[docs]
-class PredictionMixin:
-
-    train_window: int = 5000 #number of data points to use for training
-    prediction_goal_error: float = 0.02 #goal error for training 99%
-    trained: bool = False
-
-    _basis: np.ndarray = None #basis for normalizing  data 
-    _prediction_models: dict = None #parm: {'mod':obj,'train_time':float,'N':int,'train_score':scr}
-    _prediction_parms: list = None #list of strings to get from dataframe
-    _re_train_frac: float = 2 #retrain when N_data > model.N * _re_train_frac
-    _re_train_maxiter: int = 50 #max number of retraining iterations
-    _running_error: dict = None #parm: {'err':float,'N':int}
-    _fitted:bool = False
-    _training_history = None
-    _do_print = False
-    
-    _sigma_retrain = 3 #retrain when sigma is greater than this
-    _X_prediction_stats: list = None #list of strings to get from dataframe
-    _prediction_records: list = None#made lazily, but you can replace this
-
-    @property
-    def prediction_records(self):
-        if self._prediction_records is None:
-            self._prediction_records = []
-        return self._prediction_records
-    
-    @property
-    def _prediction_record(self):
-        raise NotImplementedError(f'must implement _prediction_record')
-    
-    @property
-    def basis(self):
-        return self._basis
-    
-

-[docs]
-    def add_prediction_record(self,record,extra_add=True,mult_sigma=1,target_items=1000):
-        """adds a record to the prediction records, and calcultes the average and variance of the data
-        :param record: a dict of the record
-        :param extra_add: if true, the record is added to the prediction records even if the data is inbounds
-        :returns: a boolean indicating if the record was out of bounds of current data (therefor should be added)
-        """
-        if self._X_prediction_stats is None:
-            self._X_prediction_stats = {p:base_stat.copy() for p in self._prediction_parms}
-        
-        N = len(self.prediction_records) + 1
-        Pf = max((N/target_items ),0.1)
-        J = len(self._prediction_parms)
-
-        #moving average and variance
-        out_of_bounds = extra_add #skip this check
-        choice = False
-        temp_stat = {}
-        for i,parm in enumerate(self._prediction_parms):
-            rec_val = record[parm]
-            cur_stat = self._X_prediction_stats[parm]
-            temp_stat[parm] = cur_stat = cur_stat.copy()
-            avg = cur_stat['avg']
-            dev = (rec_val - avg)
-            var = cur_stat['var']
-            std = var**0.5
-            std_err = std / N
-            #check out of bounds
-            #probability of acceptance - narrow distributions are not wanted
-            near_zero = abs(rec_val)/max(abs(avg),1) <= 0.005
-            if (not choice or not out_of_bounds) and avg != 0 and std != 0 and not near_zero:
-                g = 3*min((abs(avg)-std)/abs(std),1) #negative when std > avg
-                a =  min(abs(dev)/std/J,1)
-                #prob accept should be based on difference from average
-                prob_deny = np.e**g
-                prob_accept =  (a/Pf)
-                std_choice = std
-                avg_choice = avg
-                dev_choice = dev
-                choice = random.choices([True,False],[prob_accept,prob_deny])[0]
-            cur_stat['avg'] = avg + dev/N
-            cur_stat['var'] = var + (dev**2 - var)/N            
-
-        #observe point and predict to get error
-        self.observe_and_predict(record)    
-        
-        #update stats if point accepted
-        accepted = choice or out_of_bounds or extra_add
-        if accepted:
-            for parm,cur_stat in temp_stat.items():
-                self._X_prediction_stats[parm] = cur_stat #reassign (in case)
-
-        #fmt null values
-        if not choice:
-            std_choice = ''
-            avg_choice = ''
-            dev_choice = ''
-            prob_accept = ''
-            prob_deny = ''          
-
-        if accepted:
-            if self._do_print:
-                self.info(f'add record | chance: {choice and not extra_add} | {prob_accept:5.3f} | {prob_deny:5.3f} | {std_choice/avg_choice} | {dev_choice/std_choice} | {avg_choice}')
-            self._prediction_records.append(record)
-
-            try:
-                self.check_and_retrain(self.prediction_records)
-            except Exception as e:
-                self.warning(f'error in prediction: {e}')

-
-    
-

-[docs]
-    def check_out_of_domain(self,record,extra_margin=1,target_items=1000):
-        """checks if the record is in bounds of the current data"""
-        if self._X_prediction_stats is None:
-            return True 
-
-        if hasattr(self,'max_rec_parm') and self.max_rec_parm in record:
-            #we're not counting extemities
-            if record[self.max_rec_parm] > self.max_margin:
-                return False
-
-        N = len(self.prediction_records)
-        Pf = max((N/target_items),0.1)
-        J = len(self._prediction_parms)
-
-        for i,parm in enumerate(self._prediction_parms):
-            rec_val = record[parm]
-            cur_stat = self._X_prediction_stats[parm]
-            avg = cur_stat['avg']
-            dev = (rec_val - avg)
-            var = max(cur_stat['var'],1)
-            std = var**0.5
-            std_err = std / len(self.prediction_records)
-            #check out of bounds
-            g = 3*min((abs(avg)-std)/abs(std),1) #negative when std > avg
-            a =  min(abs(dev)/std/J,1)
-            near_zero = abs(rec_val)/max(abs(avg),1) <= 1E-3
-            prob_deny = np.e**g
-            prob_accept = (a*extra_margin/Pf) #relative to prob_deny
-            choice = random.choices([True,False],[prob_accept,prob_deny])[0]
-            if choice and not near_zero:
-                if self._do_print:
-                    self.info(f'record oob chance: {choice} | {prob_accept:5.3f} | {prob_deny:5.3f} | {std/abs(avg)} | {dev/std} | {avg} ')
-                return True
-        return False

-
-    
-
-
-

-[docs]
-    def train_compare(self,df,test_frac=2,train_full=False,min_rec=250):
-        """Use the dataframe to train the models, and compare the results to the current models using `train_frac` to divide total samples into training and testing sets, unless `train_full` is set.
-
-        :param df: dataframe to train with
-        :param test_frac: N/train_frac will be size of the training window
-        :param train_full: boolean to use full training data
-        :return: trained models
-        """
-        if self._prediction_models is None or self._basis is None:
-            return {}
-        
-        if self._training_history is None:
-            train_iter = {}
-            self._training_history = []
-        else:
-            train_iter = {}
-            
-
-        out = {}
-        N = len(df)
-        window = self.train_window
-        if window > (N/test_frac):
-            window = max(int(N/test_frac),25)
-        
-        MargRec = max(min_rec/len(self.prediction_records),1)
-
-        self.info(f'training dataset: {N} | training window: {window}')
-        for parm,mod_dict in self._prediction_models.items():
-            mod = mod_dict['mod']
-            X = df[self._prediction_parms]/self._basis
-            y = df[parm]
-            N = len(y)
-            
-            stl = time.time()
-            weights = self.prediction_weights(df,N)
-            if train_full:
-                mod.fit(X,y,weights)
-                etl = time.time()
-                scr = mod.score(X,y,weights)/MargRec
-                train_iter[parm] = {'scr':scr,'time':etl-stl,'N':N}
-            else:
-                mod.fit(*self._subsample_data(X,y,window,weights))
-                etl = time.time()
-                scr = mod.score(*self._score_data(X,y,weights))/MargRec
-                train_iter[parm] = {'scr':scr,'time':etl-stl,'N':N}
-            
-            dt = etl-stl
-
-            self.info(f'Prediction: {mod.__class__.__name__}| Score[{parm}] = {scr*100:3.5}% | Training Time: {dt}s')
-
-            out[parm] = {'mod':mod,'train_time':dt,'N':N,'train_score':scr}
-        
-        self._running_error = {parm:{'err':0.5,'N':0} for parm in self._prediction_models}
-        self._prediction_models = out
-        self._fitted = True
-
-        #add training item to history
-        self._training_history.append(train_iter)
-
-        #do something when trained
-        self.training_callback(self._prediction_models)
-
-        return out

-
-
-

-[docs]
-    def training_callback(self,models):
-        """override to provide a callback when training is complete, such as saving the models"""
-        pass

-
-
-    def prediction_weights(self,df,window):
-        return np.ones(min(len(df),window))
-
-    def _subsample_data(self,X,y,window,weights):
-        """subsamples the data to the window size"""
-        return X.iloc[:window],y.iloc[:window],weights[:window]
-
-    def _score_data(self,X,y,weights):
-        """override this, by default, just returns the data to the score"""
-        return X,y,weights
-
-

-[docs]
-    def score_data(self,df):
-        """scores a dataframe"""
-
-        if self._prediction_models is None:
-            return        
-        
-        if not self._fitted:
-            return                
-        
-        train_iter = {}
-        self._training_history.append(train_iter)
-
-        scores = {}        
-        for parm,mod_dict in self._prediction_models.items():
-            model = mod_dict['mod']
-            X = df[self._prediction_parms]/self._basis
-            y = df[parm]
-            scr = model.score(X,y)
-            scores[parm] = scr
-            train_iter[parm] = {'scr':scr,'time':np.nan,'N':len(y)}
-            if self._do_print:
-                self.info(f'Prediction: {model.__class__.__name__}| Score[{parm}] = {scr*100:3.5}%')
-            else:
-                self.debug(f'Prediction: {model.__class__.__name__}| Score[{parm}] = {scr*100:3.5}%')
-
-
-        return scores

-
-    
-

-[docs]
-    def observe_and_predict(self,row):
-        """uses the existing models to predict the row and measure the error"""
-        if self._prediction_models is None:
-            #self.warning('No models to predict with')
-            return
-        
-        if self._running_error is None:
-            self._running_error = {parm:{'err':0,'N':0} for parm in self._prediction_models}
-
-        if not self._fitted:
-            return
-        
-        if not all([p in row for p in self._prediction_parms]):
-            return
-
-        for parm,mod_dict in self._prediction_models.items():
-            model = mod_dict['mod']
-            if parm not in row:
-                continue
-            X = pandas.DataFrame([{parm:row[parm] for parm in self._prediction_parms}])
-            y = row[parm]
-            x = abs(model.predict(X))
-            if y == 0:
-                if x==0:
-                    err = 0
-                else:
-                    err = 1
-            else:
-                y = abs(y)
-                err = (y - x )/y
-            cerr = self._running_error[parm]['err']
-            N = self._running_error[parm]['N'] + 1
-            self._running_error[parm]['err'] = cerr + (err-cerr)/N
-            self._running_error[parm]['N'] = N

-
-
-
-

-[docs]
-    def check_and_retrain(self,records,min_rec=None):
-        """Checks if more data than threshold to train or if error is sufficiently low to ignore retraining, or if more data already exists than window size (no training)"""
-        if self._prediction_models is None:
-            return        
-
-        if not hasattr(self,'min_rec'):
-            min_rec = 50
-        else:
-            min_rec = self.min_rec
-
-        if self.trained:
-            if len(records) % min_rec == 0:
-                df = self.prediction_dataframe(records)
-                self.score_data(df)
-            return
-        
-        Nrec = len(records)
-        if Nrec < min_rec:
-            return
-        
-        df = self.prediction_dataframe(records)
-
-        if not self._fitted:
-            self.train_compare(df)
-            return
-
-        #an early check if the data is more than the target or if the error is less than the target
-        self.trained = all([(1-mod_dict['train_score']) <= self.prediction_goal_error for mod_dict in self._prediction_models.values()])
-
-        for parm,mod_dict in self._prediction_models.items():
-            model = mod_dict['mod']
-            N = mod_dict['N']
-            #
-            if Nrec > N * self._re_train_frac or (Nrec-N) > self._re_train_maxiter:
-                self.train_compare(df)
-                return

-
-
-    def prediction_dataframe(self,records):
-        df = pandas.DataFrame(records)._get_numeric_data()
-        df[np.isnan(df)] = 0 #zeros baybee
-        return df

-
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/eng/solid_materials.html b/docs/_build/html/_modules/engforge/eng/solid_materials.html deleted file mode 100644 index 9b052df..0000000 --- a/docs/_build/html/_modules/engforge/eng/solid_materials.html +++ /dev/null @@ -1,592 +0,0 @@ - - - - - - engforge.eng.solid_materials — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.eng.solid_materials

-from engforge.configuration import Configuration, forge
-from engforge.properties import *
-from engforge.common import *
-import matplotlib
-import random
-import attr
-import numpy
-import inspect
-import sys
-import uuid
-import json,hashlib
-
-# One Material To Merge Them All
-from PyNite import Material as PyNiteMat
-from sectionproperties.pre.pre import Material as SecMat
-
-SectionMaterial = SecMat.mro()[0]
-
-ALL_MATERIALS = []
-METALS = []
-PLASTICS = []
-CERAMICS = []
-
-
-CMAP = matplotlib.cm.get_cmap("viridis")
-
-
-

-[docs]
-def random_color():
-    return CMAP(random.randint(0, 255))

-
-
-

-[docs]
-def ih(val):
-    """ignore hash"""
-    return ''

-
-
-
-

-[docs]
-@forge(hash=False)
-class SolidMaterial(SectionMaterial, PyNiteMat.Material, Configuration):
-    """A class to hold physical properties of solid structural materials and act as both a section property material and a pynite material"""
-
-    __metaclass__ = SecMat
-
-    name: str = attr.ib(default="solid material")
-    color: float = attr.ib(factory=random_color,hash=False,eq=ih)
-
-    # Structural Properties
-    density: float = attr.ib(default=1.0)
-    elastic_modulus: float = attr.ib(default=1e8)  # Pa
-    in_shear_modulus: float = attr.ib(default=None)
-    yield_strength: float = attr.ib(default=1e6)  # Pa
-    tensile_strength_ultimate: float = attr.ib(default=2e6)  # Pa
-    hardness: float = attr.ib(default=10)  # rockwell
-    izod: float = attr.ib(default=100)
-    poissons_ratio: float = attr.ib(default=0.30)
-
-    # Thermal Properties
-    melting_point: float = attr.ib(default=1000 + 273)  # K
-    maxium_service_temp: float = attr.ib(default=500 + 273)  # K
-    thermal_conductivity: float = attr.ib(default=10)  # W/mK
-    specific_heat: float = attr.ib(default=1000)  # J/kgK
-    thermal_expansion: float = attr.ib(default=10e-6)  # m/mK
-
-    # Electrical Properties
-    electrical_resistitivity: float = attr.ib(default=1e-8)  # ohm-m
-
-    # Economic Properties
-    cost_per_kg: float = attr.ib(default=1.0)  # dollar per kg
-
-    # Saftey Properties
-    factor_of_saftey: float = attr.ib(default=1.5)
-
-    _unique_id: str = None
-
-

-[docs]
-    @classmethod
-    def pre_compile(cls):
-        cls.color = random_color()

-
-
-    @property
-    def E(self) -> float:
-        return self.elastic_modulus
-
-    @property
-    def G(self) -> float:
-        return self.shear_modulus
-
-    @property
-    def nu(self) -> float:
-        return self.poissons_ratio
-
-    @property
-    def rho(self) -> float:
-        return self.density
-
-    @property
-    def shear_modulus(self) -> float:
-        """Shear Modulus"""
-        if self.in_shear_modulus:
-            return self.in_shear_modulus
-        # hello defaults
-        return self.E / (2.0 * (1 + self.poissons_ratio))
-
-    @property
-    def yield_stress(self) -> float:
-        return self.yield_strength
-
-    @property
-    def ultimate_stress(self) -> float:
-        return self.tensile_strength_ultimate
-
-    @inst_vectorize
-    def von_mises_stress_max(self, normal_stress, shear_stress):
-        a = normal_stress / 2.0
-        b = numpy.sqrt(a**2.0 + shear_stress**2.0)
-        v1 = a - b
-        v2 = a + b
-        vout = v1 if abs(v1) > abs(v2) else v2
-        return vout
-
-    @property
-    def allowable_stress(self) -> float:
-        return self.yield_stress / self.factor_of_saftey
-
-    @property
-    def unique_id(self):
-        if self._unique_id is None:
-            uid = str(uuid.uuid4())
-            self._unique_id = f"{self.name}_{uid}"
-        return self._unique_id
-
-    def __hash__(self):
-        """a stable hash that ignores name, color and unique id, ie only the material properties are the same if two hashes are the equal"""
-        #print('hashing...')
-        ignore = ['color','_unique_id','name']
-        ict = {k:v for k,v in self.input_as_dict.items() if k not in ignore}
-        d = hashlib.sha1(json.dumps(ict, sort_keys=True).encode())
-        return int(d.hexdigest(),16)    

-
-
-

-[docs]
-@forge(hash=False)
-class SS_316(SolidMaterial):
-    name: str = attr.ib(default="stainless steel 316")
-
-    # Structural Properties
-    density: float = attr.ib(default=8000.0)  # kg/m3
-    elastic_modulus: float = attr.ib(default=193e9)  # Pa
-    yield_strength: float = attr.ib(default=240e6)  # Pa
-    tensile_strength_ultimate: float = attr.ib(default=550e6)  # Pa
-    poissons_ratio: float = attr.ib(default=0.30)
-
-    # Thermal Properties
-    melting_point: float = attr.ib(default=1370 + 273)  # K
-    maxium_service_temp: float = attr.ib(default=870 + 273)  # K
-    thermal_conductivity: float = attr.ib(default=16.3)  # W/mK
-    specific_heat: float = attr.ib(default=500)  # J/kgK
-    thermal_expansion: float = attr.ib(default=16e-6)  # m/mK
-
-    # Electrical Properties
-    electrical_resistitivity: float = attr.ib(default=7.4e-7)  # ohm-m
-
-    # Economic Properties
-    cost_per_kg: float = attr.ib(default=3.26)  # dollar per kg

-
-
-
-

-[docs]
-@forge(hash=False)
-class ANSI_4130(SolidMaterial):
-    name: str = attr.ib(default="steel 4130")
-
-    # Structural Properties
-    density: float = attr.ib(default=7872.0)  # kg/m3
-    elastic_modulus: float = attr.ib(default=205e9)  # Pa
-    yield_strength: float = attr.ib(default=460e6)  # Pa
-    tensile_strength_ultimate: float = attr.ib(default=560e6)  # Pa
-    poissons_ratio: float = attr.ib(default=0.28)
-
-    # Thermal Properties
-    melting_point: float = attr.ib(default=1432 + 273)  # K
-    maxium_service_temp: float = attr.ib(default=870 + 273)  # K
-    thermal_conductivity: float = attr.ib(default=42.7)  # W/mK
-    specific_heat: float = attr.ib(default=477)  # J/kgK
-    thermal_expansion: float = attr.ib(default=11.2e-6)  # m/mK
-
-    # Electrical Properties
-    electrical_resistitivity: float = attr.ib(default=2.23e-7)  # ohm-m
-
-    # Economic Properties
-    cost_per_kg: float = attr.ib(default=2.92)  # dollar per kg

-
-
-
-

-[docs]
-@forge(hash=False)
-class ANSI_4340(SolidMaterial):
-    name: str = attr.ib(default="steel 4340")
-
-    # Structural Properties
-    density: float = attr.ib(default=7872.0)  # kg/m3
-    elastic_modulus: float = attr.ib(default=192e9)  # Pa
-    yield_strength: float = attr.ib(default=470e6)  # Pa
-    tensile_strength_ultimate: float = attr.ib(default=745e6)  # Pa
-    poissons_ratio: float = attr.ib(default=0.28)
-
-    # Thermal Properties
-    melting_point: float = attr.ib(default=1427 + 273)  # K
-    maxium_service_temp: float = attr.ib(default=830 + 273)  # K
-    thermal_conductivity: float = attr.ib(default=44.5)  # W/mK
-    specific_heat: float = attr.ib(default=475)  # J/kgK
-    thermal_expansion: float = attr.ib(default=13.7e-6)  # m/mK
-
-    # Electrical Properties
-    electrical_resistitivity: float = attr.ib(default=2.48e-7)  # ohm-m
-
-    # Economic Properties
-    cost_per_kg: float = attr.ib(default=2.23)  # dollar per kg

-
-
-
-

-[docs]
-@forge(hash=False)
-class Aluminum(SolidMaterial):
-    name: str = attr.ib(default="aluminum generic")
-
-    # Structural Properties
-    density: float = attr.ib(default=2680.0)  # kg/m3
-    elastic_modulus: float = attr.ib(default=70.3e9)  # Pa
-    yield_strength: float = attr.ib(default=240e6)  # Pa
-    tensile_strength_ultimate: float = attr.ib(default=290e6)  # Pa
-    poissons_ratio: float = attr.ib(default=0.33)
-
-    # Thermal Properties
-    melting_point: float = attr.ib(default=607 + 273)  # K
-    maxium_service_temp: float = attr.ib(default=343 + 273)  # K
-    thermal_conductivity: float = attr.ib(default=138)  # W/mK
-    specific_heat: float = attr.ib(default=880)  # J/kgK
-    thermal_expansion: float = attr.ib(default=22.1e-6)  # m/mK
-
-    # Electrical Properties
-    electrical_resistitivity: float = attr.ib(default=4.99e-7)  # ohm-m
-
-    # Economic Properties
-    cost_per_kg: float = attr.ib(default=1.90)  # dollar per kg

-
-
-
-

-[docs]
-@forge(hash=False)
-class CarbonFiber(SolidMaterial):
-    name: str = attr.ib(default="carbon fiber")
-
-    # Structural Properties
-    density: float = attr.ib(default=1600.0)  # kg/m3
-    elastic_modulus: float = attr.ib(default=140e9)  # Pa
-    yield_strength: float = attr.ib(default=686e6)  # Pa
-    tensile_strength_ultimate: float = attr.ib(default=919e6)  # Pa
-    poissons_ratio: float = attr.ib(default=0.33)
-
-    # Thermal Properties
-    melting_point: float = attr.ib(default=300 + 273)  # K
-    maxium_service_temp: float = attr.ib(default=150 + 273)  # K
-    thermal_conductivity: float = attr.ib(default=250)  # W/mK
-    specific_heat: float = attr.ib(default=1100)  # J/kgK
-    thermal_expansion: float = attr.ib(default=14.1e-6)  # m/mK
-
-    # Electrical Properties
-    electrical_resistitivity: float = attr.ib(default=10000)  # ohm-m
-
-    # Economic Properties
-    cost_per_kg: float = attr.ib(default=1.90)  # dollar per kg

-
-
-
-

-[docs]
-@forge(hash=False)
-class Concrete(SolidMaterial):
-    name: str = attr.ib(default="concrete")
-
-    # Structural Properties
-    density: float = attr.ib(default=2000.0)  # kg/m3
-    elastic_modulus: float = attr.ib(default=2.92e9)  # Pa
-    yield_strength: float = attr.ib(default=57.9e6)  # Pa
-    tensile_strength_ultimate: float = attr.ib(default=0.910e6)  # Pa
-    poissons_ratio: float = attr.ib(default=0.26)
-
-    # Thermal Properties
-    melting_point: float = attr.ib(default=3000 + 273)  # K
-    maxium_service_temp: float = attr.ib(default=3000 + 273)  # K
-    thermal_conductivity: float = attr.ib(default=0.5)  # W/mK
-    specific_heat: float = attr.ib(default=736)  # J/kgK
-    thermal_expansion: float = attr.ib(default=16.41e-6)  # m/mK
-
-    # Electrical Properties
-    electrical_resistitivity: float = attr.ib(default=1e6)  # ohm-m
-
-    # Economic Properties
-    cost_per_kg: float = attr.ib(default=95.44 / 1000.0)  # dollar per kg

-
-
-
-

-[docs]
-@forge(hash=False)
-class DrySoil(SolidMaterial):
-    name: str = attr.ib(default="dry soil")
-
-    # Structural Properties
-    density: float = attr.ib(default=1600.0)  # kg/m3
-    elastic_modulus: float = attr.ib(default=70.3e9)  # Pa
-    yield_strength: float = attr.ib(default=0.0)  # Pa
-    tensile_strength_ultimate: float = attr.ib(default=0.0)  # Pa
-    poissons_ratio: float = attr.ib(default=0.33)
-
-    # Thermal Properties
-    melting_point: float = attr.ib(default=1550 + 273)  # K
-    maxium_service_temp: float = attr.ib(default=1450 + 273)  # K
-    thermal_conductivity: float = attr.ib(default=0.25)  # W/mK
-    specific_heat: float = attr.ib(default=800)  # J/kgK
-    thermal_expansion: float = attr.ib(default=16.41e-6)  # m/mK
-
-    # Electrical Properties
-    electrical_resistitivity: float = attr.ib(default=1e6)  # ohm-m
-
-    # Economic Properties
-    cost_per_kg: float = attr.ib(default=44.78 / 1000.0)  # dollar per kg

-
-
-
-

-[docs]
-@forge(hash=False)
-class WetSoil(SolidMaterial):
-    name: str = attr.ib(default="wet soil")
-
-    # Structural Properties
-    density: float = attr.ib(default=2080.0)  # kg/m3
-    elastic_modulus: float = attr.ib(default=70.3e9)  # Pa
-    yield_strength: float = attr.ib(default=0.0)  # Pa
-    tensile_strength_ultimate: float = attr.ib(default=0.0)  # Pa
-    poissons_ratio: float = attr.ib(default=0.33)
-
-    # Thermal Properties
-    melting_point: float = attr.ib(default=1550 + 273)  # K
-    maxium_service_temp: float = attr.ib(default=1450 + 273)  # K
-    thermal_conductivity: float = attr.ib(default=2.75)  # W/mK
-    specific_heat: float = attr.ib(default=1632)  # J/kgK
-    thermal_expansion: float = attr.ib(default=16.41e-6)  # m/mK
-
-    # Electrical Properties
-    electrical_resistitivity: float = attr.ib(default=940.0)  # ohm-m
-
-    # Economic Properties
-    cost_per_kg: float = attr.ib(default=34.44 / 1000.0)  # dollar per kg

-
-
-
-

-[docs]
-@forge(hash=False)
-class Rock(SolidMaterial):
-    name: str = attr.ib(default="wet soil")
-
-    # Structural Properties
-    density: float = attr.ib(default=2600.0)  # kg/m3
-    elastic_modulus: float = attr.ib(default=67e9)  # Pa
-    yield_strength: float = attr.ib(default=13e6)  # Pa
-    tensile_strength_ultimate: float = attr.ib(default=13e6)  # Pa
-    poissons_ratio: float = attr.ib(default=0.26)
-
-    # Thermal Properties
-    melting_point: float = attr.ib(default=3000)  # K
-    maxium_service_temp: float = attr.ib(default=3000)  # K
-    thermal_conductivity: float = attr.ib(default=1.0)  # W/mK
-    specific_heat: float = attr.ib(default=2000)  # J/kgK
-    thermal_expansion: float = attr.ib(default=16.41e-6)  # m/mK
-
-    # Electrical Properties
-    electrical_resistitivity: float = attr.ib(default=1e6)  # ohm-m
-
-    # Economic Properties
-    cost_per_kg: float = attr.ib(default=50.44 / 1000.0)  # dollar per kg

-
-
-
-

-[docs]
-@forge(hash=False)
-class Rubber(SolidMaterial):
-    name: str = attr.ib(default="rubber")
-
-    # Structural Properties
-    density: float = attr.ib(default=1100.0)  # kg/m3
-    elastic_modulus: float = attr.ib(default=0.1e9)  # Pa
-    yield_strength: float = attr.ib(default=0.248e6)  # Pa
-    tensile_strength_ultimate: float = attr.ib(default=0.5e6)  # Pa
-    poissons_ratio: float = attr.ib(default=0.33)
-
-    # Thermal Properties
-    melting_point: float = attr.ib(default=600 + 273)  # K
-    maxium_service_temp: float = attr.ib(default=300 + 273)  # K
-    thermal_conductivity: float = attr.ib(default=0.108)  # W/mK
-    specific_heat: float = attr.ib(default=2005)  # J/kgK
-    thermal_expansion: float = attr.ib(default=100e-6)  # m/mK
-
-    # Electrical Properties
-    electrical_resistitivity: float = attr.ib(default=1e13)  # ohm-m
-
-    # Economic Properties
-    cost_per_kg: float = attr.ib(default=40.0 / 1000.0)  # dollar per kg

-
-
-
-# @attr.s
-# class AL_6063(SolidMaterial):
-#     name:str = attr.ib(default='aluminum 6063')
-
-#     #Structural Properties
-#     density:float = attr.ib(default=2700.0) #kg/m3
-#     elastic_modulus:float  = attr.ib(default=192E9) #Pa
-#     tensile_strength_yield = attr.ib(default=470E6) #Pa
-#     tensile_strength_ultimate:float = attr.ib(default=745E6) #Pa
-#     poissons_ratio:float = attr.ib(default=0.28)
-
-#     #Thermal Properties
-#     melting_point:float = attr.ib(default=1427+273) #K
-#     maxium_service_temp:float = attr.ib(default=830+273) #K
-#     thermal_conductivity:float = attr.ib(default=44.5) #W/mK
-#     specific_heat:float = attr.ib(default=475) #J/kgK
-#     thermal_expansion:float = attr.ib(default = 13.7E-6) #m/mK
-
-#     #Electrical Properties
-#     electrical_resistitivity:float = attr.ib(default=2.48E-7) #ohm-m
-
-#     #Economic Properties
-#     cost_per_kg:float = attr.ib(default=1.90) #dollar per kg
-
-
-# @attr.s
-# class AL_7075(SolidMaterial):
-#     name:str = attr.ib(default='aluminum 7075')
-
-#     #Structural Properties
-#     density:float = attr.ib(default=2700.0) #kg/m3
-#     elastic_modulus:float  = attr.ib(default=192E9) #Pa
-#     tensile_strength_yield = attr.ib(default=470E6) #Pa
-#     tensile_strength_ultimate:float = attr.ib(default=745E6) #Pa
-#     poissons_ratio:float = attr.ib(default=0.28)
-
-#     #Thermal Properties
-#     melting_point:float = attr.ib(default=1427+273) #K
-#     maxium_service_temp:float = attr.ib(default=830+273) #K
-#     thermal_conductivity:float = attr.ib(default=44.5) #W/mK
-#     specific_heat:float = attr.ib(default=475) #J/kgK
-#     thermal_expansion:float = attr.ib(default = 13.7E-6) #m/mK
-
-#     #Electrical Properties
-#     electrical_resistitivity:float = attr.ib(default=2.48E-7) #ohm-m
-
-#     #Economic Properties
-#     cost_per_kg:float = attr.ib(default=1.90) #dollar per kg
-
-
-ALL_MATERIALS = [
-    mat
-    for name, mat in inspect.getmembers(sys.modules[__name__])
-    if inspect.isclass(mat)
-    and issubclass(mat, SolidMaterial)
-    and mat is not SolidMaterial
-]
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/eng/structure_beams.html b/docs/_build/html/_modules/engforge/eng/structure_beams.html deleted file mode 100644 index 3800f27..0000000 --- a/docs/_build/html/_modules/engforge/eng/structure_beams.html +++ /dev/null @@ -1,971 +0,0 @@ - - - - - - engforge.eng.structure_beams — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.eng.structure_beams

-from collections.abc import Iterable
-import attr
-import numpy
-import functools
-import shapely
-import pandas
-from shapely.geometry import Polygon, Point
-
-from engforge.tabulation import (
-    TABLE_TYPES,
-    NUMERIC_VALIDATOR,
-    system_property,
-)
-from engforge.configuration import forge, Configuration
-from engforge.components import Component
-
-# from engforge.analysis import Analysis
-from engforge.properties import system_property
-from engforge.system import System
-from engforge.eng.solid_materials import *
-from engforge.common import *
-import engforge.eng.geometry as ottgeo
-from engforge.eng.costs import CostModel,cost_property
-
-import sectionproperties
-import sectionproperties.pre.geometry as geometry
-import sectionproperties.pre.library.primitive_sections as sections
-import sectionproperties.analysis.section as cross_section
-import PyNite as pynite
-
-# from PyNite import Visualization
-import copy
-
-nonetype = type(None)
-
-
-

-[docs]
-def rotation_matrix_from_vectors(vec1, vec2):
-    """Find the rotation matrix that aligns vec1 to vec2
-    :param vec1: A 3d "source" vector
-    :param vec2: A 3d "destination" vector
-    :return mat: A transform matrix (3x3) which when applied to vec1, aligns it with vec2.
-    """
-    a, b = (vec1 / numpy.linalg.norm(vec1)).reshape(3), (
-        vec2 / numpy.linalg.norm(vec2)
-    ).reshape(3)
-    v = numpy.cross(a, b)
-    if any(v):  # if not all zeros then
-        c = numpy.dot(a, b)
-        s = numpy.linalg.norm(v)
-        kmat = numpy.array(
-            [[0, -v[2], v[1]], [v[2], 0, -v[0]], [-v[1], v[0], 0]]
-        )
-        return numpy.eye(3) + kmat + kmat.dot(kmat) * ((1 - c) / (s**2))
-
-    else:
-        return numpy.eye(
-            3
-        )  # cross of all zeros only occurs on identical directions

-
-
-
-

-[docs]
-@forge
-class Beam(Component,CostModel):
-    """Beam is a wrapper for emergent useful properties of the structure"""
-
-    # parent structure, will be in its _beams
-    structure: "Structure" = attr.ib()
-
-    name: str = attr.ib()
-    material: "SolidMaterial" = attr.ib(
-        validator=attr.validators.instance_of(SolidMaterial),
-    )
-    section: "Profile2D" = attr.ib(
-        validator=attr.validators.instance_of(
-            (
-                geometry.Geometry,
-                ottgeo.Profile2D,
-                type(None),
-            )
-        )
-    )
-
-    # Section Overrides
-    in_Iy: float = attr.ib(
-        default=None,
-        validator=attr.validators.instance_of((int, float, nonetype)),
-    )
-    in_Ix: float = attr.ib(
-        default=None,
-        validator=attr.validators.instance_of((int, float, nonetype)),
-    )
-    in_J: float = attr.ib(
-        default=None,
-        validator=attr.validators.instance_of((int, float, nonetype)),
-    )
-    in_A: float = attr.ib(
-        default=None,
-        validator=attr.validators.instance_of((int, float, nonetype)),
-    )
-    # by default assume symmetric
-    in_Ixy: float = attr.ib(
-        default=0.0,
-        validator=attr.validators.instance_of((int, float, nonetype)),
-    )
-
-    min_mesh_size: float = attrs.field(default=0.01)
-    analysis_intervals: int = attrs.field(default=3)
-
-    _L = None
-    _ITensor = None
-
-    min_stress_xy = None  # set to true or false
-
-    def __on_init__(self):
-        self.debug("initalizing...")
-        # update material
-        if isinstance(self.section, ottgeo.ShapelySection):
-            if self.section.material is None:
-                raise Exception("No Section Material")
-            else:
-                self.material = self.section.material
-        self.update_section(self.section)
-
-    def update_section(self, section):
-        self.section = section
-
-        self.debug(f"determining {section} properties...")
-        if isinstance(self.section, geometry.Geometry):
-            self.debug(f'converting to shapelysection {section}')
-            if not self.section.material:
-                material = self.material
-            else:
-                material = self.section.material
-            self.section = ottgeo.ShapelySection(shape=self.section,material=self.material)
-
-        if isinstance(self.section, ottgeo.ShapelySection):
-            self.debug(f"determining profile {section} properties...")
-            self.in_Ix = self.section.Ixx
-            self.in_Iy = self.section.Iyy
-            self.in_J = self.section.J
-            self.in_A = self.section.A
-            self.in_Ixy = self.section.Ixy
-
-        elif isinstance(self.section, ottgeo.Profile2D):
-            self.warning(f"use shapely section instead {section} properties...")
-            #raise Exception("use shapely section instead")
-            self.in_Ix = self.section.Ixx
-            self.in_Iy = self.section.Iyy
-            self.in_J = self.section.J
-            self.in_A = self.section.A
-        else:
-            raise Exception(f"unhanelded input {self.section}")
-
-        self.debug(f"checking input values")
-        assert all(
-            [
-                val is not None
-                for val in (self.in_Iy, self.in_Ix, self.in_J, self.in_A)
-            ]
-        )
-
-        # Assemble tensor
-        T = [[self.in_Ix, self.in_Ixy], [self.in_Ixy, self.in_Iy]]
-        self._ITensor = numpy.array(T)
-
-    @system_property
-    def current_combo(self) -> str:
-        return self.structure.current_combo
-
-    @system_property
-    def L(self) -> float:
-        return self.length
-
-    @system_property
-    def length(self) -> float:
-        return self.member.L()
-
-    @property
-    def member(self):
-        return self.structure.members[self.name]
-
-    @property
-    def n1(self):
-        return self.member.i_node
-
-    @property
-    def n2(self):
-        return self.member.j_node
-
-    @property
-    def P1(self):
-        return numpy.array([self.n1.X, self.n1.Y, self.n1.Z])
-
-    @property
-    def P2(self):
-        return numpy.array([self.n2.X, self.n2.Y, self.n2.Z])
-
-    @system_property
-    def E(self) -> float:
-        return self.material.E
-
-    @system_property
-    def G(self) -> float:
-        return self.material.G
-
-    @property
-    def ITensor(self):
-        return self._ITensor
-
-    @system_property
-    def Iy(self) -> float:
-        return self.in_Iy
-
-    @system_property
-    def Ix(self) -> float:
-        return self.in_Ix
-
-    @system_property
-    def J(self) -> float:
-        return self.in_J
-
-    @system_property
-    def A(self) -> float:
-        return self.in_A
-
-    @property
-    def Ao(self):
-        """outside area, over ride for hallow sections"""
-        if isinstance(self.section, ottgeo.Profile2D):
-            return self.section.Ao
-        return self.A
-
-    @system_property
-    def Ixy(self) -> float:
-        return self.ITensor[0, 1]
-
-    @system_property
-    def Imx(self) -> float:
-        return self.material.density * self.Ix
-
-    @system_property
-    def Imy(self) -> float:
-        return self.material.density * self.Iy
-
-    @system_property
-    def Imxy(self) -> float:
-        return self.material.density * self.Ixy
-
-    @system_property
-    def Jm(self) -> float:
-        return self.material.density * self.J
-
-    @system_property
-    def Imz(self) -> float:
-        return self.mass * self.L**2.0 / 12.0
-
-    @system_property
-    def Iz(self) -> float:
-        """Outside area inertia on z"""
-        return self.A * self.L**2.0 / 12.0
-
-    @system_property
-    def Izo(self) -> float:
-        """Outside area inertia on z"""
-        return self.Ao * self.L**2.0 / 12.0
-
-    @property
-    def LOCAL_INERTIA(self):
-        """the mass inertia tensor in local frame"""
-        return numpy.array(
-            [
-                [self.Imz + self.Imx, self.Imxy, 0.0],
-                [self.Imxy, self.Imz + self.Imy, 0.0],
-                [0.0, 0.0, self.Jm],
-            ]
-        )
-
-    @property
-    def INERTIA(self):
-        """the mass inertia tensor in global structure frame"""
-        # TODO: include rotation from beam uv vector frame? is it ok already?
-        return self.RotationMatrix.dot(self.LOCAL_INERTIA)
-
-    @property
-    def GLOBAL_INERTIA(self):
-        """Returns the rotated inertia matrix with structure relative parallal axis contribution"""
-        return self.INERTIA + self.CG_RELATIVE_INERTIA
-
-    @property
-    def CG_RELATIVE_INERTIA(self):
-        """the mass inertia tensor in global frame"""
-        dcg = self.cog - self.structure.cog
-        return self.mass * numpy.eye(3) * dcg * dcg.T
-
-    @system_property
-    def Vol(self) -> float:
-        return self.A * self.L
-
-    @system_property
-    def Vol_outside(self) -> float:
-        return self.Ao * self.L
-
-    @system_property
-    def section_mass(self) -> float:
-        return self.material.density * self.A
-
-    @system_property
-    def mass(self) -> float:
-        return self.material.density * self.Vol
-
-    @cost_property(category='mfg,material,beams')
-    def cost(self) -> float:
-        return self.mass * self.material.cost_per_kg
-
-    @property
-    def centroid2d(self):
-        return self.section._sec.get_c()
-
-    @instance_cached
-    def centroid3d(self):
-        return self.L_vec / 2.0 + self.P1
-
-    @property
-    def n_vec(self):
-        return self.L_vec / self.L
-
-    @property
-    def L_vec(self):
-        return self.P2 - self.P1
-
-    @property
-    def cog(self):
-        return self.centroid3d
-
-    # Geometry Tabulation
-    # p1
-    @system_property
-    def X1(self) -> float:
-        return self.P1[0]
-
-    @system_property
-    def Y1(self) -> float:
-        return self.P1[1]
-
-    @system_property
-    def Z1(self) -> float:
-        return self.P1[2]
-
-    # p2
-    @system_property
-    def X2(self) -> float:
-        return self.P2[0]
-
-    @system_property
-    def Y2(self) -> float:
-        return self.P2[1]
-
-    @system_property
-    def Z2(self) -> float:
-        return self.P2[2]
-
-    # cg
-    @system_property
-    def Xcg(self) -> float:
-        return self.centroid3d[0]
-
-    @system_property
-    def Ycg(self) -> float:
-        return self.centroid3d[1]
-
-    @system_property
-    def Zcg(self) -> float:
-        return self.centroid3d[2]
-
-    @property
-    def RotationMatrix(self):
-        n_o = [
-            1,
-            0,
-            0,
-        ]
-        # n_vec is along Z, so we must tranlate from the along axis which is z
-        return rotation_matrix_from_vectors(n_o, self.n_vec)
-
-    @property
-    def ReverseRotationMatrix(self):
-        # FIXME: Ensure that this is the correct orientation
-        return self.RotationMatrix.T
-
-    def section_results(self):
-        return self.section._sec.display_results()
-
-    def show_mesh(self):
-        return self.section._sec.plot_mesh()
-
-

-[docs]
-    def estimate_stress(self, force_calc=True,**forces):
-        """uses the best available method to determine max stress in the beam, for ShapelySections this is done through a learning process, for other sections it is done through a simple calculation aimed at providing a conservative estimate"""
-        if isinstance(self.section, ottgeo.ShapelySection):
-            return self.section.estimate_stress(**forces,force_calc=force_calc)
-        else:
-            return self._fallback_estimate_stress(**forces)

-
-        
-    def _fallback_estimate_stress(self, n, vx, vy, mxx, myy, mzz,SM=5,**extra):
-        """sum the absolute value of each stress component. This isn't accurate but each value here should represent the worst sections, and take the 1-norm to max for each type of stress"""
-
-        if self.section.x_bounds is None:
-            self.warning(f"bad section bounds")
-            self.section.calculate_bounds()
-
-        m_y = max([abs(v) for v in self.section.y_bounds])
-        m_x = max([abs(v) for v in self.section.x_bounds])
-
-        sigma_n = n / self.in_A
-
-        sigma_bx = mxx * m_y / self.in_Ix
-        sigma_by = myy * m_x / self.in_Iy
-        sigma_tw = mzz * max(m_y, m_x) / self.in_J
-
-        # A2 = self.in_A/2.
-        # experimental
-        # sigma_vx = vx * (A2*m_y/2) / (self.in_Iy*m_x)
-        # sigma_vy = vy * (A2*m_x/2) / (self.in_Ix*m_y)
-
-        # assume circle (worst case)
-        sigma_vx = vx * 0.75 / self.in_A
-        sigma_vy = vy * 0.75 / self.in_A
-
-        max_bend = abs(sigma_bx) + abs(sigma_by)
-        max_shear = abs(sigma_vx) + abs(sigma_vy)
-
-        return (abs(sigma_n) + max_bend + abs(sigma_tw) + max_shear)*SM
-
-

-[docs]
-    def get_forces_at(self, x, combo=None,lower=True,skip_principle=True):
-        """outputs pynite results in section_properties.calculate_stress() input"""
-        if combo is None:
-            combo = self.structure.current_combo
-
-        x = x * self.L  # frac of L
-        principles = ['m11','m22','m33']
-
-        inp = dict(
-            N=self.member.axial(x, combo),
-            Vx=self.member.shear("Fz", x, combo),
-            Vy=self.member.shear("Fy", x, combo),
-            Mxx=self.member.moment("Mz", x, combo),
-            Myy=self.member.moment("My", x, combo),
-            M11=0,
-            M22=0,
-            Mzz=self.member.torque(x, combo),
-        )
-        inp = {k.lower():v for k, v in inp.items() if any([k.lower() not in principles]) or not skip_principle}
-        return inp

-
-
-

-[docs]
-    def get_stress_at(self, x, combo=None,**kw):
-        """takes force input and runs stress calculation as a fraction of material properties"""
-        if combo is None:
-            combo = self.structure.current_combo
-
-        inp = self.get_forces_at(x, combo)
-        
-        #preferr real stresses to fail fraction
-        if 'value' not in kw:
-            kw['value'] = True
-
-        return self.calculate_stress(**inp,**kw)

-
-
-

-[docs]
-    def calculate_stress(self, **forces):
-        """takes force input and runs stress calculation as a fraction of material properties, see ShapelySection.calculate_stress() for more details"""
-        #preferr real stresses to fail fraction
-        if 'value' not in forces:
-            forces['value'] = True        
-            
-        return self.section.calculate_stress(**forces)

-
-
-    @property
-    def Fg(self):
-        """force of gravity"""
-        return numpy.array([0, 0, -self.mass * g])
-
-    # RESULTS:
-    @system_property
-    def max_stress_estimate(self) -> float:
-        """estimates these are proportional to stress but 2D FEA is "truth" since we lack cross section specifics"""
-        if not self.structure._any_solved:
-            return numpy.nan
-        
-        vals = [ self.estimate_stress(**self.get_forces_at(x),value=True) for x in [0, 0.5, 1]]
-
-        try:
-            return max(vals)
-            
-        except Exception as e:
-            self.warning(f'failed to get max stress estimate {e}| {vals}')
-            return numpy.nan
-
-    @system_property
-    def fail_factor_estimate(self) -> float:
-        """the ratio of max estimated stress to the material's allowable stress"""
-        if not self.structure._any_solved:
-            return numpy.nan              
-        return self.max_stress_estimate / self.material.allowable_stress
-
-    # axial
-    @system_property
-    def min_axial(self) -> float:
-        if not self.structure._any_solved:
-            return numpy.nan
-        return self.member.min_axial(self.structure.current_combo)
-
-    @system_property
-    def max_axial(self) -> float:
-        if not self.structure._any_solved:
-            return numpy.nan        
-        return self.member.max_axial(self.structure.current_combo)
-
-    # deflection
-    @system_property
-    def min_deflection_x(self) -> float:
-        if not self.structure._any_solved:
-            return numpy.nan        
-        return self.member.min_deflection("dx", self.structure.current_combo)
-
-    @system_property
-    def max_deflection_x(self) -> float:
-        if not self.structure._any_solved:
-            return numpy.nan        
-        return self.member.max_deflection("dx", self.structure.current_combo)
-
-    @system_property
-    def min_deflection_y(self) -> float:
-        if not self.structure._any_solved:
-            return numpy.nan        
-        return self.member.min_deflection("dy", self.structure.current_combo)
-
-    @system_property
-    def max_deflection_y(self) -> float:
-        if not self.structure._any_solved:
-            return numpy.nan        
-        return self.member.max_deflection("dy", self.structure.current_combo)
-
-    # torsion
-    @system_property
-    def min_torsion(self) -> float:
-        if not self.structure._any_solved:
-            return numpy.nan
-        return self.member.min_torque(self.structure.current_combo)
-
-    @system_property
-    def max_torsion(self) -> float:
-        if not self.structure._any_solved:
-            return numpy.nan
-        return self.member.max_torque(self.structure.current_combo)
-
-    # shear
-    @system_property
-    def min_shear_z(self) -> float:
-        if not self.structure._any_solved:
-            return numpy.nan
-        return self.member.min_shear("Fz", self.structure.current_combo)
-
-    @system_property
-    def max_shear_z(self) -> float:
-        if not self.structure._any_solved:
-            return numpy.nan
-        return self.member.max_shear("Fz", self.structure.current_combo)
-
-    @system_property
-    def min_shear_y(self) -> float:
-        if not self.structure._any_solved:
-            return numpy.nan
-        return self.member.min_shear("Fy", self.structure.current_combo)
-
-    @system_property
-    def max_shear_y(self) -> float:
-        if not self.structure._any_solved:
-            return numpy.nan
-        return self.member.max_shear("Fy", self.structure.current_combo)
-
-    # moment
-    @system_property
-    def min_moment_z(self) -> float:
-        if not self.structure._any_solved:
-            return numpy.nan
-        return self.member.min_moment("Mz", self.structure.current_combo)
-
-    @system_property
-    def max_moment_z(self) -> float:
-        if not self.structure._any_solved:
-            return numpy.nan
-        return self.member.max_moment("Mz", self.structure.current_combo)
-
-    @system_property
-    def min_moment_y(self) -> float:
-        if not self.structure._any_solved:
-            return numpy.nan
-        return self.member.min_moment("My", self.structure.current_combo)
-
-    @system_property
-    def max_moment_y(self) -> float:
-        if not self.structure._any_solved:
-            return numpy.nan
-        return self.member.max_moment("My", self.structure.current_combo)
-
-    # Load Application
-    def get_valid_force_choices(
-        only_local=False, only_global=False, use_moment=True
-    ):
-        if only_local or only_global:
-            assert only_global != only_local, "choose local or global"
-
-        floc = set(["Fx", "Fy", "Fz"])
-        fglb = set(["FX", "FY", "FZ"])
-        mloc = set(["Mx", "My", "Mz"])
-        mglb = set(["MX", "MY", "MZ"])
-
-        if only_global:
-            if use_moment:
-                return list(set.union(*(fglb, mglb)))
-            return list(fglb)
-
-        elif only_local:
-            if use_moment:
-                return list(set.union(*(floc, mloc)))
-            return list(floc)
-
-        else:
-            if use_moment:
-                return list(set.union(*(floc, mloc, fglb, mglb)))
-            return list(set.union(*(floc, fglb)))
-
-    # FORCE APPLICATION (TODO: update for global input 0.0.78)
-

-[docs]
-    def apply_pt_load(self, x_frac, case=None, **kwargs):
-        """add a force in a global orientation"""
-        if case is None:
-            case = self.structure.default_case
-
-        # adjust x for relative input
-        x = x_frac * self.L
-
-        valid = self.get_valid_force_choices(use_moment=True, only_global=True)
-        fin = [(v, kwargs[v]) for v in valid if v in kwargs]
-        for Fkey, Fval in fin:
-            if Fval:
-                self.debug(f"adding {Fkey}={Fval}")
-                self.structure.frame.add_member_pt_load(
-                    self.member.name, Fkey, Fval, x, case=case
-                )

-
-
-

-[docs]
-    def apply_distributed_load(
-        self, start_factor=1, end_factor=1, case=None, **kwargs
-    ):
-        """add forces in global vector"""
-        if case is None:
-            case = self.structure.default_case
-        valid = self.get_valid_force_choices(use_moment=False, only_global=True)
-        fin = [(v, kwargs[v]) for v in valid if v in kwargs]
-        for Fkey, Fval in fin:
-            if Fval:
-                self.debug(f"adding dist {Fkey}={Fval}")
-                self.structure.frame.add_member_dist_load(
-                    self.member.name,
-                    Fkey,
-                    Fval * start_factor,
-                    Fval * end_factor,
-                    case=case,
-                )

-
-
-

-[docs]
-    def apply_local_pt_load(self, x, case=None, **kwargs):
-        """add a force in a global orientation"""
-        if case is None:
-            case = self.structure.default_case
-        valid = self.get_valid_force_choices(only_local=True, use_moment=True)
-        fin = [(v, kwargs[v]) for v in valid if v in kwargs]
-        for Fkey, Fval in fin:
-            if Fval:
-                self.debug(f"adding {Fkey}={Fval}")
-                self.structure.frame.add_member_pt_load(
-                    self.member.name, Fkey, Fval, x, case=case
-                )

-
-
-

-[docs]
-    def apply_local_distributed_load(
-        self, start_factor=1, end_factor=1, case=None, **kwargs
-    ):
-        """add forces in global vector"""
-        if case is None:
-            case = self.structure.default_case
-        valid = self.get_valid_force_choices(only_local=True, use_moment=False)
-        fin = [(v, kwargs[v]) for v in valid if v in kwargs]
-        for Fkey, Fval in fin:
-            if Fval:
-                self.debug(f"adding dist {Fkey}={Fval}")
-                self.structure.frame.add_member_dist_load(
-                    self.member.name,
-                    Fkey,
-                    Fval * start_factor,
-                    Fval * end_factor,
-                    case=case,
-                )

-
-
-    def apply_gravity_force_distribution(
-        self, sv=1, ev=1, z_dir="FZ", z_mag=-1
-    ):
-        # TODO: ensure that integral of sv, ev is 1, and all positive
-        self.debug(f"applying gravity distribution to {self.name}")
-        for case in self.structure.gravity_cases:
-            total_weight = self.mass * self.structure.gravity_mag
-            d = {z_dir: z_mag * total_weight}
-            self.apply_distributed_load(case=self.structure.gravity_name, **d)
-
-    def apply_gravity_force(self, x_frac=0.5, z_dir="FZ", z_mag=-1):
-        self.debug(f"applying gravity to {self.name}")
-        for case in self.structure.gravity_cases:
-            total_weight = self.mass * self.structure.gravity_mag
-            d = {z_dir: z_mag * total_weight}
-            self.apply_pt_load(x_frac, case=self.structure.gravity_name, **d)
-
-    def __dir__(self) -> Iterable[str]:
-        d = set(super().__dir__())
-        return list(d.union(dir(Beam)))
-
-

-[docs]
-    def max_von_mises(self) -> float:
-        """The worst of the worst cases, after adjusting the beem orientation for best loading"""
-        # TODO: make faster system property
-        return numpy.nanmax([self.max_von_mises_by_case()])

-
-    
-

-[docs]
-    def max_von_mises_by_case(self, combos=None):
-        """Gathers max vonmises stress info per case"""
-    
-        cmprv = {}
-        for rxy in [True, False]:
-            new = []
-            out = self.von_mises_stress_l
-            for cmbo, vm_stress_vec in out.items():
-                if combos and cmbo not in combos:
-                    continue
-                new.append(numpy.nanmax(vm_stress_vec))
-            cmprv[rxy] = numpy.array(new)
-    
-        if cmprv[True] and cmprv[False]:
-            vt = numpy.nanmax(cmprv[True])
-            vf = numpy.nanmax(cmprv[False])
-    
-            # We choose the case with the
-            if vf < vt:
-                self.min_stress_xy = False
-                return vf
-    
-            self.min_stress_xy = True
-            return vt

-
-    
-    #TODO: Breakout other stress vectors
-    @solver_cached
-    def von_mises_stress_l(self):
-        """Max von-mises stress"""
-        out = {}
-        sect_stresses = self.section_stresses()
-        for combo in self.structure.frame.LoadCombos:
-            rows = []
-            for i in numpy.linspace(0, 1, self.analysis_intervals):
-                max_vm = sect_stresses[combo][i]
-                rows.append(max_vm)
-            out[combo] = numpy.array(rows)
-        return out
-    
-    
-    def section_stresses(self,**kwargs):
-        # FIXME: enable: assert self.structure.solved, f'must be solved first!'
-        combos = {}
-        for combo in self.structure.frame.LoadCombos:
-            combos[combo] = spans = {}
-            for i in numpy.linspace(0, 1, self.analysis_intervals):
-                self.info(f"evaluating stresses for {combo} @ {i} w {kwargs}")
-                sol = self.get_stress_at(i, combo,**kwargs)
-                spans[i] = sol
-        return combos               

-
-        
-
-    # #TODO: remove or refactor
-    # @solver_cached
-    # def stress_info(self):
-    #     """Max profile stress info along beam for each type"""
-    #     rows = []
-    #     for combo in self.structure.frame.LoadCombos:
-    #         for i in numpy.linspace(0, 1, self.analysis_intervals):
-    #             mat_stresses = self.section_stresses[combo][i].get_stress()
-    #             oout = {"x": i, "combo": combo}
-    #             for stresses in mat_stresses:
-    #                 max_vals = {
-    #                     sn
-    #                     + "_max_"
-    #                     + stresses["Material"]: numpy.nanmax(stress)
-    #                     for sn, stress in stresses.items()
-    #                     if isinstance(stress, numpy.ndarray)
-    #                 }
-    #                 min_vals = {
-    #                     sn
-    #                     + "_min_"
-    #                     + stresses["Material"]: numpy.nanmin(stress)
-    #                     for sn, stress in stresses.items()
-    #                     if isinstance(stress, numpy.ndarray)
-    #                 }
-    #                 avg_vals = {
-    #                     sn
-    #                     + "_avg_"
-    #                     + stresses["Material"]: numpy.nanmean(stress)
-    #                     for sn, stress in stresses.items()
-    #                     if isinstance(stress, numpy.ndarray)
-    #                 }
-    #                 # Make some simple to determine dataframe failure prediction
-    #                 factor_of_saftey = (
-    #                     self.material.yield_strength
-    #                     / numpy.nanmax(stresses["sig_vm"])
-    #                 )
-    #                 fail_frac = (
-    #                     numpy.nanmax(stresses["sig_vm"])
-    #                     / self.material.allowable_stress
-    #                 )
-    #                 fsnm = stresses["Material"] + "_saftey_factor"
-    #                 fsff = stresses["Material"] + "_fail_frac"
-    #                 allowable = {fsnm: factor_of_saftey, fsff: fail_frac}
-    #                 oout.update(allowable)
-    #                 oout.update(max_vals)
-    #                 oout.update(min_vals)
-    #                 oout.update(avg_vals)
-    #             rows.append(oout)
-    # 
-    #     return pandas.DataFrame(rows)
-
- 
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/eng/thermodynamics.html b/docs/_build/html/_modules/engforge/eng/thermodynamics.html deleted file mode 100644 index a5c3629..0000000 --- a/docs/_build/html/_modules/engforge/eng/thermodynamics.html +++ /dev/null @@ -1,408 +0,0 @@ - - - - - - engforge.eng.thermodynamics — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.eng.thermodynamics

-import attr
-
-# from engforge.configuration import Configuration, forge
-from engforge.components import Component, system_property, forge
-
-from engforge.eng.fluid_material import Water, Air, Steam
-from CoolProp.CoolProp import PropsSI
-import CoolProp.CoolProp as CP
-import numpy
-from numpy import vectorize
-
-STD_TEMP = 273 + 20
-STD_PRESSURE = 1.01325e5
-
-
-# Thermodynamics
-@vectorize
-def heat_of_vaporization(P, material="Water", measure="Hmolar"):
-    """Returns heat of vaporization for material
-    :param P: pressure in P
-    """
-    assert measure.startswith("H")  # Must be an enthalpy
-    if P > 2.2063e07:  # Critical Pressure
-        return 0.0
-    H_L = PropsSI(measure, "P", P, "Q", 0, material)
-    H_V = PropsSI(measure, "P", P, "Q", 1, material)
-    return H_V - H_L
-
-
-@vectorize
-def boiling_point(P, material="Water"):
-    """Returns the boiling point in `K` for the material"""
-    return PropsSI("T", "P", P, "Q", 1, material)
-
-
-# Heat Exchanger
-

-[docs]
-def dp_he_entrance(sigma, G, rho):
-    """Heat Exchanger Entrance Pressure Loss
-    :param sigma: contraction-ratio - ratio of minimum flow area to frontal area
-    :param G: mass flux of fluid
-    :param rho: density of fluid
-    """
-    Kc = 0.42 * (1.0 - sigma**2.0) ** 2.0
-    return (1.0 - sigma**2.0 + Kc) * (G**2.0 / rho) / 2.0

-
-
-
-

-[docs]
-def dp_he_exit(sigma, G, rho):
-    """Heat Exchanger Exit Pressure Loss
-    :param sigma: contraction-ratio - ratio of minimum flow area to frontal area
-    :param G: mass flux of fluid
-    :param rho: density of fluid
-    """
-    Ke = (1.0 - sigma) ** 2.0
-    return (1.0 - sigma**2.0 + Ke) * (G**2.0 / rho) / 2.0

-
-
-
-

-[docs]
-def dp_he_core(G, f, L, rho, Dh):
-    """Losses due to friction
-    :param f: fanning friction factor
-    :param G: mass flux (massflow / Area)
-    :param L: length of heat exchanger
-    :param rho: intermediate density
-    :param Dh: diameter of heat exchanger
-    """
-    top = 4 * f * L * G**2.0
-    btm = Dh * 2 * rho
-    dp_friciton = top / btm
-    return dp_friciton

-
-
-
-

-[docs]
-def dp_he_gas_losses(G, rhoe, rhoi):
-    """Measures the pressure loss or gain due to density changes in the HE
-    :param G: mass flux
-    :param rhoe: exit density
-    :param rhoi: entrance density
-    """
-    dp_pressure = G**2.0 * ((1.0 / rhoe) - (1.0 / rhoi))
-    return dp_pressure

-
-
-
-

-[docs]
-def fanning_friction_factor(Re, method="turbulent"):
-    if method == "turbulent":
-        if Re <= 5e4:
-            return 0.0791 / (Re**0.25)
-        return 0.0014 + 0.125 / (Re**0.32)
-    elif method == "laminar":
-        return 16.0 / Re
-    else:  # Default to turbulent
-        return fanning_friction_factor(Re, method="turbulent")

-
-
-
-# Simple Elements
-

-[docs]
-@forge
-class SimpleHeatExchanger(Component):
-    Thi = attr.ib()
-    mdot_h = attr.ib()
-    Cp_h = attr.ib()
-
-    Tci = attr.ib()
-    mdot_c = attr.ib()
-    Cp_c = attr.ib()
-
-    efficiency = attr.ib(default=0.8)
-    name = attr.ib(default="HeatExchanger")
-
-    @system_property
-    def CmatH(self) -> float:
-        return self.Cp_h * self.mdot_h
-
-    @system_property
-    def CmatC(self) -> float:
-        return self.Cp_c * self.mdot_c
-
-    @system_property
-    def Tout_ideal(self) -> float:
-        numerator = self.Thi * self.CmatH + self.Tci * self.CmatC
-        denominator = self.CmatC + self.CmatH
-        return numerator / denominator
-
-    @system_property
-    def Qdot_ideal(self) -> float:
-        """Use Tout ideal to determine the heat flow should be the same for both"""
-        v1 = self.CmatH * (self.Thi - self.Tout_ideal)
-        v2 = self.CmatC * (self.Tout_ideal - self.Tci)
-        if abs((v2 - v1) / float(v1)) >= 0.1:
-            self.warning("Qdot_ideal not matching")
-        return (v1 + v2) / 2.0
-
-    @system_property
-    def Qdot(self) -> float:
-        return self.Qdot_ideal * self.efficiency
-
-    @system_property
-    def Th_out(self) -> float:
-        return self.Thi - self.Qdot / self.CmatH
-
-    @system_property
-    def Tc_out(self) -> float:
-        return self.Tci + self.Qdot / self.CmatC

-
-
-
-# Compression
-

-[docs]
-@forge
-class SimpleCompressor(Component):
-    pressure_ratio = attr.ib()
-
-    Tin = attr.ib()
-    mdot = attr.ib()
-
-    Cp = attr.ib()
-    gamma = attr.ib(default=1.4)
-
-    efficiency = attr.ib(default=0.75)
-    name = attr.ib(default="Compressor")
-
-    @system_property
-    def temperature_ratio(self) -> float:
-        return (
-            self.pressure_ratio ** ((self.gamma - 1.0) / self.gamma) - 1.0
-        ) / self.efficiency
-
-    @system_property
-    def Tout(self) -> float:
-        return self.temperature_ratio * self.Tin
-
-    @system_property
-    def power_input(self) -> float:
-        return self.Cp * self.mdot * (self.Tout - self.Tin)
-
-    def pressure_out(self, pressure_in):
-        return self.pressure_ratio * pressure_in

-
-
-
-

-[docs]
-@forge
-class SimpleTurbine(Component):
-    Pout = attr.ib()
-
-    Pin = attr.ib()
-    Tin = attr.ib()
-
-    mdot = attr.ib()
-
-    Cp = attr.ib()
-    gamma = attr.ib(default=1.4)
-
-    efficiency = attr.ib(default=0.80)
-    name = attr.ib(default="Turbine")
-
-    @system_property
-    def pressure_ratio(self) -> float:
-        return self.Pin / self.Pout
-
-    @system_property
-    def Tout(self) -> float:
-        return self.Tin * (
-            1
-            - self.efficiency
-            * (
-                1.0
-                - (1 / self.pressure_ratio) ** ((self.gamma - 1.0) / self.gamma)
-            )
-        )
-        # return self.Tin * self.pressure_ratio**((self.gamma-1.0)/self.gamma)/ self.efficiency
-
-    @system_property
-    def power_output(self) -> float:
-        """calculates power output base on temp diff (where eff applied)"""
-        return self.Cp * self.mdot * (self.Tin - self.Tout)

-
-
-
-# Compression
-

-[docs]
-@forge
-class SimplePump(Component):
-    MFin = attr.field()  # kg/s
-    pressure_ratio = attr.field()  # nd
-    Tin = attr.field(default=STD_TEMP)  # k
-    Pin = attr.field(default=STD_PRESSURE)  # c
-
-    efficiency = attr.field(default=0.75)
-    fluid = attr.field(factory=Water)
-    name = attr.field(default="pump")
-
-    def __on_init__(self):
-        self.eval()
-
-    def eval(self):
-        self.fluid.T = self.Tin
-        self.fluid.P = self.Pin
-
-        Tsat = self.fluid.Tsat
-        if self.Tin / Tsat >= 1:
-            self.warning("infeasible: pumping vapor!")
-
-        elif (self.Tin / self.fluid.Tsat) > 0.8:
-            self.warning("pump near saturated temp")
-
-    @system_property
-    def volumetric_flow(self) -> float:
-        return self.MFin / self.fluid.density
-
-    @system_property
-    def temperature_delta(self) -> float:
-        rho = self.fluid.density
-        v = self.MFin / rho
-        p = self.Pin
-        w = v * p / self.efficiency  # work done
-        cp = self.fluid.specific_heat
-        dt = w * (1 - self.efficiency) / (rho * cp * v)
-        return dt
-
-    @system_property
-    def Pout(self) -> float:
-        return self.pressure_ratio * self.Pin
-
-    @system_property
-    def Tout(self) -> float:
-        return self.temperature_delta + self.Tin
-
-    @system_property
-    def pressure_delta(self) -> float:
-        return (self.pressure_ratio - 1) * self.Pin
-
-    @system_property
-    def power_input(self) -> float:
-        return self.volumetric_flow * self.pressure_delta / self.efficiency
-
-    @system_property
-    def cost(self) -> float:
-        pwr = self.power_input
-        c1 = numpy.log(pwr)
-        c2 = -0.03195 * pwr**2.0
-        c3 = 467.2 * pwr
-        c4 = 2.048e4
-        return c1 + c2 + c3 + c4

-
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/engforge_attributes.html b/docs/_build/html/_modules/engforge/engforge_attributes.html deleted file mode 100644 index a07fe0c..0000000 --- a/docs/_build/html/_modules/engforge/engforge_attributes.html +++ /dev/null @@ -1,494 +0,0 @@ - - - - - - engforge.engforge_attributes — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.engforge_attributes

-from engforge.attributes import ATTR_BASE, AttributeInstance
-from engforge.attr_dynamics import Time
-from engforge.attr_solver import Solver
-from engforge.attr_signals import Signal
-from engforge.attr_slots import Slot
-from engforge.attr_plotting import Plot, Trace
-from engforge.logging import LoggingMixin, log
-from engforge.typing import *
-
-from contextlib import contextmanager
-import deepdiff
-import typing
-import datetime
-
-
-import attr, attrs
-
-from  attrs import Attribute
-
-
-

-[docs]
-class EngAttr(LoggingMixin):
-    pass

-
-
-
-log = EngAttr()
-
-
-

-[docs]
-def get_attributes_of(cls, subclass_of: type = None, exclude=False):
-    choose = issubclass
-    if exclude:
-        choose = lambda ty, type_set: not issubclass(ty, type_set)
-
-    if subclass_of is None:
-        subclass_of = ATTR_BASE
-
-    # This handles the attrs class before or after compilation
-    attrval = {}
-    if "__attrs_attrs__" in cls.__dict__:  # Handle Attrs Class
-        for k, v in attrs.fields_dict(cls).items():
-            if isinstance(v.type, type) and choose(v.type, subclass_of):
-                attrval[k] = v
-
-    # else:  # Handle Pre-Attrs Class
-    # FIXME: should this run first?
-    for k, v in cls.__dict__.items():
-        if isinstance(v, type) and choose(v, subclass_of):
-            attrval[k] = v
-
-    return attrval

-
-
-
-

-[docs]
-class AttributedBaseMixin(LoggingMixin):
-    """A mixin that adds the ability to configure all engforge.core attributes of a class"""
-
-
-    # Auto Configuration Methods
-

-[docs]
-    @classmethod
-    def collect_all_attributes(cls):
-        """collects all the attributes for a system"""
-        out = {}
-        for base_class in ATTR_BASE.subclasses():
-            nm = base_class.__name__.lower()
-            out[nm] = base_class.collect_cls(cls)
-        return out

-
-    
-

-[docs]
-    def collect_inst_attributes(self,**kw):
-        """collects all the attributes for a system"""
-        out = {}
-        for base_class in ATTR_BASE.subclasses():
-            nm = base_class.__name__.lower()
-            out[nm] = base_class.collect_attr_inst(self,**kw)
-        return out  

-
-
-    @classmethod
-    def _get_init_attrs_data(cls, subclass_of: type, exclude=False):
-        choose = issubclass
-        if exclude:
-            choose = lambda ty, type_set: not issubclass(ty, type_set)
-
-        attrval = {}
-        if "__attrs_attrs__" in cls.__dict__:  # Handle Attrs Class
-            for k, v in attrs.fields_dict(cls).items():
-                if isinstance(v.type, type) and choose(v.type, subclass_of):
-                    attrval[k] = v
-
-        # else:  # Handle Pre-Attrs Class
-        # FIXME: should this run first?
-        for k, v in cls.__dict__.items():
-            if isinstance(v, type) and choose(v, subclass_of):
-                attrval[k] = v
-
-        return attrval
-
-    # Attribute Methods
-    @property
-    def attrs_fields(self) -> set:
-        return set(attr.fields(self.__class__))
-
-
-
-    @classmethod
-    def _extract_type(cls, typ):
-        """gathers valid types for an attribute.type"""
-        from engforge.attr_slots import Slot
-        from engforge.configuration import Configuration
-
-        if not isinstance(typ, type) or typ is None:
-            return list()
-
-        if issubclass(typ, Slot):
-            accept = typ.accepted
-            if isinstance(accept, (tuple, list)):
-                return list(accept)
-            return [accept]
-
-        elif issubclass(typ, Configuration):
-            return [typ]
-
-        elif issubclass(typ, TABLE_TYPES):
-            return [typ]
-
-

-[docs]
-    @classmethod
-    def check_ref_slot_type(cls, sys_key: str) -> list:
-        """recursively checks class slots for the key, and returns the slot type"""
-
-        from engforge.configuration import Configuration
-
-        slot_refs = cls.slot_refs()
-        if sys_key in slot_refs:
-            return slot_refs[sys_key]
-
-        slts = cls.input_attrs()
-        key_segs = sys_key.split(".")
-        out = []
-        # print(slts.keys(),sys_key)
-        if "." not in sys_key and sys_key not in slts:
-            pass
-
-        elif sys_key in slts:
-            # print(f'slt find {sys_key}')
-            return cls._extract_type(slts[sys_key].type)
-        else:
-            fst = key_segs[0]
-            rem = key_segs[1:]
-            if fst in slts:
-                sub_clss = cls._extract_type(slts[fst].type)
-                out = []
-                for acpt in sub_clss:
-                    if isinstance(acpt, type) and issubclass(
-                        acpt, Configuration
-                    ):
-                        vals = acpt.check_ref_slot_type(".".join(rem))
-                        # print(f'recursive find {acpt}.{rem} = {vals}')
-                        if vals:
-                            out.extend(vals)
-
-                    elif isinstance(acpt, type):
-                        out.append(acpt)
-
-        slot_refs[sys_key] = out
-
-        return out

-
-
-

-[docs]
-    @classmethod
-    def slot_refs(cls, recache=False):
-        """returns all slot references in this configuration"""
-        key = f"{cls.__name__}_prv_slot_sys_refs"
-        if recache == False and hasattr(cls, key):
-            return getattr(cls, key)
-        o = {}
-        setattr(cls, key, o)
-        return o

-
-
-

-[docs]
-    @classmethod
-    def slots_attributes(cls) -> typing.Dict[str, "Attribute"]:
-        """Lists all slots attributes for class"""
-        return cls._get_init_attrs_data(Slot)

-
-
-

-[docs]
-    @classmethod
-    def signals_attributes(cls) -> typing.Dict[str, "Attribute"]:
-        """Lists all signals attributes for class"""
-        return cls._get_init_attrs_data(Signal)

-
-
-

-[docs]
-    @classmethod
-    def solvers_attributes(cls) -> typing.Dict[str, "Attribute"]:
-        """Lists all signals attributes for class"""
-        return cls._get_init_attrs_data(Solver)

-
-
-

-[docs]
-    @classmethod
-    def transients_attributes(cls) -> typing.Dict[str, "Attribute"]:
-        """Lists all signals attributes for class"""
-        return cls._get_init_attrs_data(Time)

-
-
-

-[docs]
-    @classmethod
-    def trace_attributes(cls) -> typing.Dict[str, "Attribute"]:
-        """Lists all trace attributes for class"""
-        return cls._get_init_attrs_data(Trace)

-
-
-

-[docs]
-    @classmethod
-    def plot_attributes(cls) -> typing.Dict[str, "Attribute"]:
-        """Lists all plot attributes for class"""
-        return cls._get_init_attrs_data(Plot)

-
-
-    @classmethod
-    def input_attrs(cls):
-        return attr.fields_dict(cls)
-
-

-[docs]
-    @classmethod
-    def input_fields(cls,add_ign_types:list=None):
-        '''no attr base types, no tuples, no lists, no dicts'''
-        ignore_types = [
-            ATTR_BASE,
-            #tuple,
-            #list,
-            #dict,
-        ]
-        if add_ign_types:
-            ignore_types.extend(add_ign_types)
-        return cls._get_init_attrs_data(tuple(ignore_types), exclude=True)

-
-
-    @classmethod
-    def numeric_fields(cls):
-        ignore_types = (
-            ATTR_BASE,
-            str,
-            tuple,
-            list,
-            dict,
-        )
-        typ = cls._get_init_attrs_data(ignore_types, exclude=True)
-        return {k: v for k, v in typ.items() if v.type in (int, float)}
-
-    @classmethod
-    def table_fields(cls):
-        keeps = (str, float, int)  # TODO: add numpy fields
-        typ = cls._get_init_attrs_data(keeps)
-        return {k: v for k, v in typ.items()}
-
-    # Dictonaries
-    @property
-    def as_dict(self):
-        """returns values as they are in the class instance"""
-        from engforge.configuration import Configuration
-
-        inputs = self.input_attrs()
-        # TODO: add signals?
-        properties = getattr(self, "system_properties_classdef", None)
-        if properties:
-            inputs.update(properties())
-
-        o = {k: getattr(self, k, None) for k, v in inputs.items()}
-        return o
-
-    @property
-    def input_as_dict(self):
-        """returns values as they are in the class instance, but converts classes inputs to their input_as_dict"""
-        from engforge.configuration import Configuration
-
-        o = {k: getattr(self, k, None) for k in self.input_fields()}
-        o = {
-            k: v if not isinstance(v, Configuration) else v.input_as_dict
-            for k, v in o.items()
-        }
-        return o
-
-    @property
-    def numeric_as_dict(self):
-        from engforge.configuration import Configuration
-
-        o = {k: getattr(self, k, None) for k in self.numeric_fields()}
-        o = {
-            k: v if not isinstance(v, Configuration) else v.numeric_as_dict
-            for k, v in o.items()
-        }
-        return o
-
-    # Hashes
-    @property
-    def unique_hash(self):
-        d = self.as_dict
-        return deepdiff.DeepHash(d)[d]
-
-    @property
-    def numeric_hash(self):
-        d = self.input_as_dict
-        return deepdiff.DeepHash(d)[d]
-
-    @property
-    def numeric_hash(self):
-        d = self.numeric_as_dict
-        return deepdiff.DeepHash(d)[d]
-
-    # Configuration Push/Pop methods
-

-[docs]
-    def setattrs(self, dict):
-        """sets attributes from a dictionary"""
-        msg = f"invalid keys {set(dict.keys()) - set(self.input_attrs())}"
-        assert set(dict.keys()).issubset(set(self.input_attrs())), msg
-        for k, v in dict.items():
-            setattr(self, k, v)

-
-
-

-[docs]
-    @contextmanager
-    def difference(self, **kwargs):
-        """a context manager that will allow you to dynamically change any information, then will change it back in a fail safe way.
-
-        with self.difference(name='new_name', value = new_value) as new_config:
-            #do stuff with config, ok to fail
-
-        you may not access any "private" variable that starts with an `_` as in _whatever
-
-        difference is useful for saving slight differences in configuration in conjunction with solve
-        you might create wrappers for eval, or implement a strategy pattern.
-
-        only attributes may be changed.
-
-        #TODO: allow recursive operation with sub comps or systems.
-        #TODO: make a full system copy so the system can be reverted later
-        """
-        _temp_vars = {}
-
-        _temp_vars.update(
-            {
-                arg: getattr(self, arg)
-                for arg in kwargs.keys()
-                if hasattr(self, arg)
-                if not arg.startswith("_")
-            }
-        )
-
-        bad_vars = set.difference(set(kwargs.keys()), set(_temp_vars.keys()))
-        if bad_vars:
-            self.warning("Could Not Change {}".format(",".join(list(bad_vars))))
-
-        try:  # Change Variables To Input
-            self.setattrs(kwargs)
-            yield self
-        finally:
-            rstdict = {k: _temp_vars[k] for k, v in kwargs.items()}
-            self.setattrs(rstdict)

-

-
-  
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/env_var.html b/docs/_build/html/_modules/engforge/env_var.html deleted file mode 100644 index 2673ceb..0000000 --- a/docs/_build/html/_modules/engforge/env_var.html +++ /dev/null @@ -1,341 +0,0 @@ - - - - - - engforge.env_var — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.env_var

-"""Defines a class called `EnvVariable` that defines an interface for env variables with an option to obscure and convert variables, as well as provide a default option.
-
-A global record of variables is kept for informational purposes in keeping track of progam variables
-
-To prevent storage of env vars in program memory, access to the os env variables is provided on access of the `secret` variable. It is advisable to use the result of this as directly as possible when dealing with actual secrets. 
-
-For example add: `db_driver(DB_HOST.secret,DB_PASSWORD.secret,...)
-"""
-
-
-import os
-from engforge.logging import LoggingMixin
-from typing import Any
-import socket
-import inspect
-
-global warned
-warned = set()  # a nice global variable to hold any warnings
-
-FALSE_VALUES = (False, "false", "no", "n")
-TRUE_VALUES = (True, "checked", "true", "yes", "y")
-
-
-

-[docs]
-def parse_bool(input: str):
-    if isinstance(input, str):
-        input = input.lower()
-
-    if not input:
-        return False
-    elif input in TRUE_VALUES:
-        return True
-    elif input in FALSE_VALUES:
-        return False
-    return False

-
-
-
-DEFAULT_CONVERTERS = {bool: parse_bool}
-
-
-

-[docs]
-class EnvVariable(LoggingMixin):
-    """A method to wrap SECRETS and in application with a way to get the value using self.secret
-    Do not store values from self.secret to ensure security
-
-    You can override the secret with _override"""
-
-    var_name: str = None
-    type_conv: Any = None
-    default: Any = None
-    obscure: bool = True
-    _override: str
-    _secrets = {}  # its class based so like a singleton
-    _replaced = set()
-    fail_on_missing: bool
-    desc: str = None
-    _upgrd_warn: bool = False
-    _dontovrride: bool = False
-
-    def __init__(
-        self,
-        secret_var_name,
-        type_conv=None,
-        default=None,
-        obscure=False,
-        fail_on_missing=False,
-        desc: str = None,
-        dontovrride=False,
-    ):
-        """pass arguments to SecretVariable to have it look up information at runtime from envargs, but not store it in memory.
-        :param secret_var_name: the enviornmental variable
-        :param type_conv: the data from env vars will be converted with this function
-        :param default: the value to use if the secret_var_name doesn't exist in enviornmental variables
-        :param obscure: default True, will prevent the result being printed by str(self)
-        :param fail_on_missing: if the secret env variable is not found, and default is None
-        :param desc: a description of the purpose of the variable
-        """
-        self.var_name = secret_var_name
-        self.type_conv = (
-            type_conv
-            if type_conv not in DEFAULT_CONVERTERS
-            else DEFAULT_CONVERTERS[type_conv]
-        )
-        self._dontovrride = dontovrride
-
-        if default is not None:
-            self.default = default
-        self.obscure = obscure
-        # UserString.__init__(self,f'[SECRET:{secret_var_name}]')
-
-        self.fail_on_missing = fail_on_missing
-
-        # record env vars
-        if secret_var_name in self.__class__._secrets:
-            cur = self.__class__._secrets[secret_var_name]
-            if dontovrride:
-                self.debug(f"not replacing: {cur}->{self}")
-                self.__dict__ = cur.__dict__
-            else:
-                self.info(f"replacing {cur}->{self}")
-                self._replaced.add(cur)
-                self.__class__._secrets[secret_var_name] = self
-        else:
-            self.__class__._secrets[secret_var_name] = self
-
-        # FIXME: prevent engforge var from replacing other module instnace
-        # not possible to locate where other instances
-        # if secret_var_name in self.__class__._secrets:
-        #     cur = self.__class__._secrets[secret_var_name]
-        #     if cur != self and self not in self._replaced:
-        #         self._replaced.add(cur)
-        #         self.info(f'replacing {cur}->{self}')
-        #         self.__class__._secrets[secret_var_name] = self
-        #     elif self in self._replaced:
-        #         self.info(f'skipping replaced readd {self}')
-        #         #self.__class__._secrets[secret_var_name] = self
-        # else:
-        #     self.__class__._secrets[secret_var_name] = self
-
-    def __str__(self):
-        if self.obscure:
-            return f"{self.obscured_name:<40} = XXXXXX"
-        return f"{self.obscured_name:<40} = {self.secret}"
-
-    def __add__(self, other) -> str:
-        return str(str.__add__(str(self), other))
-
-    def __radd__(self, other) -> str:
-        return str(str.__add__(other, str(self)))
-
-    @property
-    def obscured_name(self) -> str:
-        if hasattr(self, "_override"):
-            return f"SECRETS[OVERRIDE]"
-        return f"SECRETS[{self.var_name}]"
-
-    @property
-    def secret(self):
-        # Check if this secret is the one in the secrets registry
-        sec = self.__class__._secrets[self.var_name]
-        if sec is not self and not sec._dontovrride:
-            # Provide warning that the secret is being replaced
-            if not self._upgrd_warn:
-                self._upgrd_warn = True
-                self.info(
-                    f"upgrading: {self.var_name} from {id(self)}->{id(sec)}"
-                )
-
-            # Monkeypatch dictionary
-            self.__dict__ = sec.__dict__
-
-        if hasattr(self, "_override"):
-            return self._override
-
-        if self.var_name in os.environ:
-            secval = os.environ[self.var_name]
-        elif self.default is not None:
-            if self.var_name not in warned:
-                if self.obscure:
-                    dflt = "XXXXXXX"
-                else:
-                    dflt = self.default
-
-                self.debug(f"Env Var: {self.var_name} Not Found! Using: {dflt}")
-                warned.add(self.var_name)
-
-            secval = self.default
-        else:
-            if self.fail_on_missing:
-                raise FileNotFoundError(
-                    f"Could Not Find Env Variable {self.var_name}"
-                )
-            else:
-                if self.var_name not in warned:
-                    self.debug(f"Env Var: {self.var_name} Not Found!")
-                    warned.add(self.var_name)
-                return None
-
-        if self.type_conv is None:
-            return secval
-        else:
-            return self.type_conv(secval)
-
-    @property
-    def in_env(self):
-        return self.var_name in os.environ
-
-

-[docs]
-    def remove(self):
-        """removes this secret from the record"""
-        if self in self.__class__._secrets:
-            self.__class__._secrets.remove(self)

-
-
-    @classmethod
-    def load_env_vars(self):
-        for s in EnvVariable._secrets.values():
-            str(s)
-
-

-[docs]
-    @classmethod
-    def print_env_vars(cls):
-        """prints env vars in memory"""
-        # preload
-        cls.load_env_vars()
-        for var, s in sorted(
-            EnvVariable._secrets.items(), key=lambda kv: kv[1].var_name
-        ):
-            print(f"{s.var_name:<40}|{s}")

-

-
-
-
-# DEFAULT ENV VARIABLES
-try:
-    # This should always work unless we don't have privideges (rare assumed)
-    host = socket.gethostname().upper()
-except:
-    host = "MASTER"
-
-global HOSTNAME, SLACK_WEBHOOK
-
-HOSTNAME = EnvVariable(
-    "FORGE_HOSTNAME", default=host, obscure=False, dontovrride=True
-)
-SLACK_WEBHOOK = EnvVariable(
-    "FORGE_SLACK_LOG_WEBHOOK", default=None, obscure=False, dontovrride=True
-)
-
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/locations.html b/docs/_build/html/_modules/engforge/locations.html deleted file mode 100644 index fa1c5a0..0000000 --- a/docs/_build/html/_modules/engforge/locations.html +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - engforge.locations — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.locations

-from engforge.env_var import EnvVariable
-
-FORGE_PATH_VAR = EnvVariable(
-    "FORGE_REPORT_PATH", default=None, dontovrride=True
-)
-
-
-

-[docs]
-def client_path(alternate_path=None, **kw):
-    path = FORGE_PATH_VAR.secret
-    if path is None:
-        if alternate_path is None:
-            raise KeyError(
-                f"no `FORGE_REPORT_PATH` set and no alternate path in client_path call "
-            )
-        return alternate_path
-    else:
-        return path

-
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/logging.html b/docs/_build/html/_modules/engforge/logging.html deleted file mode 100644 index 80e2d86..0000000 --- a/docs/_build/html/_modules/engforge/logging.html +++ /dev/null @@ -1,442 +0,0 @@ - - - - - - engforge.logging — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.logging

-import logging
-import logging
-import traceback
-import sys, os
-from pyee import EventEmitter
-from termcolor import colored
-import requests
-import json
-import uuid
-
-global log_change_emitter
-log_change_emitter = EventEmitter()
-
-
-BASIC_LOG_FMT = "[%(name)-24s]%(message)s"
-
-global LOG_LEVEL
-LOG_LEVEL = logging.INFO
-
-

-[docs]
-def change_all_log_levels(inst=None,new_log_level: int=20, check_function=None):
-    """Changes All Log Levels With pyee broadcast before reactor is running
-    :param new_log_level: int - changes unit level log level (10-msg,20-debug,30-info,40-warning,50-error,60-crit)
-    :param check_function: callable -> bool - (optional) if provided if check_function(unit) is true then the new_log_level is applied
-    """
-    if isinstance(new_log_level, float):
-        new_log_level = int(new_log_level)  # Float Case Is Handled
-
-    assert (
-        isinstance(new_log_level, int)
-        and new_log_level >= 1
-        and new_log_level <= 100
-    )
-
-    global LOG_LEVEL
-    LOG_LEVEL = new_log_level
-    
-    if LoggingMixin.log_level != new_log_level:
-        print(f"changing log levels to {new_log_level}...")
-        log.info(f"Changing All Logging Units To Level {new_log_level}")
-    log_change_emitter.emit("change_level", new_log_level, check_function)
-    LoggingMixin.log_level = new_log_level
-    if inst: inst.log_level = new_log_level

-
-
-

-[docs]
-class LoggingMixin(logging.Filter):
-    """Class to include easy formatting in subclasses"""
-
-    log_level = LOG_LEVEL
-    _log = None
-
-    log_on = True
-
-    log_fmt = "[%(name)-24s]%(message)s"
-
-    slack_webhook_url = None
-    # log_silo = False
-
-    change_all_log_lvl = lambda s, *a, **kw: change_all_log_levels(s,*a, **kw)
-
-    @property
-    def logger(self):
-        if self._log is None:
-            inst_log_name = (
-                "engforgelog_" + self.identity + "_" + str(uuid.uuid4())
-            )
-            self._log = logging.getLogger(inst_log_name)
-            self._log.setLevel(level=self.__class__.log_level)
-
-            # Apply Filter Info
-            self._log.addFilter(self)
-            self.installSTDLogger()
-            from engforge.env_var import EnvVariable, SLACK_WEBHOOK
-
-            # Hot Patch Class (EnvVar is logging mixin... soo... here we are)
-            if LoggingMixin.slack_webhook_url is None:
-                # Do this on the fly since we SecretVariable is a log component
-                LoggingMixin.slack_webhook_url = SLACK_WEBHOOK
-
-        if not hasattr(self, "_f_change_log"):
-
-            def _change_log(new_level, check_function=None):
-                if new_level != self.log_level:
-                    if check_function is None or check_function(self):
-                        msg = f"changing {self.identity} log level: {self.log_level} -> {new_level}"
-                        self.__class__.log_level = new_level
-                        self.info(msg)
-                        self._log.setLevel(new_level)
-                        self.log_level=new_level
-                        self.resetLog()
-
-            log_change_emitter.add_listener("change_level", _change_log)
-
-            self._f_change_log = _change_log
-
-        return self._log
-
-

-[docs]
-    def resetLog(self):
-        """reset log"""
-        self._log = None
-        self.debug(f"reset!")

-
-
-

-[docs]
-    def resetSystemLogs(self, reseted=None):
-        """resets log on all internal instance LoggingMixins"""
-        self.resetLog()
-        self.debug(f"reset!")
-        if reseted is None:
-            reseted = set()
-        for k, v in self.__dict__.items():
-            if isinstance(v, LoggingMixin) and id(v) not in reseted:
-                reseted.add(id(v))
-                v.resetSystemLogs(reseted)

-
-
-

-[docs]
-    def installSTDLogger(self):
-        """We only want std logging to start"""
-        sh = logging.StreamHandler(sys.stdout)
-        peerlog = logging.Formatter(self.log_fmt)
-        sh.setFormatter(peerlog)
-        self._log.addHandler(sh)

-
-
-

-[docs]
-    def add_fields(self, record):
-        """Overwrite this to modify logging fields"""
-        pass

-
-
-

-[docs]
-    def filter(self, record):
-        """This acts as the interface for `logging.Filter`
-        Don't overwrite this, use `add_fields` instead."""
-        record.name = self.identity.lower()[:24]
-        self.add_fields(record)
-        return True

-
-
-

-[docs]
-    def msg(self, *args,lvl=5):
-        """Writes to log... this should be for raw data or something... least priorty"""
-        if self.log_on:
-            self.logger.log(
-                lvl, self.message_with_identiy(self.extract_message(args), "blue")
-            )

-
-
-

-[docs]
-    def debug(self, *args):
-        """Writes at a low level to the log file... usually this should
-        be detailed messages about what exactly is going on"""
-        if self.log_on:
-            self.logger.debug(
-                self.message_with_identiy(self.extract_message(args), "cyan")
-            )

-
-
-

-[docs]
-    def info(self, *args):
-        """Writes to log but with info category, these are important typically
-        and inform about progress of process in general"""
-        if self.log_on:
-            self.logger.info(
-                self.message_with_identiy(self.extract_message(args), "white")
-            )

-
-
-

-[docs]
-    def warning(self, *args):
-        """Writes to log as a warning"""
-        self.logger.warning(
-            self.message_with_identiy(
-                "WARN: " + self.extract_message(args), "yellow"
-            )
-        )

-
-
-

-[docs]
-    def error(self, error, msg=""):
-        """Writes to log as a error"""
-
-        # fmt = 'ERROR: {msg!r}|{err!r}'
-
-        tb = error.__traceback__
-        fmt = "ERROR:{msg}->{err}"
-
-        tb = "\n".join(traceback.format_exception(error, value=error, tb=tb))
-        msgfmt = ("\n" + " " * 51 + "|").join(str(msg).split("\n"))
-
-        # tbcl = colored(tb, "red")
-        # self.logger.exception( fmt.format(msg=msgfmt,err=tbcl))
-        # self.logger.exception( msgfmt)
-
-        m = colored(fmt.format(msg=msgfmt, err=tb), "red")
-        self.logger.error(m)

-
-
-

-[docs]
-    def critical(self, *args):
-        """A routine to communicate to the root of the server network that there is an issue"""
-        msg = self.extract_message(args)
-        msg = self.message_with_identiy(msg, "magenta")
-        self.logger.critical(msg)
-
-        # FIXME: setup slack notificatinos with env var
-        self.slack_notification(self.identity.title(), msg)

-
-
-    def slack_notification(self, category, message):
-        from engforge.env_var import SLACK_WEBHOOK, HOSTNAME
-
-        if SLACK_WEBHOOK.var_name in os.environ:
-            self.info("getting slack webhook")
-            url = SLACK_WEBHOOK.secret
-        else:
-            return
-        stage = HOSTNAME.secret
-        headers = {"Content-type": "application/json"}
-        data = {
-            "text": "{category} on {stage}:\n```{message}```".format(
-                category=category.upper(), stage=stage, message=message
-            )
-        }
-        self.info(f"Slack Notification : {url}:{category},{message}")
-        slack_note = requests.post(
-            url, data=json.dumps(data).encode("ascii"), headers=headers
-        )
-
-

-[docs]
-    def message_with_identiy(self, message: str, color=None):
-        """converts to color and string via the termcolor library
-        :param message: a string convertable entity
-        :param color: a color in [grey,red,green,yellow,blue,magenta,cyan,white]
-        """
-        if color != None:
-            return colored(str(message), color)
-        return str(message)

-
-
-    def extract_message(self, args):
-        for arg in args:
-            if type(arg) is str:
-                return arg
-        if self.log_level < 0:
-            print(f"no string found for {args}")
-        return ""
-
-    @property
-    def identity(self):
-        return type(self).__name__
-
-    def __getstate__(self):
-        d = dict(self.__dict__)
-        d["_f_change_log"] = None
-        return d

-
-
-
-

-[docs]
-class Log(LoggingMixin):
-    pass

-
-
-
-log = Log()
-
-
-# try:
-#     logging.getLogger('parso.cache').disabled=True
-#     logging.getLogger('parso.cache.pickle').disabled=True
-#     logging.getLogger('parso.python.diff').disabled=True
-#
-# except Exception as e:
-#     log.warning(f'could not diable parso {e}')
-# def installGELFLogger():
-#     '''Installs GELF Logger'''
-#     # self.gelf = graypy.GELFTLSHandler(GELF_HOST,GELF_PORT, validate=True,\
-#     #                         ca_certs=credfile('graylog-clients-ca.crt'),\
-#     #                         certfile = credfile('test-client.crt'),
-#     #                         keyfile = credfile('test-client.key')
-#     #                         )
-#     log = logging.getLogger('')
-#     gelf = graypy.GELFUDPHandler(host=GELF_HOST,port=12203, extra_fields=True)
-#     log.addHandler(gelf)
-
-
-# def installSTDLogger(fmt = BASIC_LOG_FMT):
-#     '''We only want std logging to start'''
-#     log = logging.getLogger('')
-#     sh = logging.StreamHandler(sys.stdout)
-#     peerlog = logging.Formatter()
-#     sh.setFormatter(peerlog)
-#     log.addHandler( sh )
-#
-#
-# def set_all_loggers_to(level,set_stdout=False,all_loggers=False):
-#     global LOG_LEVEL
-#     LOG_LEVEL = level
-#
-#     if set_stdout: installSTDLogger()
-#
-#     logging.basicConfig(level = LOG_LEVEL) #basic config
-#
-#     log = logging.getLogger()
-#     log.setLevel(LOG_LEVEL)# Set Root Logger
-#
-#     log.setLevel(level) #root
-#
-#     loggers = [logging.getLogger(name) for name in logging.root.manager.loggerDict]
-#     for logger in loggers:
-#         if logger.__class__.__name__.lower().startswith('engforge'):
-#             logger.log(LOG_LEVEL,'setting log level: {}'.format(LOG_LEVEL))
-#             logger.setLevel(LOG_LEVEL)
-#         elif all_loggers:
-#             logger.log(LOG_LEVEL,'setting log level: {}'.format(LOG_LEVEL))
-#             logger.setLevel(LOG_LEVEL)
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/patterns.html b/docs/_build/html/_modules/engforge/patterns.html deleted file mode 100644 index eec4aa8..0000000 --- a/docs/_build/html/_modules/engforge/patterns.html +++ /dev/null @@ -1,594 +0,0 @@ - - - - - - engforge.patterns — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.patterns

-import numpy, functools
-
-from engforge.logging import LoggingMixin, logging
-
-
-

-[docs]
-class inst_vectorize(numpy.vectorize):
-    def __get__(self, obj, objtype):
-        return functools.partial(self.__call__, obj)

-
-
-
-

-[docs]
-def chunks(lst, n):
-    """Yield successive n-sized chunks from lst."""
-    for i in range(0, len(lst), n):
-        yield lst[i : i + n]

-
-
-
-

-[docs]
-class Singleton:
-    """
-    A non-thread-safe helper class to ease implementing singletons.
-    This should be used as a decorator -- not a metaclass -- to the
-    class that should be a singleton.
-
-    The decorated class can define one `__init__` function that
-    takes only the `self` argument. Also, the decorated class cannot be
-    inherited from. Other than that, there are no restrictions that apply
-    to the decorated class.
-
-    To get the singleton instance, use the `instance` method. Trying
-    to use `__call__` will result in a `TypeError` being raised.
-
-    """
-
-    def __init__(self, decorated):
-        self._decorated_cls = decorated
-
-        self.__class__.__name__ = self._decorated_cls.__name__
-
-

-[docs]
-    def instance(self, *args, **kwargs):
-        """
-        Returns the singleton instance. Upon its first call, it creates a
-        new instance of the decorated class and calls its `__init__` method.
-        On all subsequent calls, the already created instance is returned.
-
-        """
-        try:
-            return self._instance
-        except AttributeError:
-            self._instance = self._decorated_cls(*args, **kwargs)
-            return self._instance

-
-
-

-[docs]
-    def __call__(self):
-        raise TypeError("Singletons must be accessed through `instance()`.")

-
-
-    def __instancecheck__(self, inst):
-        return isinstance(inst, self._decorated)

-
-
-
-

-[docs]
-class SingletonMeta(type):
-    """Metaclass for singletons. Any instantiation of a Singleton class yields
-    the exact same object, e.g.:
-
-    >>> class MyClass(metaclass=Singleton):
-            pass
-    >>> a = MyClass()
-    >>> b = MyClass()
-    >>> a is b
-    True
-    """
-
-    _instances = {}
-
-

-[docs]
-    def __call__(cls, *args, **kwargs):
-        if cls not in cls._instances:
-            cls._instances[cls] = super(SingletonMeta, cls).__call__(
-                *args, **kwargs
-            )
-        return cls._instances[cls]

-
-
-    @classmethod
-    def __instancecheck__(mcs, instance):
-        if instance.__class__ is mcs:
-            return True
-        else:
-            return isinstance(instance.__class__, mcs)

-
-
-
-# class MetaRegistry(type):
-
-#     REGISTRY = {}
-
-#     def __new__(meta, name, bases, class_dict):
-#         cls = type.__new__(meta, name, bases, class_dict)
-#         if name not in registry:
-#             meta.register_class(cls)
-#         return cls
-
-#     def register_class(target_class):
-#         REGISTRY[target_class.__name__] = target_class
-
-
-

-[docs]
-class InputSingletonMeta(type):
-    """Metaclass for singletons. Any instantiation of a Singleton class yields
-    the exact same object, for the same given input, e.g.:
-
-    >>> class MyClass(metaclass=Singleton):
-            pass
-    >>> a = MyClass(input='same')
-    >>> b = MyClass(input='diff')
-    >>> a is b
-    False
-    """
-
-    _instances = {}
-
-

-[docs]
-    def __call__(cls, *args, **kwargs):
-        keyarg = {"class": cls, "args": args, **kwargs}
-        keyarg["class"] = cls
-        keyarg["args"] = args
-        key = frozenset(keyarg.items())
-        if key not in cls._instances:
-            # print(f'creating new {key}')
-            cls._instances[key] = super(InputSingletonMeta, cls).__call__(
-                *args, **kwargs
-            )
-        return cls._instances[key]

-
-
-    @classmethod
-    def __instancecheck__(mcs, instance):
-        if instance.__class__ is mcs:
-            return True
-        else:
-            return isinstance(instance.__class__, mcs)

-
-
-
-

-[docs]
-def singleton_meta_object(cls):
-    """Class decorator that transforms (and replaces) a class definition (which
-    must have a Singleton metaclass) with the actual singleton object. Ensures
-    that the resulting object can still be "instantiated" (i.e., called),
-    returning the same object. Also ensures the object can be pickled, is
-    hashable, and has the correct string representation (the name of the
-    singleton)
-    """
-    assert isinstance(cls, SingletonMeta), (
-        cls.__name__ + " must use Singleton metaclass"
-    )
-
-    def instance(self):
-        return cls
-
-    cls.__call__ = instance
-    cls.__hash__ = lambda self: hash(cls)
-    cls.__repr__ = lambda self: cls.__name__
-    cls.__reduce__ = lambda self: cls.__name__
-    obj = cls()
-    obj.__name__ = cls.__name__
-    return obj

-
-
-
-

-[docs]
-def flat2gen(alist):
-    for item in alist:
-        if isinstance(item, (list, tuple)):
-            for subitem in item:
-                yield subitem
-        else:
-            yield item

-
-
-
-

-[docs]
-def flatten(alist):
-    return list(flat2gen(alist))

-
-
-
-#
-#
-#
-# #TODO: Move to ray-util
-# # FROM RAY INSPECT_SERIALIZE
-# """A utility for debugging serialization issues."""
-# from typing import Any, Tuple, Set, Optional
-# import inspect
-# import ray.cloudpickle as cp
-# import colorama
-# from contextlib import contextmanager
-#
-# def recursive_python_module_line_counter(curpath=None):
-#     total_lines = 0
-#     if curpath is None or not isinstance(curpath, str):
-#         curpath = os.path.realpath(os.curdir)
-#
-#     print(f'Getting Python Lines In {curpath}')
-#     for dirpath, dirs, fils in os.walk(curpath):
-#         for fil in fils:
-#             if fil.endswith('.py'):
-#                 filpath = os.path.join(dirpath,fil)
-#                 with open(filpath,'r') as fp:
-#                     lines = len(str(fp.read()).split('\n'))
-#                     total_lines += lines
-#                     print(f'{filpath}: {lines} / {total_lines}')
-#
-#     print(f'Total Lines {total_lines}')
-#
-
-#
-# @contextmanager
-# def _indent(printer):
-#     printer.level += 1
-#     yield
-#     printer.level -= 1
-#
-#
-# class _Printer(LoggingMixin):
-#
-#     log_level = logging.WARNING
-#
-#     def __init__(self):
-#         self.level = 0
-#
-#     def indent(self):
-#         return _indent(self)
-#
-#     def print(self, msg, warning=False):
-#         indent = "    " * self.level
-#         if warning:
-#             self.warning(indent+msg)
-#         else:
-#             self.debug(indent+msg)
-#
-#
-# _printer = _Printer()
-#
-#
-# class FailureTuple:
-#     """Represents the serialization 'frame'.
-#
-#     Attributes:
-#         obj: The object that fails serialization.
-#         name: The variable name of the object.
-#         parent: The object that references the `obj`.
-#     """
-#
-#     def __init__(self, obj: Any, name: str, parent: Any):
-#         self.obj = obj
-#         self.name = name
-#         self.parent = parent
-#
-#     def __repr__(self):
-#         return f"FailTuple({self.name} [obj={self.obj}, parent={self.parent}])"
-#
-#
-# def _inspect_func_serialization(base_obj, depth, parent, failure_set):
-#     """Adds the first-found non-serializable element to the failure_set."""
-#     assert inspect.isfunction(base_obj)
-#     closure = inspect.getclosurevars(base_obj)
-#     found = False
-#     if closure.globals:
-#         _printer.print(f"Detected {len(closure.globals)} global variables. "
-#                        "Checking serializability...")
-#
-#         with _printer.indent():
-#             for name, obj in closure.globals.items():
-#                 serializable, _ = inspect_serializability(
-#                     obj,
-#                     name=name,
-#                     depth=depth - 1,
-#                     _parent=parent,
-#                     _failure_set=failure_set)
-#                 found = found or not serializable
-#                 if found:
-#                     break
-#
-#     if closure.nonlocals:
-#         _printer.print(
-#             f"Detected {len(closure.nonlocals)} nonlocal variables. "
-#             "Checking serializability...")
-#         with _printer.indent():
-#             for name, obj in closure.nonlocals.items():
-#                 serializable, _ = inspect_serializability(
-#                     obj,
-#                     name=name,
-#                     depth=depth - 1,
-#                     _parent=parent,
-#                     _failure_set=failure_set)
-#                 found = found or not serializable
-#                 if found:
-#                     break
-#     if not found:
-#         _printer.print(
-#             f"WARNING: Did not find non-serializable object in {base_obj}. "
-#             "This may be an oversight.",warning=True)
-#     return found
-#
-#
-# def _inspect_generic_serialization(base_obj, depth, parent, failure_set):
-#     """Adds the first-found non-serializable element to the failure_set."""
-#     assert not inspect.isfunction(base_obj)
-#     functions = inspect.getmembers(base_obj, predicate=inspect.isfunction)
-#     found = False
-#     with _printer.indent():
-#         for name, obj in functions:
-#             serializable, _ = inspect_serializability(
-#                 obj,
-#                 name=name,
-#                 depth=depth - 1,
-#                 _parent=parent,
-#                 _failure_set=failure_set)
-#             found = found or not serializable
-#             if found:
-#                 break
-#
-#     with _printer.indent():
-#         members = inspect.getmembers(base_obj)
-#         for name, obj in members:
-#             if name.startswith("__") and name.endswith(
-#                     "__") or inspect.isbuiltin(obj):
-#                 continue
-#             serializable, _ = inspect_serializability(
-#                 obj,
-#                 name=name,
-#                 depth=depth - 1,
-#                 _parent=parent,
-#                 _failure_set=failure_set)
-#             found = found or not serializable
-#             if found:
-#                 break
-#     if not found:
-#         _printer.print(
-#             f"WARNING: Did not find non-serializable object in {base_obj}. "
-#             "This may be an oversight.",warning=True)
-#     return found
-#
-#
-# def inspect_serializability(
-#         base_obj: Any,
-#         name: Optional[str] = None,
-#         depth: int = 3,
-#         _parent: Optional[Any] = None,
-#         _failure_set: Optional[set] = None) -> Tuple[bool, Set[FailureTuple]]:
-#     """Identifies what objects are preventing serialization.
-#
-#     Args:
-#         base_obj: Object to be serialized.
-#         name: Optional name of string.
-#         depth: Depth of the scope stack to walk through. Defaults to 3.
-#
-#     Returns:
-#         bool: True if serializable.
-#         set[FailureTuple]: Set of unserializable objects.
-#
-#     .. versionadded:: 1.1.0
-#
-#     """
-#     colorama.init()
-#     top_level = False
-#     declaration = ""
-#     found = False
-#     if _failure_set is None:
-#         top_level = True
-#         _failure_set = set()
-#         declaration = f"Checking Serializability of {base_obj}"
-#         _printer.print("=" * min(len(declaration), 80))
-#         _printer.print(declaration)
-#         _printer.print("=" * min(len(declaration), 80))
-#
-#         if name is None:
-#             name = str(base_obj)
-#     else:
-#         _printer.print(f"Serializing '{name}' {base_obj}...")
-#     try:
-#         cp.dumps(base_obj)
-#         return True, _failure_set
-#     except Exception as e:
-#         _printer.print(f"{colorama.Fore.RED}!!! FAIL{colorama.Fore.RESET} "
-#                        f"serialization: {e}",warning=True)
-#         found = True
-#         try:
-#             if depth == 0:
-#                 _failure_set.add(FailureTuple(base_obj, name, _parent))
-#         # Some objects may not be hashable, so we skip adding this to the set.
-#         except Exception:
-#             pass
-#
-#     if depth <= 0:
-#         return False, _failure_set
-#
-#     # TODO: we only differentiate between 'function' and 'object'
-#     # but we should do a better job of diving into something
-#     # more specific like a Type, Object, etc.
-#     if inspect.isfunction(base_obj):
-#         _inspect_func_serialization(
-#             base_obj, depth=depth, parent=base_obj, failure_set=_failure_set)
-#     else:
-#         _inspect_generic_serialization(
-#             base_obj, depth=depth, parent=base_obj, failure_set=_failure_set)
-#
-#     if not _failure_set:
-#         _failure_set.add(FailureTuple(base_obj, name, _parent))
-#
-#     if top_level:
-#         print("=" * min(len(declaration), 80))
-#         if not _failure_set:
-#             _printer.print("Nothing failed the inspect_serialization test, though "
-#                   "serialization did not succeed.",warning=True)
-#         else:
-#             fail_vars = f"\n\n\t{colorama.Style.BRIGHT}" + "\n".join(
-#                 str(k)
-#                 for k in _failure_set) + f"{colorama.Style.RESET_ALL}\n\n"
-#             _printer.print(f"Variable: {fail_vars}was found to be non-serializable. "
-#                   "There may be multiple other undetected variables that were "
-#                   "non-serializable. ",warning=True)
-#             _printer.print("Consider either removing the "
-#                   "instantiation/imports of these variables or moving the "
-#                   "instantiation into the scope of the function/class. ",warning=True)
-#         _printer.print("If you have any suggestions on how to improve "
-#               "this error message, please reach out to the "
-#               "Ray developers on github.com/ray-project/ray/issues/",warning=True)
-#         _printer.print("=" * min(len(declaration), 80))
-#     return not found, _failure_set
-#
-#
-# import pickle
-#
-# def pickle_trick(obj, max_depth=10):
-#     output = {}
-#
-#     if max_depth <= 0:
-#         return output
-#
-#     try:
-#         pickle.dumps(obj)
-#     except (pickle.PicklingError, TypeError) as e:
-#         failing_children = []
-#
-#         if isinstance(obj, (list,tuple)):
-#             for it in obj:
-#                 result = pickle_trick(v, max_depth=max_depth - 1)
-#                 if result:
-#                     failing_children.append(result)
-#
-#         elif hasattr(obj, "__dict__"):
-#             for k, v in obj.__dict__.items():
-#                 result = pickle_trick(v, max_depth=max_depth - 1)
-#                 if result:
-#                     failing_children.append(result)
-#
-#         output = {
-#             "fail": obj,
-#             "err": e,
-#             "depth": max_depth,
-#             "failing_children": failing_children
-#         }
-#
-#     return output
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/problem_context.html b/docs/_build/html/_modules/engforge/problem_context.html deleted file mode 100644 index 63b6e51..0000000 --- a/docs/_build/html/_modules/engforge/problem_context.html +++ /dev/null @@ -1,2034 +0,0 @@ - - - - - - engforge.problem_context — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.problem_context

-"""The ProblemExec provides a uniform set of options for managing the state of the system and its solvables, establishing the selection of combos or de/active attributes to Solvables. Once once created any further entracnces to ProblemExec will return the same instance until finally the last exit is called. 
-
-The ProblemExec class allows entrance to a its context to the same instance until finally the last exit is called. The first entrance to the context will create the instance, each subsequent entrance will return the same instance. The ProblemExec arguments are set the first time and remove keyword arguments from the input dictionary (passed as a dict ie stateful) to subsequent methods. 
-This isn't technically a singleton pattern, but it does provide a similar interface. Instead mutliple problem instances will be clones of the first instance, with the optional difference of input/output/event criteria. The first instance will be returned by each context entry, so for that reason it may always appear to have same instance, however each instance is unique in a recusive setting so it may record its own state and be reverted to its own state as per the options defined.
-
-#TODO: allow update of kwargs on re-entrance
-
-## Example:
-.. code-block:: python
-
-    #Application code (arguments passed in kw)
-    with ProblemExec(sys,combos='default',slv_vars'*',**kw) as pe:
-        pe._sys_refs #get the references and compiled problem
-        for i in range(10):
-            pe.solve_min(pe.Xref,pe.Yref,**other_args)
-            pe.set_checkpoint() #save the state of the system 
-            self.save_data()
-            
-
-    #Solver Module (can use without knowledge of the runtime system)
-    with ProblemExec(sys,{},Xnew=Xnext,ctx_fail_new=True) as pe:
-        #do revertable math on the state of the system without concern for the state of the system
-...
-
-# Combos Selection
-By default no arguments run will select all active items with combo="default". The `combos` argument can be used to select a specific set of combos, a outer select. From this set, the `ign_combos` and `only_combos` arguments can be used to ignore or select specific combos based on exclusion or inclusion respectively.
-
-# Parameter Name Selection
-The `slv_vars` argument can be used to select a specific set of solvables. From this set, the `ign_vars` and `only_vars` arguments can be used to ignore or select specific solvables based on exclusion or inclusion respectively. The `add_vars` argument can be used to add a specific set of solvables to the solver.
-
-# Active Mode Handiling
-The `only_active` argument can be used to select only active items. The `activate` and `deactivate` arguments can be used to activate or deactivate specific solvables.
-
-`add_obj` can be used to add an objective to the solver. 
-
-# Exit Mode Handling
-
-The ProblemExec supports the following exit mode handling vars:
-
-- `fail_revert`: Whether to raise an error if no solvables are selected. Default is True.
-- `revert_last`: Whether to revert the last change. Default is True.
-- `revert_every`: Whether to revert every change. Default is True.
-- `exit_on_failure`: Whether to exit on first failure. Default is True.
-
-These vars control the behavior of the ProblemExec when an error occurs or when no solvables are selected.
-
-"""
-
-#TODO: define the 
-
-from engforge.logging import LoggingMixin
-from engforge.system_reference import Ref
-from engforge.dataframe import DataframeMixin,pandas
-from engforge.solver_utils import *
-from engforge.env_var import EnvVariable
-import weakref
-
-from scipy.integrate import solve_ivp
-from collections import OrderedDict
-import numpy as np
-import pandas as pd
-import expiringdict
-import attr, attrs
-import datetime
-
-

-[docs]
-class ProbLog(LoggingMixin): pass

-
-log = ProbLog()
-
-import uuid
-
-#TODO: implement add_vars feature, ie it creates a solver variable, or activates one if it doesn't exist from in system.heirarchy.format
-#TODO: define the dataframe / data storage feature
-
-min_opt = {'finite_diff_rel_step': 0.25,'maxiter':10000}
-min_kw_dflt = {"tol":1e-10, "method": "SLSQP",'jac':'cs', 'hess':'cs','options':min_opt}
-
-
-#The KW Defaults for Solver via kw_dict
-# IMPORTANT:!!! these group parameter names by behavior, they are as important as the following class, add/remove variables with caution
-#these choices affect how solver-items are selected and added to the solver
-slv_dflt_options = dict(combos='default',ign_combos=None,only_combos=None,add_obj=True,slv_vars='*',add_vars=None,ign_vars=None,only_vars=None,only_active=True,activate=None,deactivate=None,dxdt=None,weights=None,both_match=True,obj=None)
-#KW Defaults for the local context (what saves state for contexts / reverts ect)
-dflt_parse_kw = dict(fail_revert=True,revert_last=True,revert_every=True,exit_on_failure=True, pre_exec=True,post_exec=True,opt_fail = True,level_name='top',post_callback=None,success_thresh=10,copy_system=False,run_solver=False,min_kw=None,save_mode='all',x_start = None,save_on_exit=False,enter_refresh=False)
-#can be found on session._<parm> or session.<parm>
-root_defined = dict( last_time = 0,time = 0,dt = 0,update_refs=None,post_update_refs=None,sys_refs=None,slv_kw=None,minimizer_kw=None,data = None,weights=None,dxdt = None,run_start = None,run_end = None,run_time = None,all_refs=None,num_refs=None,converged=None,comp_changed=False)
-save_modes = ['vars','nums','all','prob']
-transfer_kw = ['system','_dxdt']
-
-root_possible = list(root_defined.keys()) + list('_'+k for k in root_defined.keys())
-
-#TODO: output options extend_dataframe=True,return_dataframe=True,condensed_dataframe=True,return_system=True,return_problem=True,return_df=True,return_data=True
-#TODO: connect save_data() output to _data table.
-#TODO: move dataframe mixin here, system should return a dataframe, and the problem should be able to save data to the dataframe, call this class Problem(). With default behavior it could seem like a normal dataframe is returned on problem.return(*state,exit,revert...)
-
-#Special exception classes handled in exit
-

-[docs]
-class IllegalArgument(Exception):
-    """an exception to exit the problem context as specified"""
-    pass

-
-
-

-[docs]
-class ProblemExit(Exception):
-    """an exception to exit the problem context, without error"""
-    revert:bool
-    prob:"ProblemExec"
-    def __init__(self,prob:"ProblemExec",revert:bool=None):
-        self.revert = revert
-        self.prob = prob
-
-    def __str__(self) -> str:
-        return f'ProblemExit[{self.prob}|rvt={self.revert}]'        

-
-
-

-[docs]
-class ProblemExitAtLevel(ProblemExit):
-    """an exception to exit the problem context, without error"""
-    level: str
-    def __init__(self,prob:"ProblemExec",level:str,revert=None):
-        assert level is not None, 'level must be defined'
-        assert isinstance(level,str), 'level must be a string'
-        self.prob = prob
-        self.level = level.lower()
-        self.revert = revert
-
-    def __str__(self) -> str:
-        return f'ProblemExit[{self.prob}|lvl={self.level}|rvt={self.revert}]'

-
-
-
-#TODO: determine when components are updated, and refresh the system references accordingly.
-#TODO: Map attributes/properties by component key and then autofix refs! (this is a big one), no refresh required. Min work
-

-[docs]
-class ProblemExec:
-    """
-    Represents the execution context for a problem in the system. The ProblemExec class provides a uniform set of options for managing the state of the system and its solvables, establishing the selection of combos or de/active attributes to Solvables. Once once created any further entracnces to ProblemExec will return the same instance until finally the last exit is called.
-
-    ## params:
-    -  _problem_id: uuid for subproblems, or True for top level, None means uninitialized
-
-    """
-    #TODO: convert this to a system based cache where there is a unique problem for each system instance. On subprobem copy a system and add o dictionary.
-    class_cache = None #ProblemExec is assigned below
-    
-    #this class, wide, dont redefine it
-    problems_dict = weakref.WeakValueDictionary()
-
-    system: "System"
-    session: "ProblemExec"
-    session_id = None
-
-    #problem state / per level
-    problem_id = None 
-    entered: bool = False
-    exited: bool = False  
-
-    #solution control (point to singleton/subproblem via magic getattr)
-    _last_time: float = 0
-    _time: float = 0
-    _dt: float = 0    
-    _update_refs: dict 
-    _post_update_refs: dict
-    _sys_refs: dict
-    _slv_kw: dict
-    _minimizer_kw: dict
-    _data: list 
-    _weights: dict
-    x_start:dict
-    _dxdt:float
-    _run_start:float
-    _run_end:float
-    _run_time:float
-    _converged:bool
-    
-
-    #Interior Context Options
-    enter_refresh: bool = False
-    save_on_exit: bool = False
-    save_mode: str = 'all'
-    level_name: str = None #target this context with the level name
-    level_number: int = 0 #TODO: keep track of level on the global context  
-    pre_exec: bool = True
-    post_exec: bool = True
-    fail_revert: bool = True
-    revert_last: bool = True
-    revert_every: bool = True
-    exit_on_failure: bool = True
-    opt_fail: bool = True
-    raise_on_unknown: bool = True
-    copy_system: bool = False
-    success_thresh = 1E6 #if system has `success_thresh` it will be assigned to the context
-    post_callback: callable = None#callback that will be called on the system each time it is reverted, it should take args(system,current_problem_exec)
-    run_solver: bool = False #for transient #i would love this to be=true, but there's just too much possible variation in application to make it so without some kind of control / continuity strategy. Dynamics are natural responses anyways, so solver use should be an advanced case for now (MPC/Filtering/ect later)
-
-    
-
-
-    def __getattr__(self, name):
-        '''This is a special method that is called when an attribute is not found in the usual places, like when interior contexts (anything not the root (session_id=True)) are created that dont have the top level's attributes. some attributes will look to the parent session'''
-
-        #interior context lookup (when in active context, ie session exists)
-        if hasattr(self.class_cache,'session') and name in root_possible:
-            #revert to the parent session
-            if self.session_id != True and name.startswith('_'):
-                #self.info(f'get parent private {name}')
-                return getattr(self.class_cache.session,name)
-
-            elif name in root_defined:
-                #self.info(f'get parent public {name}')
-                return getattr(self.class_cache.session,'_'+name)
-            
-        if name in root_defined: #public interface
-            #self.info(f'get root fallback {name}')
-            return self.__getattribute__('_'+name)
-
-        # Default behaviour
-        return self.__getattribute__(name)
-
-        
-    def __init__(self,system,kw_dict=None,Xnew=None,ctx_fail_new=False,**opts):
-        """
-        Initializes the ProblemExec.
-        
-        #TODO: exit system should abide by update / signals options
-
-        #TODO: provide data storage options for dataframe / table storage history/ record keeping (ss vs transient data)
-        
-        #TODO: create an option to copy the system and run operations on it, and options for applying the state from the optimized copy to the original system
-
-        :param system: The system to be executed.
-        :param Xnew: The new state of the system to set wrt. reversion, optional
-        :param ctx_fail_new: Whether to raise an error if no execution context is available, use in utility methods ect. Default is False.
-        :param kw_dict: A keyword argument dictionary to be parsed for solver options, and removed from the outer context. Changes are made to this dictionary, so they are removed automatically from the outer context, and thus no longer passed to interior vars.
-        :param dxdt: The dynamics integration method. Default is None meaning that dynamic vars are not considered for minimization unless otherwise specified. Steady State can be specified by dxdt=0 all dynamic vars are considered as solver variables, with the constraint that their rate of change is zero. If a dictionary is passed then the dynamic vars are considered as solver variables, with the constraint that their rate of change is equal to the value in the dictionary, and all other unspecified rates are zero (steady).
-
-        #### Solver Selection Options
-        :param combos: The selection of combos. Default is '*' (select all).
-        :param  ign_combos: The combos to be ignored.
-        :param  only_combos: The combos to be selected.
-        :param  add_obj: Whether to add an objective to the solver. Default is True.
-        :param  slv_vars: The selection of solvables. Default is '*' (select all).
-        :param  add_vars: The solvables to be added to the solver.
-        :param  ign_vars: The solvables to be ignored.
-        :param  only_vars: The solvables to be selected.
-        :param  only_active: Whether to select only active items. Default is True.
-        :param  activate: The solvables to be activated.
-        :param  deactivate: The solvables to be deactivated.
-        :param  fail_revert: Whether to raise an error if no solvables are selected. Default is True.
-        :param  revert_last: Whether to revert the last change. Default is True.
-        :param  revert_every: Whether to revert every change. Default is True.
-        :param  exit_on_failure: Whether to exit on failure, or continue on. Default is True.
-        """
-
-        self.dynamics_updated = False #it is known
-
-        if kw_dict is None:
-            #kw_dict is stateful so you can mix system & context args together, and ensure context args are removed. in the case this is unused, we'll create an empty dict to avoid errors
-            kw_dict = {}
-        
-        #storage optoins
-        if opts.pop('persist',False) or kw_dict.pop('persist',False) :
-            self.persist_contexts()
-
-        # temp solver storage
-        self.solver_hist = expiringdict.ExpiringDict(100, 60)  
-
-        if self.log_level < 5:
-            if hasattr(self.class_cache,'session'):
-                self.debug(f'subctx{self.level_number}|  keywords: {kw_dict} and misc: {opts}')
-            else:
-                self.debug(f'context| keywords: {kw_dict} and misc: {opts}')
-
-        #special cases for parsing
-        #parse the options to change behavior of the context
-        level_name = None
-        if opts and 'level_name' in opts:
-            level_name = opts.pop('level_name').lower()
-        if kw_dict and 'level_name' in kw_dict:
-            level_name = kw_dict.pop('level_name').lower()
-
-        #solver min-args wrt defaults
-        min_kw = None
-        if opts and 'min_kw' in opts: 
-            min_kw = kw_dict.pop('min_kw')
-        if kw_dict and 'min_kw' in kw_dict:
-            min_kw = kw_dict.pop('min_kw')
-
-        
-        mkw =min_kw_dflt.copy()
-        if min_kw is None:
-            min_kw = mkw
-        else:
-            mkw.update(min_kw)
-
-        self._minimizer_kw = mkw
-
-        #Merge kwdict(stateful) and opts (current level)
-        #solver vars should be static for a problem and subcontexts, however the default vars can change. Subproblems allow for the solver vars to be changed on its creation.
-        opt_in,opt_out = {},{}
-        if opts:
-            #these go to the context instance optoins
-            opt_in = {k:v for k,v in opts.items() if k in dflt_parse_kw}
-            #these go to system establishment
-            opt_out = {k:v for k,v in opts.items() if k not in opt_in}
-
-        if kw_dict is None:
-            kw_dict = {}
-
-        else:
-            #these go to the context instance optoins
-            kw_in = {k:v for k,v in kw_dict.items() if k in dflt_parse_kw}
-            opt_in.update(kw_in)
-            kw_out = {k:v for k,v in kw_dict.items() if k not in opt_in}
-            #these go to system establishment
-            opt_out.update(kw_out)
-            #remove problem options from dict (otherwise passed along to system!)
-            for k in kw_in:
-                kw_dict.pop(k)
-
-
-        #Define the handiling of rate integrals
-        if 'dxdt' in opts and opts['dxdt'] is not None:
-            dxdt = opts.pop('dxdt')
-        if 'dxdt' in kw_dict and kw_dict['dxdt'] is not None:
-            dxdt = kw_dict.pop('dxdt')
-        else:
-            dxdt = None  #by default dont consider dynamics
-
-        if dxdt is not None and dxdt is not False:
-            if dxdt == 0:
-                pass
-            elif dxdt is True:
-                pass
-            elif isinstance(dxdt, dict):  # dxdt is a dictionary
-                #provide a set of values or function to have the solver solve for
-                pass
-            else:
-                raise IllegalArgument(f'bad dxdt value {dxdt}')
-            
-        if hasattr(self.class_cache,'session'):                        
-            #mirror the state of session (exactly)
-            copy_vals = {k:v for k,v in self.class_cache.session.__dict__.items() if k in dflt_parse_kw or k in transfer_kw}
-            self.__dict__.update(copy_vals)
-            self._problem_id = int(uuid.uuid4())
-            self.problems_dict[self._problem_id] = self #carry that weight
-            self.session_id = int(uuid.uuid4())
-
-            self.class_cache.session._prob_levels[self.level_name] = self
-            #error if the system is different (it shouldn't be!)
-            if self.system is not system:
-                raise IllegalArgument(f'somethings wrong! change of comp! {self.system} -> {system}')
-
-            #modify things from the input
-            if level_name is None:
-                #your new id
-                self.level_name = 'ctx_'+str(int(self._problem_id))[0:15]
-            else:
-                self.level_name = level_name
-
-            if opt_in: self.__dict__.update(opt_in) #level options ASAP
-            self.temp_state = Xnew #input state exception to this
-            if log.log_level < 5:
-                self.msg(f'setting execution context with {opt_in}| {opt_out}')
-            
-            #each state request to be reverted, then we need to store the state of each execution context overriding the outer context x_start
-            self.set_checkpoint()
-
-        elif ctx_fail_new:
-            raise IllegalArgument(f'no execution context available')
-        
-        else:
-            #add the prob options to the context
-            self.__dict__.update(opt_in)
-            self._problem_id = True #this is the top level
-            self.problems_dict[self._problem_id] = self #carry that weight
-            self._prob_levels = {}
-            
-            self._dxdt = dxdt
-            self.reset_data()
-
-            #supply the level name default as top if not set
-            if level_name is None:
-                self.level_name = 'top'
-            else:
-                self.level_name = level_name
-
-            self.temp_state = Xnew
-            self.establish_system(system,kw_dict=kw_dict,**opt_out)                  
-
-            #Finally we record where we started!
-            self.set_checkpoint()       
-
-        if log.log_level < 10:
-            self.info(f'new execution context for {system}| {opts} | {self._slv_kw}')
-
-        elif log.log_level <= 3:
-            self.msg(f'new execution context for {system}| {self._slv_kw}')
-
-
-

-[docs]
-    def reset_data(self):
-        '''reset the data storage'''
-        #the data storage!!
-        #TODO: add buffer type, or disk cache
-        self._data = {} #index:row_dict 
-        self._index = 0# works for time or index

-
-
-
-

-[docs]
-    def establish_system(self,system,kw_dict,**kwargs):
-        """caches the system references, and parses the system arguments"""
-        from engforge.solver import SolverMixin
-        from engforge.system import System 
-    
-        if self.copy_system:
-            system = system.copy_config_at_state()
-
-        #place me here after system has been modified
-        self.system = system
-        #cache as much as possible before running the problem (stitch in time saves 9 or whatever)
-
-
-        #pass args without creating singleton (yet)
-        self.session_id = int(uuid.uuid4())
-        self._run_start = datetime.datetime.now()
-        self.name = system.name + '-' + str(self.session_id)[:8]
-
-        if log.log_level < 5:
-            self.info(f'establish {system}| {kw_dict} {kwargs}')
-
-        assert isinstance(self.system,SolverMixin), 'only solveable interfaces are supported for execution context'
-        self.system._last_context = self #set the last context to this one
-
-        if hasattr(self.system,'success_thresh') and isinstance(self.system.success_thresh,(int,float)):
-            self.success_thresh = self.system.success_thresh
-        #Extract solver vars and set them on this object, they will be distributed to any new further execution context's via monkey patch above
-        in_kw = self.get_extra_kws(kwargs,slv_dflt_options,use_defaults=False)
-        self._slv_kw = self.get_extra_kws(kw_dict,slv_dflt_options,rmv=True)
-        self._slv_kw.update(in_kw) #update with input!
-
-        self.refresh_references()
-
-        #Get solver weights
-        self._weights = self._slv_kw.get('weights',None)
-
-        #Grab inputs and set to system
-        for k,v in dflt_parse_kw.items():
-            if k in self._slv_kw:
-                setattr(self,k,self._slv_kw[k])
-
-        if log.log_level < 5:
-            self.msg(f'established sys context: {self} {self._slv_kw}')  

-
-
-    @property
-    def sesh(self):
-        """caches the property for the session"""
-        if hasattr(self,'inst_sesh'):
-            return self.inst_sesh
-        sesh = self.get_sesh()
-        return sesh
-
-

-[docs]
-    def get_sesh(self,sesh=None):
-        """get the session"""
-        out = sesh
-        if not sesh:
-            if hasattr(self.class_cache,'session'):
-                out = self.class_cache.session
-            elif self._problem_id == True:
-                out = self
-        if out: 
-            self.inst_sesh = out
-        return out

-
-
-    #Update Methods
-

-[docs]
-    def refresh_references(self,sesh=None):
-        """refresh the system references"""
-        sesh = self.sesh
-
-        if self.log_level < 5:
-            self.warning(f'refreshing system references')
-        check_dynamics = sesh.check_dynamics
-        sesh._num_refs = sesh.system.system_references(numeric_only=True)
-        sesh._sys_refs = sesh.system.solver_vars(check_dynamics=check_dynamics,addable=sesh._num_refs,**sesh._slv_kw)
-        
-        sesh.update_methods(sesh=sesh)
-        sesh.min_refresh(sesh=sesh)

-
-                
-
-    def update_methods(self,sesh=None):
-        #Get the update method refs
-        sesh = sesh if sesh is not None else self.sesh
-
-        sesh._update_refs = sesh.system.collect_update_refs()
-        #TODO: find subsystems that are not-subsolvers and execute them
-        sesh._post_update_refs = sesh.system.collect_post_update_refs()
-
-        sesh.update_dynamics(sesh=sesh)
-
-    def update_dynamics(self,sesh=None):
-        #apply changes to the dynamics models
-        sesh = sesh if sesh is not None else self.sesh
-        if self.dynamic_comps:
-            self.info(f'update dynamics')
-            self.system.setup_global_dynamics()            
-
-    def min_refresh(self,sesh=None):
-        sesh = sesh if sesh is not None else  self.sesh
-
-        if self.log_level < 5:
-            self.info(f'min refresh')
-
-        #final ref's after update
-        #after updates
-        sesh._all_refs = sesh.system.system_references(recache=True,check_config=False,ignore_none_comp=False)
-        
-
-        #Problem Variable Definitions
-        sesh.Xref = sesh.all_problem_vars
-        sesh.Yref = sesh.sys_solver_objectives()
-        
-        cons = {} #TODO: parse additional constraints
-        sesh.constraints = sesh.sys_solver_constraints(cons) 
-
-
-    @property
-    def check_dynamics(self):
-        sesh = self.sesh
-        return sesh._dxdt is not None and sesh._dxdt is not False
-
-    #Context Manager Interface
-    def __enter__(self):
-        #Set the new state
-        
-        if self.entered:
-            #TODO: enable env-var STRICT MODE to fail on things like this
-            self.warning(f'context already entered!')
-        elif self.log_level < 10:
-            self.debug(f'enter context: {self.level_name} {self._dxdt} {self.dynamics_updated}')
-        
-        #Important managed updates / refs from Xnew input
-        self.activate_temp_state()
-        self.entered = True
-
-        #signals / updates
-        if self.pre_exec:
-            self.pre_execute()            
-
-        #TODO: create a component-slot ref-update graph, and update the system references accordingly.
-        #TODO: map the signals to the system references, and update the system references accordingly.
-        #TODO: 
-        #transients wont update components/ methods dynamically (or shouldn't) so we can just update the system references once and be done with it for other cases, but that is not necessary unless a component changes or a component has in general a unique reference update system (economics / component-iterators)
-        sesh = self.sesh
-        if not sesh._dxdt is True and self.enter_refresh:
-            sesh.update_methods(sesh=sesh)
-            sesh.min_refresh(sesh=sesh)
-        
-        elif sesh.dynamics_updated:
-            sesh.update_dynamics(sesh=sesh)
-
-        #Check for existing session        
-        if sesh not in [None,self]:
-            self.msg(f'entering existing execution context')
-            if not isinstance(self,self.class_cache):
-                self.warning(f'change of execution class!')
-            #global level number
-
-            self.class_cache.level_number += 1     
-            self.class_cache.session._prob_levels[self.level_name] = self
-            
-            return self.class_cache.session
-        
-        #return New
-        self.class_cache.session = self
-        self.class_cache.level_number = 0
-
-        if self.log_level < 10:
-            refs = {k:v for k,v in self.sesh._sys_refs.get('attrs',{}).items() if v}
-            self.debug(f'creating execution context for {self.system}| {self._slv_kw}| {refs}')
-        
-        return self
-
-    def __exit__(self, exc_type, exc_value, traceback):
-        #define exit action, to handle the error here return True. Otherwise error propigates up to top level
-        self.exited = True
-        if self.log_level < 10:
-            self.debug(f'exit action {exc_type} {exc_value}')
-
-        #Last opprotunity to update the system  at tsate
-        if self.post_exec:
-            #a component cutsom callback + signals
-            self.post_execute()
-
-        if self.post_callback:
-            #a context custom callback
-            self.post_callback()
-
-        #save state to dataframe
-        if self.save_on_exit:
-            self.save_data()
-
-        #sesh = self.sesh #this should be here
-        #if self.level_name in sesh._prob_levels:
-        #    sesh._prob_levels.pop(self.level_name)
-
-        #Exit Scenerio (boolean return important for context manager exit handling in heirarchy)
-        if isinstance(exc_value,ProblemExit):
-            if self.log_level < 7:
-                self.debug(f'exit action {exc_type}| {exc_value.__dict__}')
-            
-            #first things first
-            if exc_value.revert:
-                self.revert_to_start()
-                if self.pre_exec:
-                    self.pre_execute()
-
-            lvl_match = False
-            #Decide our exit conditon (if we should exit)
-            if isinstance(exc_value,ProblemExitAtLevel):
-                #should we stop?
-                lvl_match = exc_value.level == self.level_name
-                if lvl_match:
-                    if self.log_level <= 11:
-                        self.debug(f'exit at level {exc_value}')
-                    ext = True                     
-                else:
-                    if self.log_level <= 5:
-                        self.msg(f'exit not at level {exc_value}')
-                    ext = False
-
-                #Check if we missed a level name and its the top level, if so then we raise a real error!
-                #always exit with level_name='top' at outer context
-                if not ext and self.class_cache.session is self and exc_value.level=='top':
-                    if self.log_level <= 11:
-                        self.debug(f'exit at top')
-
-                    ext = True #top override
-
-                elif self.class_cache.session is self and not ext:
-                    #never ever leave the top level without deleting the session
-                    self.class_cache.level_number = 0
-                    if type(self.problems_dict) is not dict:
-                        self.problems_dict.pop(self._problem_id,None)
-                    del self.class_cache.session 
-                    raise KeyError(f'cant exit to level! {exc_value.level} not found!!')
-            
-            else:
-                if self.log_level <= 18:
-                    self.info(f'problem exit revert={exc_value.revert}')
-
-                ext = True #basic exit is one level up
-            
-            self.clean_context()
-            if type(self.problems_dict) is not dict:
-                self.problems_dict.pop(self._problem_id,None)
-            return ext
-        
-        #default exit scenerios
-        elif exc_type is not None:
-            ext = self.error_action(exc_value)
-        else:
-            ext = self.exit_action()
-
-        self.clean_context()
-        if type(self.problems_dict) is not dict:
-            self.problems_dict.pop(self._problem_id,None)
-        return ext
-        
-

-[docs]
-    def debug_levels(self):
-        """debug the levels of the context"""
-        if hasattr(self.class_cache,'session'):
-            for k,v in self.class_cache.session._prob_levels.items():
-                self.info(f'level: {k} | {v} | {v.x_start}')
-
-        else:
-            raise IllegalArgument(f'no session available')

-
-    
-    #Multi Context Exiting:
-

-[docs]
-    def persist_contexts(self):
-        """convert all contexts to a new storage format"""
-        self.info(f'persisting contexts!')
-        current_problems = self.problems_dict 
-        ProblemExec.problems_dict = {}
-        for k,v in current_problems.items():
-            self.problems_dict[k] = v #you will go on!

-
-
-

-[docs]
-    def discard_contexts(self):
-        """discard all contexts"""
-        current_problems = self.problems_dict 
-        ProblemExec.problems_dict = weakref.WeakValueDictionary()
-        for k,v in current_problems.items():
-            ProblemExec.problems_dict[k] = v #you will go on!             

-
-
-

-[docs]
-    def reset_contexts(self,fail_if_discardmode=True):
-        """reset all contexts to a new storage format"""
-        if isinstance(self.problems_dict,dict):
-            ProblemExec.problems_dict = {}
-        elif fail_if_discardmode:
-            raise IllegalArgument(f'cant reset contexts! {self.problems_dict} while not in persistance mode')       

-
-
-    def exit_with_state(self):
-        raise ProblemExit(self,revert=False)
-    
-    def exit_and_revert(self):
-        raise ProblemExit(self,revert=True)
-
-    def exit_to_level(self,level:str,revert=False):
-        raise ProblemExitAtLevel(self,level=level,revert=revert)
-
-

-[docs]
-    def exit_action(self):
-        """handles the exit action wrt system"""
-        EOL =(self.class_cache.session is self or self.level_name == 'top')
-        if self.revert_last and EOL:
-            if self.log_level <= 8:
-                self.debug(f'revert last!')
-                self.debug(f'revert to{self.x_start}')
-            self.revert_to_start()
-            
-            #run execute
-            if self.pre_exec:
-                self.pre_execute()
-
-        elif self.revert_every:
-            if self.log_level <= 8:
-                self.debug(f'revert to{self.x_start}')
-            self.revert_to_start()
-            
-            #run execute 
-            if self.pre_exec:
-                self.pre_execute()
-
-        #TODO: add exit on success option
-        return True #continue as normal

-
-
-

-[docs]
-    def error_action(self,error):
-        """handles the error action wrt to the problem"""
-        if self.log_level <= 11:
-            self.debug(f' with input: {self.kwargs}')
-        
-        if self.fail_revert:
-            self.revert_to_start()
-
-        if self.exit_on_failure:
-            self.error(error,f'error in execution context')
-            return False #send me up
-        else:
-            self.warning(f'error in execution context: {error}')
-
-        return True #our problem will go on

-
-    
-
-

-[docs]
-    def save_data(self,index=None,force=False,**add_data):
-        """save data to the context"""
-        
-        sesh = self.sesh
-        if not self.exited and self.post_exec:
-            #a context custom callback
-                sesh.post_execute()
-
-        if force or not sesh.data or sesh.system.anything_changed:
-            out = sesh.output_state
-            if index is None and sesh._dxdt == True: #integration
-                index = sesh._time
-            elif index is None:
-                index = sesh._index
-
-            if add_data: out.update(add_data)
-            if sesh._dxdt==True: out['time'] = sesh._time
-            out['index'] = index
-            sesh._data[index] = out
-            #if we are integrating, then we dont increment the index
-            if sesh._dxdt != True:
-                sesh._index += 1
-            
-            #reset the data for changed items
-            sesh.system._anything_changed = False
-            self.debug(f'data saved = {index}')
-
-        elif self.log_level < 15:
-            self.warning(f'no data saved, nothing changed')

-
-
-    
-    def clean_context(self):
-        if hasattr(self.class_cache,'session') and self.class_cache.session is self:
-            if self.log_level <= 8:
-                self.debug(f'closing execution session')
-            self.class_cache.level_number = 0
-            del self.class_cache.session
-        elif hasattr(self.class_cache,'session'):
-            #global level number
-            self.class_cache.level_number -= 1  
-
-        #if we are the top level, then we mark the session runtime/messages
-        if self.session_id == True:
-            self._run_end = datetime.datetime.now()
-            self._run_time = self._run_end - self._run_start
-            if self.log_level <= 10:
-                self.debug(f"EXIT[{self.system.identity}] run time: {self._run_time}",lvl=5)
-
-    #time context
-    def set_time(self,time,dt):
-        self._last_time = lt = self._time
-        self._time = time
-        dt_calc = time - lt
-        self._dt = dt if dt_calc <= 0 else dt_calc
-        #self.system.set_time(time) #system times / subcomponents too
-        
-
-    def integrate(self,endtime,dt=0.001,max_step_dt=0.01,X0=None,**kw):
-        #Unpack Transient Problem
-        sesh = self.sesh
-        intl_refs = sesh.integrator_var_refs #order forms problem basis
-        sesh.prv_ingtegral_refs = intl_refs #for rate function
-        refs = sesh._sys_refs
-        system = sesh.system
-
-        min_kw = sesh._minimizer_kw
-        if min_kw is None: min_kw = {}
-
-        if dt > max_step_dt:
-            self.warning(f'dt {dt} > max_step_dt {max_step_dt}!')
-            dt = max_step_dt
-
-        if self.log_level < 15:
-            self.info(f'simulating {system},{sesh}| int:{intl_refs} | refs: {refs}' )            
-
-        if not intl_refs:
-            raise Exception(f'no transient parameters found')            
-        
-        x_cur = {k: v.value(sesh.system,sesh) for k, v in intl_refs.items()}
-
-        if self.log_level < 10:
-            self.debug(f'initial state {X0} {intl_refs}| {refs}')
-
-        if X0 is None:
-            # get current
-            X0 = x_cur
-        #add any missing solver vars existing in the system
-        if set(X0) != set(x_cur):
-            X0 = x_cur.update(X0) 
-        
-        #this will fail if X0 doesn't have solver vars!
-        X0 = np.array([X0[p] for p in intl_refs])
-        Time = np.arange(sesh.system.time, endtime + dt, dt)
-
-        rate_kw = {'min_kw':min_kw,'dt':dt}
-
-        #get the probelem variables
-        Xss = sesh.problem_opt_vars
-        Yobj = sesh.final_objectives
-
-        #run the simulation from the current state to the endtime
-        ans = solve_ivp(sesh.integral_rate, [sesh.system.time, endtime], X0, method="RK45", t_eval=Time, max_step=max_step_dt,args=(dt,Xss,Yobj),**kw)
-
-        print(ans)
-
-        return ans
-
-

-[docs]
-    def integral_rate(self,t, x, dt,Xss=None,Yobj=None, **kw):
-        """provides the dynamic rate of the system at time t, and state x"""
-        sesh = self.sesh
-        intl_refs = sesh.prv_ingtegral_refs #cached in self.integral()
-        refs = sesh._sys_refs
-        system = sesh.system
-
-        out = {p: np.nan for p in intl_refs}
-        Xin = {p: x[i] for i, p in enumerate(intl_refs)}
-
-        if self.log_level < 10:
-            self.info(f'sim_iter {t} {x} {Xin}')
-
-        with ProblemExec(system,level_name='tr_slvr',Xnew=Xin,revert_last=False,revert_every=False,dxdt=True) as pbx:
-            # test for record time 
-            
-            self.set_time(t,dt)
-            
-            #save data at the start
-            pbx.save_data() #TODO: check_enable/ rate_check
-
-            #ad hoc time integration
-            for name, trdct in pbx.integrators.items():
-                if self.log_level <=10:
-                    
-                    self.info(f'updating {trdct.var}|{trdct.var_ref.value(self.system,self)}<-{trdct.rate}|{trdct.current_rate}|{trdct.rate_ref.value(self.system,self)}')
-                    print( getattr(self.system,trdct.var,None))
-                    print( getattr(self.system,trdct.rate,None))
-                        
-                out[trdct.var] = trdct.current_rate
-
-            # dynamics
-            for compnm, compdict in pbx.dynamic_comps.items():
-                comp = compdict#["comp"]
-                if not comp.dynamic_state_vars and not comp.dynamic_input_vars:
-                    continue #nothing to do...
-
-                Xds = np.array([r.value() for r in comp.Xt_ref.values()])
-                Uds = np.array([r.value() for r in comp.Ut_ref.values()])
-                # time updated in step
-                #system.info(f'comp {comp} {compnm} {Xds} {Uds}')
-                dxdt = comp.step(t, dt, Xds, Uds, True)
-
-                for i, (p, ref) in enumerate(comp.Xt_ref.items()):
-                    out[(f"{compnm}." if compnm else "") + p] = dxdt[i]
-
-            #solvers
-            if self.run_solver  and Xss and Yobj and self.solveable:
-                # TODO: add in any transient
-                with ProblemExec(system,level_name='ss_slvr',revert_last=False,revert_every=False,dxdt=True) as pbx:
-
-                    ss_out = pbx.solve_min(Xss, Yobj, **self._minimizer_kw)
-                    if ss_out['ans'].success:
-                        if self.log_level <= 9:
-                            self.info(f'exiting solver {t} {ss_out["Xans"]} {ss_out["Xstart"]}')             
-                        pbx.set_ref_values(ss_out['Xans'])
-                        pbx.exit_to_level('ss_slvr',False)
-                    else:
-                        self.warning(f'solver failed to converge {ss_out["ans"].message} {ss_out["Xans"]} {ss_out["X0"]}')
-                        if pbx.opt_fail:
-                            pbx.exit_to_level('sim',pbx.fail_revert)
-                        else:
-                            pbx.exit_to_level('ss_slvr',pbx.fail_revert)
-
-            V_dxdt =  np.array([out[p] for p in intl_refs])
-            if self.log_level <= 10:
-                self.info(f'exiting transient {t} {V_dxdt} {Xin}')
-            pbx.exit_to_level('tr_slvr',False)
-
-        if any( np.isnan(V_dxdt) ):
-            self.warning(f'solver got infeasible: {V_dxdt}|{Xin}')
-            pbx.exit_and_revert()
-            #TODO: handle this better, seems to cause a warning
-            raise ValueError(f'infeasible! nan result {V_dxdt} {out} {Xin}')
-        
-        elif self.log_level <= 5:
-            self.debug(f'rate {self._dt} {t:5.3f}| {x}<-{V_dxdt} {Xin}')
-
-        return V_dxdt

-
-
-

-[docs]
-    def solve_min(
-        self,Xref=None,Yref=None,output=None,**kw
-    ):
-        """
-        Solve the minimization problem using the given vars and constraints. And sets the system state to the solution depending on input of the following:
-
-        Solve the root problem using the given vars.
-        :param Xref: The reference input values.
-        :param Yref: The reference objective values to minimize.
-        :param output: The output dictionary to store the results. (default: None)
-        :param fail: Flag indicating whether to raise an exception if the solver doesn't converge. (default: True)
-        :param kw: Additional keyword arguments.
-        :return: The output dictionary containing the results.
-        """ 
-        sesh = self.sesh
-        if Xref is None:
-            Xref = sesh.Xref
-
-        if Yref is None:
-            Yref = sesh.final_objectives
-
-        thresh = kw.pop("thresh", sesh.success_thresh)
-
-        #TODO: options for solver detail in response
-        dflt = {
-                "Xstart": Ref.refset_get(Xref,sys=sesh.system,prob=sesh),
-                "Ystart": Ref.refset_get(Yref,sys=sesh.system,prob=sesh),
-                "Xans": None,
-                "success": None,
-                "Xans":None,
-                "Yobj":None,
-                "Ycon":None,
-                "ans": None,
-                "weights":sesh._weights,
-                "constraints":sesh.constraints,
-            }
-
-        if output:
-            dflt.update(output)
-            output = dflt
-        else:
-            output = dflt
-
-        if len(Xref) == 0:
-            self.info(f'no variables found for solver: {kw}')
-            #None for `ans` will not trigger optimization failure        
-            return output
-        
-        #override constraints input
-        kw.update(sesh.constraints)
-
-        if len(kw['bounds']) != len(Xref):
-            raise ValueError(f"bounds {len(sesh.constraints['bounds'])} != Xref {len(Xref)}")
-
-        if self.log_level < 10:
-            self.debug(f"minimize {Xref} {Yref} {kw}")
-        
-        if sesh._weights is not None:
-            kw['weights'] = sesh._weights
-
-        sesh._ans = refmin_solve(sesh.system,self,Xref, Yref, **kw)
-        output["ans"] = sesh._ans
-
-        sesh.handle_solution(sesh._ans,Xref,Yref,output)
-
-        return output

-
-
-    def handle_solution(self,answer,Xref,Yref,output):
-        #TODO: move exit condition handiling somewhere else, reduce cross over from process_ans
-        sesh = self.sesh
-        
-        thresh = sesh.success_thresh
-        vars = list(Xref)
-
-        #Output Results
-        Xa = {p: answer.x[i] for i, p in enumerate(vars)}
-        output["Xans"] = Xa
-        Ref.refset_input(Xref,Xa)
-
-        Yout = {p: Yref[p].value(sesh.system,self) for p in Yref}
-        output["Yobj"] = Yout
-
-        Ycon = {}
-        if sesh.constraints['constraints']:
-            x_in = answer.x
-            for c,k in zip(sesh.constraints['constraints'],sesh.constraints['info']):
-                cv = c['fun'](x_in,self,{})
-                Ycon[k] = cv
-        output['Ycon'] = Ycon   
-
-        de = answer.fun
-        if answer.success and de < thresh if thresh else True:
-            sesh.system._converged = True #TODO: put in context
-            output["success"] = True
-
-        elif answer.success:
-            # out of threshold condition
-            self.warning(
-                f"solver didnt meet threshold: {de} <? {thresh} ! {answer.x} -> residual: {answer.fun}"
-            )
-            sesh.system._converged = False
-            output["success"] = False  # only false with threshold
-
-        else:
-            sesh.system._converged = False
-            if self.opt_fail:
-                raise Exception(f"solver didnt converge: {answer}")
-            else:
-                self.warning(f"solver didnt converge: {answer}")
-            output["success"] = False
-    
-        return output 
-
-    #Solver Parsing Methods
-    
-

-[docs]
-    def sys_solver_objectives(self,**kw):
-        """gathers variables from solver vars, and attempts to locate any input_vars to add as well. use exclude_vars to eliminate a variable from  the solver
-        """
-        sys_refs = self.sesh._sys_refs
-
-        #Convert result per kind of objective (min/max ect)
-        objs = sys_refs.get('attrs',{}).get('solver.obj',{})
-        return {k:v for k,v in objs.items()}

-
-    
-

-[docs]
-    def pos_obj(self,ref):
-        """converts an objective to a positive value"""
-        def f(sys,prob):
-            return (1+ref.value(sys,prob)**2)
-        
-        return ref.copy(key=f)

-
-
-    @property
-    def final_objectives(self)->dict:
-        """returns the final objective of the system"""
-        sesh = self.sesh
-        Yobj = sesh.problem_objs
-        Yeq = sesh.problem_eq
-        Xss = sesh.problem_opt_vars
-        if Yobj:
-            return Yobj #here is your application objective, sir
-        
-        #now make up an objective
-        elif not Yobj and Yeq:
-            #TODO: handle case of Yineq == None with root solver
-            self.info(f'making Yobj from Yeq: {Yeq}')
-            Yobj = { k: self.pos_obj(v) for k,v in Yeq.items() }
-
-        elif not Yobj:
-            #minimize the product of all vars, so the smallest value is the best that satisfies all constraints
-            if self.session_id == True:
-                self.info(f'making Yobj from X: {Xss}')
-            def dflt(sys,prob)->float:
-                out = 1
-                for k,v in prob.problem_opt_vars.items():
-                    val = v.value(sys,prob)
-                    # The code snippet is calculating the linear norm of positive
-                    # values greater than 1 by adding the square root of the sum
-                    # of 1 and the square of the value to the variable `out`. This
-                    # operation is intended to apply a large penalty to positive
-                    # values greater than 1.
-                    out = out + (1+val**2)**0.5 #linear norm of positive values > 1 should be very large penalty 
-                return 1
-            
-            Yobj = {'smallness': Ref(sesh.system, dflt)}
-        return Yobj #our residual based objective
-
-

-[docs]
-    def sys_solver_constraints(self,add_con=None,combo_filter=True, **kw):
-        """formatted as arguments for the solver
-        """
-        from engforge.solver_utils import create_constraint
-        sesh = self.sesh
-        Xrefs = sesh.Xref
-
-        system = sesh.system
-        sys_refs = sesh._sys_refs
-        all_refz = sesh.ref_attrs
-
-        extra_kw = self.kwargs
-        
-        #TODO: move to kwarg parsing on setup
-        deactivated = ext_str_list(extra_kw,'deactivate',[]) if 'deactivate' in extra_kw and extra_kw['deactivate'] else []
-        activated = ext_str_list(extra_kw,'activate',[]) if 'activate' in extra_kw and  extra_kw['activate'] else []
-
-        slv_inst = sys_refs.get('type',{}).get('solver',{})
-        trv_inst = {v.var:v for v in sys_refs.get('type',{}).get('time',{}).values()}
-        sys_refs = sys_refs.get('attrs',{})
-
-        if add_con is None:
-            add_con = {}
-        
-
-        #The official definition of X var order
-        Nstates = len(Xrefs)
-        Xvars = list(Xrefs) #get names of solvers + dynamics
-
-        # constraints lookup
-        bnd_list = [[None, None]] * Nstates
-        con_list = []
-        con_info = [] #names of constraints 
-        constraints = {"constraints": con_list, "bounds": bnd_list,"info":con_info}
-        
-
-        if isinstance(add_con, dict):
-            # Remove None Values
-            nones = {k for k, v in add_con.items() if v is None}
-            for ki in nones:
-                constraints.pop(ki, None)
-            assert all(
-                [callable(v) for k, v in add_con.items()]
-            ), f"all custom input for constraints must be callable with X as argument"
-            constraints["constraints"].extend(
-                [v for k, v in add_con.items() if v is not None]
-            )
-
-        if add_con is False:
-            constraints = {} #youre free!
-            return constraints
-        
-        # Add Constraints
-        ex_arg = {"con_args": (),**kw}
-        
-        #Variable limit (function -> ineq, numeric -> bounds)
-        #TODO: dynamic limits
-        for slvr, ref in sesh.problem_opt_vars.items():
-            #TODO: solution to this is to combine the independent variables into one, but allow multiple dependent objectives for constraints/objectives
-            assert not all((slvr in slv_inst,slvr in trv_inst)), f'solver and integrator share parameter {slvr} '
-            if slvr in slv_inst:
-                slv = slv_inst[slvr]
-                slv_var = True #mark a static varible
-            elif slvr in trv_inst:
-                slv = trv_inst[slvr]
-                slv_var = False #a dynamic variable
-            else:
-                self.warning(f'no solver instance for {slvr} ')
-                continue
-            
-            slv_constraints = slv.constraints
-            if log.log_level < 7:
-                self.debug(f'constraints {slvr} {slv_constraints}')
-                
-            for ctype in slv_constraints:
-                cval = ctype['value']
-                kind = ctype['type']       
-                var = ctype['var']
-                if log.log_level < 3:
-                    self.msg(f'const: {slvr} {ctype}')
-
-                if cval is not None and slvr in Xvars:
-                    
-                    #Check for combos & activation
-                    combos = None
-                    if 'combos' in ctype:
-                        combos = ctype['combos']
-                        combo_var = ctype['combo_var']
-                        active = ctype.get('active',True)
-                        in_activate = any([arg_var_compare(combo_var,v) for v in activated]) if activated else False
-                        in_deactivate = any([arg_var_compare(combo_var,v) for v in deactivated]) if deactivated else False
-
-                        if log.log_level <= 5:
-                            self.debug(f'filter combo: {ctype}=?{extra_kw}') 
-
-                        #Check active or activated
-                        if not active and not activated:
-                            if log.log_level < 3:
-                                self.msg(f'skip con: inactive {var} {slvr} {ctype}')
-                            continue
-
-                        elif not active and not in_activate:
-                            if log.log_level < 3:
-                                self.msg(f'skip con: inactive {var} {slvr} {ctype}')
-                            continue
-
-                        elif active and in_deactivate:
-                            if log.log_level < 3:
-                                self.msg(f'skip con: deactivated {var} {slvr} ')
-                            continue
-
-                    if combos and combo_filter:
-                        filt = filter_combos(combo_var,slv, extra_kw,combos)
-                        if not filt:
-                            if log.log_level < 5:
-                                self.debug(f'filtering constraint={filt} {var} |{combos}')  
-                            continue
-                    
-                    if log.log_level < 10:
-                        self.debug(f'adding var constraint {var,slvr,ctype,combos}') 
-
-                    #get the index of the variable
-                    x_inx = Xvars.index(slvr)        
-                    
-                    #lookup rates for overlapping dynamic variables
-                    rate_val = None
-                    if sesh._dxdt is not None:
-                        if isinstance(sesh._dxdt,dict) and not slv_var:
-                            rate_val = sesh._dxdt.get(slvr,0)
-                        elif not slv_var:
-                            rate_val = 0
-
-                    #add the dynamic parameters when configured
-                    if not slv_var and rate_val is not None:
-                        #print(f'adding dynamic constraint {slvr} {rate_val}')
-                        #if kind in ('min','max') and slvr in Xvars:
-                        varref = Xrefs[slvr]
-                        #varref = slv.rate_ref
-                        #Ref Case
-                        ccst = ref_to_val_constraint(system,system.last_context,Xrefs,varref,kind,rate_val,**kw)
-                        #con_list.append(ccst)
-                        con_info.append(f'dxdt_{varref.comp.classname}.{slvr}_{kind}_{cval}')
-                        con_list.append(ccst) 
-
-                    # elif slv_var:                       
-                    elif slv_var:
-                        #establish simple bounds w/ solver  
-                        if ( 
-                            kind in ("min", "max")
-                            and slvr in Xvars
-                            and isinstance(cval, (int, float))
-                        ):
-                            minv, maxv = bnd_list[x_inx]
-                            bnd_list[x_inx] = [
-                                cval if kind == "min" else minv,
-                                cval if kind == "max" else maxv,
-                                ]
-                                
-                        #add the bias of cval to the objective function
-                        elif  kind in ('min','max') and slvr in Xvars:
-                            varref = Xrefs[slvr]
-                            #Ref Case
-                            ccst = ref_to_val_constraint(system,system.last_context,Xrefs,varref,kind,cval,**kw)
-                            con_info.append(f'val_{ref.comp.classname}_{kind}_{slvr}')
-                            con_list.append(ccst)
-
-                        else:
-                            self.warning(f"bad constraint: {cval} {kind} {slv_var}|{slvr}")
-
-        # Add Constraints
-        for slvr, ref in self.problem_ineq.items():
-            slv = slv_inst[slvr]
-            slv_constraints = slv.constraints
-            parent= self.get_parent_key(slvr,look_back_num=2) #get the parent comp
-            for ctype in slv_constraints:
-                cval = ctype['value']
-                kind = ctype['type']                    
-                if cval is not None:
-                    name = f'ineq_{parent}{ref.comp.classname}.{slvr}_{kind}_{cval}'
-                    if log.log_level < 5:
-                        self.debug(f'filtering constraint {slvr} |{name}')
-                    con_info.append(name)
-                    con_list.append(
-                        create_constraint(
-                            system,Xrefs, 'ineq', cval, **kw
-                        )
-                    )
-
-        for slvr, ref in self.problem_eq.items():
-            parent= self.get_parent_key(slvr,look_back_num=2) #get the parent comp
-            if slvr in slv_inst and slvr in all_refz.get('solver.eq',{}):
-                slv = slv_inst[slvr]
-                slv_constraints = slv.constraints
-                
-                for ctype in slv_constraints:
-                    cval = ctype['value']
-                    kind = ctype['type']                    
-                    if cval is not None:
-                        name = f'eq_{parent}{ref.comp.classname}.{slvr}_{kind}_{cval}'
-                        if log.log_level < 5:
-                            self.debug(f'filtering constraint {slvr} |{name}')
-                        con_info.append(name)                        
-                        con_info.append(f'eq_{parent}{ref.comp.classname}.{slvr}_{kind}_{cval}')
-                        con_list.append(
-                            create_constraint(
-                                system,Xrefs, 'eq', cval, **kw
-                            )
-                        )
-            else:
-                #This must be a dynamic rate
-                self.debug(f'dynamic rate eq {slvr} ')
-                con_info.append(f'eq_{parent}{ref.comp.classname}.{slvr}_rate')
-                con_list.append(
-                    create_constraint(
-                        system,Xrefs, 'eq', ref, **kw
-                    )
-                )
-                
-
-
-        return constraints 

-
-
-    # General method to distribute input to internal components
-

-[docs]
-    @classmethod
-    def parse_default(self,key,defaults,input_dict,rmv=False,empty_str=True):
-        """splits strings or lists and returns a list of options for the key, if nothing found returns None if fail set to True raises an exception, otherwise returns the default value"""
-        if key in input_dict:
-            #kwargs will no longer have key!
-            if not rmv:
-                option = input_dict.get(key)
-            else:
-                option = input_dict.pop(key)
-            #print(f'removing option {key} {option}')
-            if option is None:
-                return option,False
-            
-            elif isinstance(option,(int,float,bool)):
-                return option,False
-            
-            elif isinstance(option,str):
-                if not empty_str and not option:
-                     return None,False
-                
-                option = option.split(',')
-                    
-            return option,False
-        
-        elif key in defaults:
-            return defaults[key],True
-        
-        return None,None

-
-        
-
-

-[docs]
-    @classmethod
-    def get_extra_kws(cls,kwargs,_check_keys:dict=slv_dflt_options,rmv=False,use_defaults=True):
-        """extracts the combo input from the kwargs"""
-        # extract combo input
-        if not _check_keys:
-            return {}
-        _check_keys = _check_keys.copy()
-        #TODO: allow extended check_keys / defaults to be passed in, now every value in check_keys has a default
-        cur_in = kwargs
-        output = {}
-        for p,dflt in _check_keys.items():
-            val,is_dflt = cls.parse_default(p,_check_keys,cur_in,rmv=rmv)
-            if not is_dflt:
-                output[p] = val
-            elif use_defaults:
-                output[p] = val
-            if rmv:
-                cur_in.pop(p,None)
-
-        #copy from data
-        filtr = dict(list(filter(lambda kv: kv[1] is not None or kv[0] in _check_keys, output.items())))
-        #print(f'got {combos} -> {comboos} from {kwargs} with {_check_keys}')
-        return filtr    

-
-
-    #State Interfaces
-    @property
-    def record_state(self)->dict:
-        """records the state of the system using session"""
-        #refs = self.all_variable_refs
-        sesh = self.sesh
-        refs = sesh.all_comps_and_vars #no need for properties
-        return Ref.refset_get(refs,sys=sesh.system,prob=self)
-
-    @property
-    def output_state(self)->dict:
-        """records the state of the system"""
-        sesh = self.sesh
-        #TODO: add system_properties to num_refs / all_system_refs ect.
-        if 'nums' == sesh.save_mode:
-            refs = sesh.num_refs
-        elif 'all' == sesh.save_mode:
-            refs = sesh.all_system_references
-        elif 'vars' == sesh.save_mode:
-            refs = self.all_variable_refs
-        elif 'prob' == sesh.save_mode:
-            raise NotImplementedError(f'problem save mode not implemented')
-        else:
-            raise KeyError(f'unknown save mode {sesh.save_mode}, not in {save_modes}')
-
-        out = Ref.refset_get(refs,sys=sesh.system,prob=self)
-        #Integration
-        if sesh._dxdt == True:
-            out['time'] = sesh._time
-
-        return out
-    
-    
-

-[docs]
-    def get_ref_values(self,refs=None):
-        """returns the values of the refs"""
-        sesh = self.sesh
-        if refs is None:
-            refs = sesh.all_system_references
-        return Ref.refset_get(refs,sys=self.system,prob=self)

-
-    
-

-[docs]
-    def set_ref_values(self,values,refs=None):
-        """returns the values of the refs"""
-        #TODO: add checks for the refs
-        sesh = self.sesh
-        if refs is None:
-            refs = sesh.all_comps_and_vars        
-        return Ref.refset_input(refs,values)    

-
-
-

-[docs]
-    def set_checkpoint(self):
-        """sets the checkpoint"""
-        self.x_start = self.record_state
-        if log.log_level <= 7:
-            self.debug(f'set checkpoint: {list(self.x_start.values())}')

-
-
-    def revert_to_start(self):
-        sesh = self.sesh
-        if log.log_level < 5:
-            xs = list(self.x_start.values())
-            rs = list(self.record_state.values())
-            self.debug(f'reverting to start: {xs} -> {rs}')
-        #TODO: STRICT MODE Fail for refset_input
-        Ref.refset_input(sesh.all_comps_and_vars,self.x_start,fail=False)
-
-    def activate_temp_state(self,new_state=None):
-        #TODO: determine when components change, and update refs accordingly!
-        sesh = self.sesh
-        #TODO: STRICT MODE Fail for refset_input
-        if new_state:
-            if self.log_level < 3: self.debug(f'new-state: {self.temp_state}')
-            Ref.refset_input(sesh.all_comps_and_vars,new_state,fail=False)
-        elif self.temp_state:
-            if self.log_level < 3: self.debug(f'act-state: {self.temp_state}')
-            Ref.refset_input(sesh.all_comps_and_vars,self.temp_state,fail=False)
-        elif self.log_level < 3:
-            self.debug(f'no-state: {new_state}')
-
-        #initial establishment costs / ect
-        if sesh.pre_exec:
-            sesh.pre_execute()                
-        
-
-    #System Events
-

-[docs]
-    def apply_pre_signals(self):
-        """applies all pre signals"""
-        msg_lvl = self.log_level <= 2
-        if self.log_level < 5:
-            self.msg(f"applying pre signals",lvl=6)
-        for signame, sig in self.sesh.signals.items():
-            if sig.mode == "pre" or sig.mode == "both":
-                if msg_lvl:
-                    self.msg(f"applying post signals: {signame}",lvl=3)                
-                sig.apply()

-
-
-

-[docs]
-    def apply_post_signals(self):
-        """applies all post signals"""
-        msg_lvl = self.log_level <= 2
-        if self.log_level < 5:
-            self.msg(f"applying post signals",lvl=6)        
-        for signame, sig in self.sesh.signals.items():
-            if sig.mode == "post" or sig.mode == "both":
-                if msg_lvl:
-                    self.msg(f"applying post signals: {signame}",lvl=3)
-                sig.apply()

-
-
-

-[docs]
-    def update_system(self,*args,**kwargs):
-        """updates the system"""
-        for ukey,uref in self.sesh._update_refs.items():
-            self.debug(f'context updating {ukey}')
-            uref.value(*args,**kwargs)

-
-
-

-[docs]
-    def post_update_system(self,*args,**kwargs):
-        """updates the system"""
-        for ukey,uref in  self.sesh._post_update_refs.items():
-            self.debug(f'context post updating {ukey}')
-            uref.value(*args,**kwargs)

-
-
-

-[docs]
-    def pre_execute(self,*args,**kwargs):
-        """Updates the pre/both signals after the solver has been executed. This is useful for updating the system state after the solver has been executed."""
-        if log.log_level < 5:
-            self.msg(f"pre execute")
-
-        sesh = self.sesh
-        sesh.apply_pre_signals()
-        sesh.update_system(*args,**kwargs)

-
-
-
-

-[docs]
-    def post_execute(self,*args,**kwargs):
-        """Updates the post/both signals after the solver has been executed. This is useful for updating the system state after the solver has been executed."""
-        if log.log_level < 5:
-            self.msg(f"post execute")
-
-        sesh = self.sesh
-        sesh.apply_post_signals()
-        sesh.post_update_system(*args,**kwargs)

-
-
-    
-
-
-    #Logging to class logger
-    @property
-    def identity(self):
-        return f'PROB|{str(self.session_id)[0:5]}'
-
-    @property
-    def log_level(self):
-        return log.log_level
-
-    def msg(self,msg,*a,**kw):
-        if log.log_level < 5:
-            log.msg(f'{self.identity}|[{self.level_number}-{self.level_name}]  {msg}',*a,**kw)
-
-    def debug(self,msg,*a,**kw):
-        if log.log_level <= 15:
-            log.debug(f'{self.identity}|[{self.level_number}-{self.level_name}]  {msg}',*a,**kw)
-
-    def warning(self,msg,*a,**kw):
-        log.warning(f'{self.identity}|[{self.level_number}-{self.level_name}]  {msg}',*a,**kw)
-
-    def info(self,msg,*a,**kw):
-        log.info(f'{self.identity}|[{self.level_number}-{self.level_name}]  {msg}',*a,**kw)
-
-    def error(self,error,msg,*a,**kw):
-        log.error(error,f'{self.identity}|[{self.level_number}-{self.level_name}]  {msg}',*a,**kw)        
-
-    def critical(self,msg,*a,**kw):
-        log.critical(f'{self.identity}|[{self.level_number}-{self.level_name}]  {msg}',*a,**kw)
-
-    #Safe Access Methods
-    @property
-    def ref_attrs(self):
-        return self.sesh._sys_refs.get('attrs',{}).copy()
-
-    @property
-    def attr_inst(self):
-        return self.sesh._sys_refs.get('type',{}).copy()
-    
-    @property
-    def dynamic_comps(self):
-        return self.sesh._sys_refs.get('dynamic_comps',{}).copy()
-    
-    #Instances
-    @property
-    def integrators(self):
-        return self.attr_inst.get('time',{}).copy()
-    
-    @property
-    def signal_inst(self):
-        return self.attr_inst.get('signal',{}).copy()
-
-    @property
-    def solver_inst(self):
-        return self.attr_inst.get('solver',{}).copy()
-
-    @property
-    def kwargs(self):
-        """copy of slv_kw args"""
-        return self.sesh._slv_kw.copy()
-
-
-    @property
-    def dynamic_state(self):
-        return self.ref_attrs.get('dynamics.state',{}).copy()
-    
-    @property
-    def dynamic_rate(self):
-        return self.ref_attrs.get('dynamics.rate',{}).copy()    
-    
-    @property
-    def problem_input(self):
-        return self.ref_attrs.get('dynamics.input',{}).copy()      
-
-    @property
-    def integrator_vars(self):
-        return self.ref_attrs.get('time.var',{}).copy()
-    
-    @property
-    def integrator_rates(self):
-        return self.ref_attrs.get('time.rate',{}).copy()
-    
-    #Y solver variables
-    @property
-    def problem_objs(self):
-        return self.ref_attrs.get('solver.obj',{}).copy()   
-
-    @property
-    def problem_eq(self):
-        base_eq = self.ref_attrs.get('solver.eq',{}).copy()
-        if self._dxdt in [True,None] or self._dxdt is False:
-            return base_eq #wysiwyg
-        base_eq.update(self.dynamic_rate_eq)
-        
-        if len(base_eq) > len(self.Xref):
-            self.warning(f'problem_eq has more items than variables {base_eq} {self.Xref}')
-            #TODO: in this case combine the rate_eq to prevent this error
-
-        return base_eq
-        
-
-    @property
-    def dynamic_rate_eq(self):
-        #Add Dynamics Rate Equalities
-        base_eq = {}
-        if self._dxdt in [True,None] or self._dxdt is False: #zero case
-            return base_eq
-        
-        Xrefs = self.Xref
-        system = self.system
-        #henceforth, the rate shall be equal to somethign!
-        base_eq.update(self.dynamic_rate)
-        base_eq.update(self.filter_vars(self.integrator_rates))
-        out = {}
-        #TODO: handle callable case
-        if self._dxdt is not None and (isinstance(self._dxdt,dict) or abs(self._dxdt) > 0):
-            #add in the dynamic rate constraints
-            for var,varref in base_eq.items():
-                if (isinstance(self._dxdt,dict) and var in self._dxdt):
-                    rate_val = self._dxdt.get(var,0) #zero default rate
-                elif isinstance(self._dxdt,(int,float)):
-                    rate_val = self._dxdt
-                    con_ref = ref_to_val_constraint(system,system.last_context,Xrefs,varref,'min',rate_val,return_ref=True)
-                    out[var] = con_ref
-                else:
-                    out[var] = varref #zip rate
-        else:
-            #thou shalt be zero (no ref modifications)
-            out = base_eq
-
-        return out      
-    
-    @property
-    def problem_ineq(self):
-        return self.ref_attrs.get('solver.ineq',{}).copy()
-    
-    @property
-    def signals_source(self):
-        return self.ref_attrs.get('signal.source',{}).copy()
-    
-    @property
-    def signals_target(self):
-        return self.ref_attrs.get('signal.target',{}).copy()
-
-    @property
-    def signals(self):
-        return self.ref_attrs.get('signal.signal',{}).copy()
-
-    #formatted output
-    @property
-    def is_active(self):
-        """checks if the context has been entered and not exited"""
-        return self.entered and not self.exited
-    
-    @property
-    def solveable(self):
-        """checks the system's references to determine if its solveabl"""
-        if self.sesh.problem_opt_vars:
-            #TODO: expand this
-            return True
-        return False
-
-    @property
-    def integrator_rate_refs(self):
-        """combine the dynamic state and the integrator rates to get the transient state of the system, but convert their keys to the target var names """
-        dc  = self.dynamic_state.copy()
-        for int_name,intinst in self.integrators.items():
-            if intinst.var in dc:
-                raise KeyError(f'conflict with integrator name {intinst.var} and dynamic state')
-            dc.update({intinst.var:intinst.rate_ref})
-        return dc
-    
-    @property
-    def integrator_var_refs(self):
-        """combine the dynamic state and the integrator rates to get the transient state of the system, but convert their keys to the target var names """
-        dc  = self.dynamic_state.copy()
-        for int_name,intinst in self.integrators.items():
-            if intinst.var_ref in dc:
-                raise KeyError(f'conflict with integrator name {intinst.var_ref} and dynamic state')
-            dc.update({intinst.var:intinst.var_ref})
-        return dc    
-    
-    #Dataframe support
-
-    @property
-    def dataframe(self)->pd.DataFrame:
-        """returns the dataframe of the system"""
-        sesh = self.sesh
-        res = pd.DataFrame([kv[-1] for kv in sorted(sesh.data.items(),
-                                                   key=lambda kv:kv[0]) ])
-        self.system.format_columns(res)
-        return res
-
-    #TODO: expose optoin for saving all or part of the system information, for now lets default to all (saftey first, then performance :)
-

-[docs]
-    def get_parent_key(self,key,look_back_num=1):
-        """returns the parent key of the key"""
-        if not key:
-            return ''
-        elif key.count('.') >= look_back_num:
-            return '.'.join(key.split('.')[:-look_back_num])+'.'
-        return ''

-
-        
-    #Dynamics Interface
-

-[docs]
-    def filter_vars(self,refs:list):
-        '''selects only settable refs'''
-        return {f'{self.get_parent_key(k)}{v.key}':v for k,v in refs.items() if v.allow_set}   

-
-
-    #X solver variable refs
-    @property
-    def problem_opt_vars(self)->dict:
-        """solver variables"""
-        return self.ref_attrs.get('solver.var',{}).copy()
-    
-    @property
-    def all_problem_vars(self)->dict:
-        """solver variables + dynamics states when dynamic_solve is True"""
-        varx = self.ref_attrs.get('solver.var',{}).copy()
-        #Add the dynamic states to be optimized (ignore if integrating)
-        sesh = self.sesh
-        if sesh.dynamic_solve and not sesh._dxdt is True:
-            varx.update(sesh.dynamic_state)
-            varx.update(self.filter_vars(sesh.integrator_vars))
-
-        return varx
-
-    @property
-    def dynamic_solve(self)->bool:
-        """indicates if the system is dynamic"""
-        sesh = self.sesh
-        dxdt = sesh._dxdt
-
-        if dxdt is None or dxdt is False:
-            return False
-        
-        if dxdt is True:
-            return True
-        
-        in_type = isinstance(dxdt,(dict,float,int))
-        bool_type = (isinstance(dxdt,bool) and dxdt == True)
-        if in_type or bool_type:
-            return True
-        
-        return False
-
-    @property
-    def all_variable_refs(self)->dict:
-        sesh = self.sesh
-        ing = self.integrator_vars
-        stt = self.dynamic_state
-        vars = self.problem_opt_vars
-        return {**ing,**stt,**vars}
-    
-    @property
-    def all_variables(self)->dict:
-        """returns all variables in the system"""
-        return self.all_refs['attributes']
-    
-    @property
-    def all_comps(self)->dict:
-        """returns all variables in the system"""
-        return self.all_refs['components']
-    
-    @property
-    def all_components(self)->dict:
-        """returns all variables in the system"""
-        return self.all_refs['components']
-
-    @property
-    def all_comps_and_vars(self)->dict:
-        #TODO: ensure system refes are fresh per system runtime events
-        sesh = self.sesh
-        refs = sesh.all_refs
-        attrs = refs['attributes'].copy()
-        comps = refs['components'].copy()
-        attrs.update(comps)
-        return attrs
-    
-    @property
-    def all_system_references(self)->dict:
-        sesh = self.sesh
-        refs = sesh.all_refs
-        out = {}
-        out.update(refs['attributes'])
-        out.update(refs['properties'])
-        return out
-    
-    def __str__(self):
-        #TODO: expand this
-        return f'ProblemContext[{self.level_name:^12}][{str(self.session_id)[0:8]}-{str(self._problem_id)[0:8]}][{self.system.identity}]'

-
-    
-
-#TODO: move all system_reference concept inside problem context, remove from system/tabulation ect.
-#TODO: use prob.register/change(comp,key='') to add components to the problem context, mapping subcomponents to the problem context
-#TODO: make a graph of all problem dependencies and use that to determine the order of operations, and subsequent updates.
-
-    
-#subclass before altering please!
-ProblemExec.class_cache = ProblemExec
-
-

-[docs]
-class Problem(ProblemExec,DataframeMixin):
-    #TODO: implement checks to ensure that problem is defined as the top level context to be returned to
-    #TODO: also define return options for data/system/dataframe and indexing
-    pass
-
-    @property
-    def level_name(self):
-        return 'top' #fixed top output, garuntees exit to here.
-    
-    @level_name.setter
-    def level_name(self,value):
-        raise AttributeError(f'cannot set level_name of top level problem context')

-
-
-
-
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/properties.html b/docs/_build/html/_modules/engforge/properties.html deleted file mode 100644 index 10f3b2b..0000000 --- a/docs/_build/html/_modules/engforge/properties.html +++ /dev/null @@ -1,635 +0,0 @@ - - - - - - engforge.properties — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.properties

-"""
-Like typical python properties, normal functions are embelished with additional functionality.
-
-`system_properties` is a core function that adds meta information to a normal python property to include its output in the results. It is the "y" in y=f(x).
-
-`class_cache` a subclassing safe property that stores the result at runtime
-
-`solver_cache` a property that is recalculated any time there is an update to any attrs variable.
-"""
-import os
-from engforge.logging import LoggingMixin
-from engforge.typing import TABLE_TYPES
-
-IS_BUILD = os.environ.get('SPHINX_BUILD','false').strip().lower() == 'true'
-
-
-

-[docs]
-class PropertyLog(LoggingMixin):
-    pass

-
-
-
-log = PropertyLog()
-
-
-

-[docs]
-class engforge_prop:
-    """an interface for extension and identification and class return support"""
-
-    must_return = False
-
-    def __init__(self, fget=None, fset=None, fdel=None, *args, **kwargs):
-        """ """
-
-        self.fget = fget
-        if fget:
-            self.gname = fget.__name__
-            self.get_func_return(fget)
-        self.fset = fset
-        self.fdel = fdel
-
-

-[docs]
-    def __call__(
-        self, fget=None, fset=None, fdel=None, doc=None, *args, **kwargs
-    ):
-        """this will be called when input is provided before property is set"""
-        if fget and self.fget is None:
-            self.gname = fget.__name__
-            self.get_func_return(fget)
-            self.fget = fget
-
-        if self.fset is None:
-            self.fset = fset
-
-        if self.fdel is None:
-            self.fdel = fdel
-
-        return self

-
-
-

-[docs]
-    def get_func_return(self, func):
-        """ensures that the function has a return annotation, and that return annotation is in valid sort types"""
-        anno = func.__annotations__
-        typ = anno.get("return", None)
-        if not typ in (int, str, float) and self.must_return:
-            raise Exception(
-                f"system_property input: function {func.__name__} must have valid return annotation of type: {(int,str,float)}"
-            )
-        else:
-            self.return_type = typ

-
-
-    def __get__(self, obj, objtype=None):
-        if obj is None:
-            return self  # class support
-        if self.fget is None:
-            raise AttributeError("unreadable attribute")
-        return self.fget(obj)
-
-    def __set__(self, obj, value):
-        if self.fset is None:
-            raise AttributeError("can't set attribute")
-        self.fset(obj, value)
-
-    def __delete__(self, obj):
-        if self.fdel is None:
-            raise AttributeError("can't delete attribute")
-        self.fdel(obj)
-
-    def getter(self, fget):
-        return type(self)(fget, self.fset, self.fdel, self.__doc__)
-
-    def setter(self, fset):
-        return type(self)(self.fget, fset, self.fdel, self.__doc__)
-
-    def deleter(self, fdel):
-        return type(self)(self.fget, self.fset, fdel, self.__doc__)

-
-
-
-

-[docs]
-class cache_prop(engforge_prop):
-    allow_set: bool = (
-        False  # keep this flag false to maintain current persistent value
-    )
-
-    def __init__(self, *args, **kwargs):
-        self.allow_set = True
-        super().__init__(*args, **kwargs)
-
-    def __set__(self, instance, value):
-        if self.allow_set:
-            self.set_cache(instance, reason="change", val=value)
-        else:
-            raise Exception(f"cannot set {self.gname}")
-
-    def set_cache(self, instance, reason="update", val=None):
-        raise NotImplementedError(
-            "cache_prop must be subclassed and set_cache method defined"
-        )

-
-
-
-

-[docs]
-class system_property(engforge_prop):
-    """
-    this property notifies the system this is a property to be tabulated in the dataframe output.
-
-    @system_property
-    def function(...): < this uses __init__ to assign function
-
-    @system_property(desc='really nice',label='funky function')
-    def function(...):    < this uses __call__ to assign function
-
-    When the underlying data has some random element, set stochastic=True and this will flag the component to always save data.
-
-    Functions wrapped with table type must have an return annotion of (int,float,str)... ex def func() -> int:
-    """
-
-    desc = ""
-    label = None
-    stochastic = False
-    get_func_return: type = None
-    return_type = None
-    must_return = True
-
-    def __init__(
-        self,
-        fget=None,
-        fset=None,
-        fdel=None,
-        doc=None,
-        desc=None,
-        label=None,
-        stochastic=False,
-    ):
-        """You can initalize just the functions, or precreate the object but with meta
-        @system_property
-        def function(...): < this uses __init__ to assign function
-
-        @system_property(desc='really nice',label='funky function')
-        def function(...):    < this uses __call__ to assign function
-        """
-
-        self.fget = fget
-        if fget:
-            self.get_func_return(fget)
-
-        self.fset = fset
-        self.fdel = fdel
-        if doc is None and fget is not None:
-            doc = fget.__doc__
-        elif doc is not None:
-            self.__doc__ = doc
-
-        if desc is not None:
-            self.desc = desc
-
-        if label is not None:
-            self.label = label
-        elif fget is not None:
-            self.label = fget.__name__.lower()
-
-        # Set random flag
-        self.stochastic = stochastic
-
-

-[docs]
-    def __call__(self, fget=None, fset=None, fdel=None, doc=None):
-        """this will be called when input is provided before property is set"""
-        if fget and self.fget is None:
-            self.get_func_return(fget)
-            self.fget = fget
-        if self.fset is None:
-            self.fset = fset
-        if self.fdel is None:
-            self.fdel = fdel
-
-        if doc is None and fget is not None:
-            doc = fget.__doc__
-        elif doc is not None:
-            self.__doc__ = doc
-
-        if self.label is None and fget is not None:
-            self.label = fget.__name__.lower()
-
-        return self

-
-
-

-[docs]
-    def get_func_return(self, func):
-        """ensures that the function has a return annotation, and that return annotation is in valid sort types"""
-        anno = func.__annotations__
-        typ = anno.get("return", None)
-        if not typ in (int, str, float):
-            raise Exception(
-                f"system_property input: function {func.__name__} must have valid return annotation of type: {(int,str,float)}"
-            )
-        else:
-            self.return_type = typ

-
-
-    def __get__(self, obj, objtype=None):
-        if obj is None:
-            return self  # class support
-        if self.fget is None:
-            raise AttributeError("unreadable attribute")
-        return self.fget(obj)
-
-    def __set__(self, obj, value):
-        if self.fset is None:
-            raise AttributeError("can't set attribute")
-        self.fset(obj, value)
-
-    def __delete__(self, obj):
-        if self.fdel is None:
-            raise AttributeError("can't delete attribute")
-        self.fdel(obj)
-
-    def getter(self, fget):
-        return type(self)(fget, self.fset, self.fdel, self.__doc__)
-
-    def setter(self, fset):
-        return type(self)(self.fget, fset, self.fdel, self.__doc__)
-
-    def deleter(self, fdel):
-        return type(self)(self.fget, self.fset, fdel, self.__doc__)

-
-#aliases
-sys_prop = system_property
-system_prop = system_property
-
-
-

-[docs]
-class cached_system_property(system_property):
-    """A system property that caches the result when nothing changes. Use for expensive functions since the checking adds some overhead"""
-
-    gname: str
-
-

-[docs]
-    def get_func_return(self, func):
-        """ensures that the function has a return annotation, and that return annotation is in valid sort types"""
-        anno = func.__annotations__
-        typ = anno.get("return", None)
-        if not typ in (int, str, float):
-            raise Exception(
-                f"system_property input: function {func.__name__} must have valid return annotation of type: {(int,str,float)}"
-            )
-        else:
-            self.return_type = typ

-
-
-    @property
-    def private_var(self):
-        return f"_{self.gname}"
-
-    def __get__(self, instance: "TabulationMixin", objtype=None):
-        if instance is None:
-            return self
-        if not hasattr(instance, self.private_var) and not IS_BUILD:
-            from engforge.tabulation import TabulationMixin
-
-            assert issubclass(
-                instance.__class__, TabulationMixin
-            ), f"incorrect class: {instance.__class__.__name__}"
-            return self.set_cache(instance, reason="set")
-        elif instance.anything_changed:
-            return self.set_cache(instance)
-        return getattr(instance, self.private_var)
-
-    def set_cache(self, instance, reason="update", val=None):
-        if log.log_level < 5:
-            log.msg(
-                f"solver cache for {instance.identity}.{self.private_var}| {reason}"
-            )
-        if val is None:
-            val = self.fget(instance)
-        setattr(instance, self.private_var, val)
-        return val

-
-
-#aliases
-cached_sys_prop = system_property
-cached_system_prop = system_property
-
-# TODO: install solver reset / declarative instance cache+
-

-[docs]
-class solver_cached(cache_prop):
-    """
-    A property that updates a first time and then anytime time the input data changed, as signaled by attrs.on_setattr callback
-    """
-
-    @property
-    def private_var(self):
-        return f"_{self.gname}"
-
-    def __get__(self, instance: "TabulationMixin", objtype=None):
-        if not hasattr(instance, self.private_var) and not IS_BUILD:
-            from engforge.tabulation import TabulationMixin
-
-            assert instance.__class__ is None or issubclass(
-                instance.__class__, TabulationMixin
-            ), f"incorrect class: {instance.__class__.__name__}"
-            return self.set_cache(instance, reason="set")
-
-        elif instance.anything_changed:
-            return self.set_cache(instance)
-
-        return getattr(instance, self.private_var)
-
-    def set_cache(self, instance, reason="update", val=None):
-        if log.log_level < 5:
-            log.debug(
-                f"caching attr for {instance.identity}.{self.private_var}| {reason}"
-            )
-        if val is None:
-            val = self.fget(instance)  # default!
-        setattr(instance, self.private_var, val)
-        return val

-
-
-
-# TODO: install solver reset / declarative instance cache+
-

-[docs]
-class instance_cached(cache_prop):
-    """
-    A property that caches a result to an instance the first call then returns that each successive call
-    """
-
-    @property
-    def private_var(self):
-        return f"_{self.gname}"
-
-    def __get__(self, instance: "TabulationMixin", objtype=None):
-        if not hasattr(instance, self.private_var):
-            from engforge.tabulation import TabulationMixin
-
-            if instance.__class__ is not None and not IS_BUILD:  # its an instance
-                assert issubclass(
-                    instance.__class__, TabulationMixin
-                ), f"incorrect class: {instance.__class__.__name__}"
-                return self.set_cache(instance, reason="set")
-            else:
-                return self.fget(instance)
-        return getattr(instance, self.private_var)
-
-    def set_cache(self, instance, reason="update", val=None):
-        if log.log_level < 5:
-            log.debug(
-                f"caching instance for {instance.identity}.{self.private_var}| {reason}"
-            )
-        if val is None:
-            val = self.fget(instance)  # default!
-        setattr(instance, self.private_var, val)
-        return val

-
-
-
-

-[docs]
-class class_cache(cache_prop):
-    """a property that caches a value on the class at runtime, and then maintains that value for the duration of the program. A flag with the class name ensures the class is correct. Intended for instance methods"""
-
-    @property
-    def private_var(self):
-        return f"_{self.gname}"
-
-    @property
-    def id_var(self):
-        return f"__{self.gname}"
-
-    def __get__(self, instance: "Any", objtype=None):
-        cls = instance.__class__
-        if hasattr(cls, self.private_var):
-            # check and gtfo
-            # print(f'getting private var {self.private_var}')
-            return getattr(cls, self.private_var)
-        else:
-            if not hasattr(cls, self.id_var):
-                # initial cache
-                return self.set_cache(instance, cls)
-            elif cls.__name__ != getattr(cls, self.id_var):
-                # recache the system if name doesn't match
-                return self.set_cache(instance, cls)
-        # print(f'getting private def {self.private_var}')
-
-        return getattr(cls, self.private_var)
-
-    def set_cache(self, instance, cls):
-        log.debug(f"cls caching for {cls.__name__}.{self.private_var}")
-        val = self.fget(instance)
-        setattr(cls, self.private_var, val)
-        setattr(cls, self.id_var, cls.__name__)
-        return val

-
-
-
-# #TODO: make a `solver_context` that exposes a ray python remote funciton with wait & other provisions... add to a call graph and optimize later
-# NOTE: challenge to handle class/instance/functions with same code
-# from engforge.properties import engforge_prop
-# class solver_context(engforge_prop):
-#
-#     fget = None
-#
-#     def __init__(
-#         self,
-#         fget=None,
-#         **kwargs,
-#     ):
-#         if fget:
-#             self.fget = remote_func_ret(fget)
-#         self.ray_kw = kwargs
-#
-#     def __call__(self, fget=None, fset=None, fdel=None, doc=None):
-#         """this will be called when input is provided before property is set"""
-#         if fget and self.fget is None:
-#             self.fget = remote_func_ret(fget,**self.ray_kw)
-#
-#         return self
-#
-#     def __get__(self, obj, objtype=None):
-#         if obj is None:
-#             return self
-#         if self.fget is None:
-#             raise AttributeError("unreadable attribute")
-#         return self.fget(obj)
-#
-#
-# class remote_func_ret:
-#     fget = None
-#     remote_fget = None
-#     def __init__(self,func=None,**kwargs):
-#         self.ray_kwargs = kwargs
-#         if func:
-#             self.setup_func(func)
-#
-#     def setup_func(self,func):
-#         self.fget = func
-#         if self.ray_kwargs:
-#             d = ray.remote(**self.ray_kwargs)
-#             self.remote_fget = d(func)
-#         else:
-#             self.remote_fget = ray.remote(func)
-#
-#     def __call__(self,*args,**kwargs):
-#         return self.fget(*args,**kwargs)
-#
-#     def remote(self,wait=False,getret=False,*args,**kwargs):
-#         res = self.remote_fget.remote(*args,**kwargs)
-#
-#         if wait:
-#             ray.wait([res])
-#             return res
-#         if getret:
-#             return ray.get([res])
-#         return res
-#
-#
-# @solver_context
-# def test_deck(a,b,c):
-#     print(a,b,c)
-#
-#     return a * b * c
-#
-# @solver_context(num_cpus=2)
-# def super_test(a,b,c):
-#     print(a,b,c)
-#
-#     return a * b * c
-#
-#
-# class nonactor:
-#
-#     def __init__(self,c):
-#         self.c = c
-#
-#     @solver_context
-#     def test_inst(self,a,b):
-#         print(a,b)
-#
-#         return a * b  * self.c
-#
-#     @solver_context(num_cpus=2)
-#     def inst_test(self,a,b):
-#         print(a,b)
-#
-#         return a * b  * self.c
-#
-# print(test_deck)
-# print(super_test)
-# print(nonactor.test_inst)
-# print(nonactor.inst_test)
-#
-# ac = nonactor(1)
-# print(ac.test_inst)
-# print(ac.inst_test)
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/reporting.html b/docs/_build/html/_modules/engforge/reporting.html deleted file mode 100644 index 6a49386..0000000 --- a/docs/_build/html/_modules/engforge/reporting.html +++ /dev/null @@ -1,739 +0,0 @@ - - - - - - engforge.reporting — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.reporting

-"""The set of reporters define an interface to report plots or tables"""
-
-from engforge.configuration import Configuration, forge
-from engforge.typing import Options
-from engforge.logging import LoggingMixin
-import attrs
-import abc
-
-import os, pathlib
-import datetime
-
-
-

-[docs]
-def path_exist_validator(inst, attr, value):
-    if not isinstance(value, str):
-        raise ValueError(f"{attr.name} isnt a string")
-    if not os.path.exists(value):
-        raise FileExistsError(f"{value} does not exist")

-
-
-
-# BASE CLASSSES (PLOT + TABLE)
-

-[docs]
-@attrs.define
-class Reporter(LoggingMixin):
-    """A mixin intended"""
-
-    name: str = attrs.field(default="reporter")
-
-

-[docs]
-    def check_config(self):
-        """a test to see if the reporter should be used"""
-        return True

-
-
-

-[docs]
-    @classmethod
-    def subclasses(cls, out=None):
-        """get all reporters of this type"""
-        if out is None:
-            out = set()
-
-        for scls in cls.__subclasses__():
-            out.add(scls)
-            scls.subclasses(scls)

-
-
-    def upload(self, analysis: "Analysis"):
-        self.info(f"uploading {analysis.identity} to {self.identity}")
-        raise NotImplemented()

-
-
-
-# Functionality Mixins
-

-[docs]
-@attrs.define
-class TemporalReporterMixin(Reporter):
-    """Provide single or periodic keys"""
-
-    # report_mode: Options("single", "daily", "monthly") #choose wisely
-
-    @property
-    def report_root(self):
-        raise NotImplemented()
-
-    @property
-    def date_key(self):
-        d = datetime.datetime.utcnow().date()
-        return f"{d.year}.{d.month:02}.{d.day:02}"
-
-    @property
-    def month_key(self):
-        d = datetime.datetime.utcnow().date()
-        return f"{d.year}.{d.month:02}"
-
-    @property
-    def report_root(self):
-        """define your keys!"""
-        raise NotImplemented()

-
-
-
-

-[docs]
-@attrs.define
-class DiskReporterMixin(TemporalReporterMixin):
-    path: str = attrs.field(default=None, validator=path_exist_validator)
-
-    # whats our /report/<key> gonna be
-    report_mode = Options("single", "daily", "monthly")
-
-    @property
-    def report_root(self):
-        if self.report_mode == "single":
-            return self.path
-        elif self.report_mode == "daily":
-            return os.path.join(self.path, self.date_key)
-        elif self.report_mode == "monthly":
-            return os.path.join(self.path, self.month_key)
-
-        raise ValueError(f"options failed!")
-
-    def ensure_exists(self):
-        if not os.path.exists(self.report_root):
-            pth = pathlib.Path(self.report_root)
-            pth.mkdir(parents=True, exist_ok=True)
-
-    def ensure_path(self, file_path,is_dir=False):
-        pth = pathlib.Path(file_path)
-        diri = pth if is_dir else pth.parent
-        if not diri.exists():
-            diri.mkdir(parents=True, exist_ok=True)

-
-
-
-# Basic Reporter Types
-

-[docs]
-@attrs.define
-class TableReporter(Reporter):
-    """A reporter to upload dataframes to a table store"""
-
-    name: str = attrs.field(default="table_reporter")

-
-
-
-

-[docs]
-@attrs.define
-class PlotReporter(Reporter):
-    """A reporter to upload plots to a file store"""
-
-    name: str = attrs.field(default="plot_reporter")
-
-    # FIXME: make attrs work... layout class conflict
-    # ext = Options('png','jpg','gif')
-    # ext: str = attrs.field(default='png')
-    ext = "png"
-
-#     def upload(self, analysis):
-#         for figkey, fig in analysis.stored_plots.items():
-#             try:
-#                 filname = os.path.join(self.report_root, f"{figkey}.{self.ext}")
-#                 self.ensure_path(filname)
-#                 self.info(f"saving {figkey} to {filname}")
-#                 fig.savefig(filname)
-# 
-#             except Exception as e:
-#                 self.error(e, f"issue showing {figkey}")
-    def upload(self,analyis):
-        raise NotImplemented(f'plot reporter subclass needs an upload method')

-
-
-
-# Table Reporters
-

-[docs]
-@attrs.define
-class CSVReporter(TableReporter, DiskReporterMixin):
-    name: str = attrs.field(default="CSV")
-
-    def upload(self, analysis: "Analysis"):
-        self.info(f"uploading {analysis.identity} to {self.identity}")
-        self.ensure_exists()
-
-        system = analysis.system
-
-        # Make System Dataframe
-        af = os.path.join(self.report_root, f"system_{system.name}.csv")
-        self.ensure_path(af)
-        self.info(f"saving system to: {af}")
-        system.dataframe.to_csv(af)

-
-
-#         # Make Analysis Dataframe
-#         af = os.path.join(self.report_root, f"analysis_{analysis.name}.csv")
-#         self.ensure_path(af)
-#         self.info(f"saving analysis to: {af}")
-#         analysis.dataframe.to_csv(af)
-# 
-#         for ckey, comp in system.comp_references().items():
-#             af = os.path.join(self.report_root, f"{ckey}_{comp.name}.csv")
-#             self.ensure_path(af)
-#             self.info(f"saving {ckey} to: {af}")
-#             comp.dataframe.to_csv(af)
-
-
-

-[docs]
-@attrs.define
-class ExcelReporter(TableReporter, DiskReporterMixin):
-    name: str = attrs.field(default="EXCEL")

-
-
-
-

-[docs]
-@attrs.define
-class GsheetsReporter(TableReporter, TemporalReporterMixin):
-    name: str = attrs.field(default="GSHEETS")

-
-
-
-# @attrs.define
-# class SQLReporter(TableReporter):
-#     name: str = attrs.field(default="SQL")
-#
-#
-# @attrs.define
-# class ArangoReporter(TableReporter):
-#     name: str = attrs.field(default="SQL")
-
-
-# PLOT Reporters
-

-[docs]
-@attrs.define
-class DiskPlotReporter(PlotReporter, DiskReporterMixin):
-    name: str = attrs.field(default="DrivePlots")
-
-    def upload(self, analysis):
-        for figkey, fig in analysis.stored_plots.items():
-            try:
-                filname = os.path.join(self.report_root, f"{figkey}.{self.ext}")
-                self.ensure_path(filname)
-                self.info(f"saving {figkey} to {filname}")
-                fig.savefig(filname)
-
-            except Exception as e:
-                self.error(e, f"issue showing {figkey}")    

-
-
-

-[docs]
-@attrs.define
-class GdriveReporter(PlotReporter, TemporalReporterMixin):
-    name: str = attrs.field(default="Gdrive")
-    share_drive: str = attrs.field(
-        default=None, validator=attrs.validators.instance_of(str)
-    )

-
-
-
-# TODO: move to analysis
-# def split_dataframe_by_colmum(self,df,max_columns=10):
-#     df_cols = list(df.columns)
-#     if len(df_cols) < max_columns:
-#         return [df]
-#
-#     col_chunks = list(chunks(df_cols,max_columns))
-#     dat_chunks = [df[colck].copy() for colck in col_chunks]
-#
-#     return dat_chunks
-
-# def cleanup_dataframe(self,df,badwords=('min','max')):
-#     tl_df = self.static_dataframe
-#     to_drop = [cl for cl in tl_df.columns if any([bw in cl.lower() for bw in badwords])]
-#     out_df = tl_df.drop(columns=to_drop)
-#     return out_df
-
-
-# @solver_cached
-# def variable_dataframe(self):
-#     vals = list(zip(*list((self.variable_data_dict.values()))))
-#     cols = list((self.variable_data_dict.keys()))
-#     if vals:
-#         return pandas.DataFrame(data = vals, columns=cols, copy = True)
-#     else:
-#         return  None
-#
-# @solver_cached
-# def static_dataframe(self):
-#     vals = [list((self.static_data_dict.values()))]
-#     cols = list((self.static_data_dict.keys()))
-#     if vals:
-#         return pandas.DataFrame(data = vals, columns=cols, copy = True)
-#     else:
-#         return None
-
-# Clearance Methods
-# table property internal variables
-# __store_options = ('csv','excel','gsheets')#,'db','gsheets','excel','json')
-# _store_types = None
-# _store_level:int = -1
-
-#     @property
-#     def table_iterator(self):
-#         '''Checks data to see what type of table it is, type 1 is a single row
-#         whereas type 2 & 3 have several rows, but type 2 has some values that are singular
-#
-#         iterates table_type,values,label'''
-#
-#         if not self.TABLE:
-#             return 0,[],[]
-#         if len(self.TABLE) <= 1:
-#             yield 1,self.TABLE[1],self.data_label
-#         else:
-#             #wide outerloop over vars
-#             for label in set.union(*[set(tuple(row.keys())) for i,row in self.TABLE.items()]):
-#                 #inner loop over data
-#                 col = [row[label] if label in row else None for inx,row in self.TABLE.items()]
-#
-#                 if all([isinstance(cvar,TABLE_TYPES) for cvar in col]): #do a type check
-#                     if len(set(col)) <= 1: #All Values Are Similar
-#                         yield 2, col[0], label #Can assume that first value is equal to all
-#                     else:
-#                         yield 3, col, label
-#
-# def recursive_data_structure(self,levels_to_descend = -1, parent_level=0):
-#     '''Returns the static and variable data from each configuration to grab defined by the
-#     recursive commands input in this function
-#
-#     data is stored like: output[level]=[{static,variable},{static,variable},...]'''
-#
-#     output = {}
-#
-#     for level,conf in self.go_through_configurations(0,levels_to_descend,parent_level):
-#         if level in output:
-#             output[level].append({'static':conf.static_dataframe,\
-#                                     'variable':conf.variable_dataframe,'conf':conf})
-#         else:
-#             output[level] = [{'static':conf.static_dataframe,\
-#                                 'variable':conf.variable_dataframe,\
-#                                 'conf':conf}]
-#
-#     return output
-
-# Multi-Component Table Combination Methods
-# @solver_cached
-# def static_data_dict(self):
-#     '''returns key-value pairs in table that are single valued, all in type 1, some in type 2'''
-#
-#     output = {}
-#     for tab_type,value,label in self.table_iterator:
-#         if tab_type == 1:
-#             return {l:v for l,v in zip(label,value)}
-#         elif tab_type == 2:
-#             output[label] = value
-#     return output
-#
-# @solver_cached
-# def variable_data_dict(self):
-#     '''returns a dictionary of key value pairs where values list is not the same all of type 3 and some of type 2'''
-#     output = {}
-#     for tab_type,value,label in self.table_iterator:
-#         if tab_type == 3:
-#             output[label] = value
-#     return output
-#
-#
-# #Multi-Component Table Lookups
-# @solver_cached
-# def toplevel_static(self):
-#     out_df = self.cleanup_dataframe( self.static_dataframe )
-#     df_list = self.split_dataframe_by_colmum(out_df,self.max_col_width_static)
-#
-#     return {'conf':self,'dfs':  df_list }
-#
-# @solver_cached
-# def other_static_tables(self):
-#     rds = self.recursive_data_structure(self.store_level)
-#     output = []
-#     for index, components in rds.items():
-#         if index > 0:
-#             for comp in components:
-#                 if comp['static'] is not None:
-#                     df_list = self.split_dataframe_by_colmum(comp['static'],self.max_col_width_static)
-#                     output.append({'conf':comp['conf'],'dfs': df_list})
-#     return output
-#
-# @solver_cached
-# def variable_tables(self):
-#     '''Grabs all valid variable dataframes and puts them in a list'''
-#     rds = self.recursive_data_structure(self.store_level)
-#
-#     output = []
-#     for index, components in rds.items():
-#         for comp in components:
-#             if comp['variable'] is not None:
-#                 output.append({'conf':comp['conf'],'df':comp['variable']})
-#
-#     return output
-#
-# @solver_cached
-# def joined_dataframe(self):
-#     '''this is a high level data frame with all data that changes in the system'''
-#     if self.variable_tables:
-#         return pandas.concat([ vt['df'] for vt in list(reversed(self.variable_tables))],axis=1)
-#     else:
-#         return None
-#
-# @property
-# def complete_dataframe(self):
-#     '''this is a high level data frame with all data in the system'''
-#
-#     rds = self.recursive_data_structure()
-#     if rds:
-#         dataframes = []
-#         stat_dataframes = []
-#         for lvl, comps in rds.items():
-#             for comp in comps:
-#                 df = comp['conf'].dataframe
-#                 if not comp['conf'] is self:
-#                     nm = comp['conf'].name.lower()
-#                     if nm == 'default':
-#                         nm = comp['conf'].__class__.__name__.lower()
-#                     nm = nm.replace(' ','_')
-#                     strv=f'{nm}_'
-#                     strv+='{}'
-#                 else:
-#                     nm = ''
-#                     strv='{}'
-#                 df.rename(strv.format, axis=1, inplace=True)
-#
-#                 dataframes.append(df)
-#         return pandas.concat(dataframes,join='outer',axis=1)
-#
-#     else:
-#         return None
-
-# Saving & Data Acces Methods
-# def get_field_from_table(self,field,check_type=None,check_value:Callable = None):
-#     '''Converts Pandas To Numpy Array By Key, also handles poorly formated fields
-#     :param check_type: use a type or tuple of types to validate if the field is of type table
-#     :param check_value: use a function to check each value to ensure its valid for return, check type take priority'''
-#     if self.joined_dataframe is None:
-#         return numpy.array([])
-#     elif field in self.joined_dataframe:
-#         table = self.joined_dataframe[field]
-#     elif field.title() in self.joined_dataframe:
-#         table = self.joined_dataframe[field.title()]
-#     else:
-#         raise Exception('No Field Named {}'.format(field))
-#
-#     #Remove Infinity
-#     table = table.replace([numpy.inf, -numpy.inf], numpy.nan)
-#
-#     if check_type is not None:
-#         if all([isinstance(v,check_type) for v in table]):
-#             return table.to_numpy(copy=True)
-#         return None
-#     elif check_value is not None:
-#         if all([check_value(v) for v in table]):
-#             return table.to_numpy(copy=True)
-#         return None
-#
-#     return table.to_numpy(dtype=float,copy=True)
-
-
-# Save functionality
-# TODO: get me outta hur
-#     def save_table(self,dataframe=None,filename=None,meta_tags=None,*args,**kwargs):
-#         '''Header method to save the config in many different formats
-#         :param meta_tags: a dictionary with headers being column names, and the value as the item to fill that column'''
-#         if dataframe is None:
-#             dataframe = self.dataframe
-#
-#         self.info('saving gsheets...')
-#
-#         if meta_tags is not None and type(meta_tags) is dict:
-#             for tag,value in meta_tags.items():
-#                 dataframe[tag] = value
-#
-#
-#         for save_format in self.store_types:
-#             try:
-#                 if save_format == 'csv':
-#                     self.save_csv(dataframe,filename,*args,**kwargs)
-#                 elif save_format == 'excel':
-#                     self.save_excel(dataframe,filename,*args,**kwargs)
-#                 elif save_format == 'gsheets':
-#                     self.save_gsheets(dataframe,filename,*args,**kwargs)
-#             except Exception as e:
-#                 self.error(e,'Issue Saving Tables:')
-
-#     def save_csv(self,dataframe,filename=None,*args,**kwargs):
-#         if self.TABLE:
-#             if filename is None:
-#                 filename = '{}.csv'.format(self.filename)
-#             if type(filename) is str and not filename.endswith('.csv'):
-#                 filename += '.csv'
-#             filepath = os.path.join(self.config_path_daily,filename)
-#             dataframe.to_csv(path_or_buf=filepath,index=False,*args,**kwargs)
-#
-#     def save_excel(self,dataframe,filename=None,*args,**kwargs):
-#         if self.TABLE:
-#             if filename is None:
-#                 filename = '{}.xlsx'.format(self.filename)
-#             if type(filename) is str and not filename.endswith('.xlsx'):
-#                 filename += '.xlsx'
-#             filepath = os.path.join(self.config_path_daily,filename)
-#             dataframe.to_excel(path_or_buf=filepath,*args,**kwargs)
-
-#     @property
-#     def store_level(self):
-#         return self._store_level
-#
-#     @store_level.setter
-#     def store_level(self,new_level:int):
-#         assert isinstance(new_level,(int))
-#         self._store_level = new_level
-#
-#     @property
-#     def store_types(self):
-#         if self._store_types is None:
-#             self._store_types = [] #initalization
-#         return self._store_types
-
-#     @store_types.setter
-#     def store_types(self, new_type_or_list):
-#         '''If you add a list or iterable, and each value is a valid output option we will assign it
-#         otherwise if its a value in the valid options it will be added.
-#         '''
-#         if isinstance(new_type_or_list,(list,tuple)):
-#             assert all([val in self.__store_options for val in new_type_or_list])
-#             self._store_types = list(new_type_or_list)
-#
-#         elif new_type_or_list in self.__store_options:
-#              self._store_types.append(new_type_or_list)
-#
-#         else:
-#             self.warning('store types input not valid {}'.format(new_type_or_list))
-
-
-#     def save_to_worksheet(self,worksheet:'pygsheets.Worksheet'):
-#         '''Saves to a gsheets via pygsheets adds static and regular data'''
-#
-#         title = self.identity.replace('_',' ').title()
-#
-#         self.info('saving worksheet as {}'.format(title))
-#         wksh = worksheet
-#
-#         wksh.clear()
-#
-#         #Static data
-#         start = pygsheets.Address((2,2))
-#
-#         tld = self.toplevel_static
-#         sdf = tld['dfs']
-#
-#         cur_index = start + (1,0)
-#         for i,df in enumerate(sdf):
-#             self.debug('saving dataframe {}'.format(df))
-#             wksh.update_value(start.label,self.identity)
-#             wksh.cell(start.label).set_text_format('bold',True)
-#             wksh.set_dataframe(df,cur_index.label , extend=True)
-#             cur_index += (2,0)
-#
-#         cur_index += (3,0)
-#
-#         var_index = pygsheets.Address(cur_index.label)
-#
-#         max_row = 0
-#
-#         vrt = self.variable_tables
-#         self.info('saving {} other static tables'.format(len(vrt)))
-#
-#         for dfpack in vrt:
-#             conf = dfpack['conf']
-#             df = dfpack['df']
-#             self.debug('saving dataframe {}'.format(df))
-#
-#             (num_rows,num_cols) = df.shape
-#             max_row = max(max_row,num_rows)
-#
-#             wksh.update_value((var_index-(1,0)).label,conf.classname)
-#             wksh.cell((var_index-(1,0)).label).set_text_format('bold',True)
-#
-#             wksh.set_dataframe(df,start=var_index.label,extend=True)
-#
-#             var_index += (0,num_cols)
-#
-#         cur_index += (3+max_row,0)
-#
-#         ost = self.other_static_tables
-#
-#         self.info('saving {} other static tables'.format(len(ost)))
-#
-#         for dfpack in ost:
-#             conf = dfpack['conf']
-#             sdf = dfpack['dfs']
-#
-#             wksh.update_value((cur_index-(1,0)).label,conf.identity)
-#             wksh.cell((cur_index-(1,0)).label).set_text_format('bold',True)
-#
-#             for i,df in enumerate(sdf):
-#
-#                 self.debug('saving {} dataframe {}'.format(conf.identity, df))
-#                 wksh.set_dataframe(df,start=cur_index.label ,extend=True)
-#                 cur_index += (2,0)
-#
-#             cur_index += (3,0)
-
-
-#     def save_gsheets(self,dataframe,filename=None,index=False,*args,**kwargs):
-#         '''A function to save the table to google sheets
-#         :param filename: the filepath on google drive - be careful!
-#         '''
-#         with self.drive.context(filepath_root=self.local_sync_path, sync_root=self.cloud_sync_path) as gdrive:
-#             with gdrive.rate_limit_manager( self.save_gsheets,6,dataframe,filename=filename,*args,**kwargs) as tdrive:
-#
-#                 old_sleep = tdrive._sleep_time
-#                 tdrive.reset_sleep_time( max(old_sleep,2.5) )
-#
-#                 gpath = tdrive.sync_path(self.local_sync_path)
-#                 self.info(f'saving as gsheets in dir {self.local_sync_path} -> {gpath}')
-#                 parent_id = gdrive.get_gpath_id(gpath)
-#                 #TODO: delete old file if exists
-#                 tdrive.sleep(2*(1+tdrive.time_fuzz*random.random()))
-#                 if tdrive and tdrive.gsheets:
-#                     sht = tdrive.gsheets.create(filename,folder=parent_id)
-#
-#                     tdrive.sleep(2*(1+tdrive.time_fuzz*random.random()))
-#                     tdrive.cache_directory(parent_id)
-#
-#                     wk = sht.sheet1
-#
-#                     wk.rows = dataframe.shape[0]
-#                     gdrive.sleep(2*(1+tdrive.time_fuzz*random.random()))
-#
-#                     wk.set_dataframe(dataframe,start='A1',fit=True)
-#                     gdrive.sleep(2*(1+tdrive.time_fuzz*random.random()))
-#
-#                     #TODO: add in dataframe dict with schema sheename: {dataframe,**other_args}
-#                     self.info('gsheet saved -> {}'.format(os.path.join(gpath,filename)))
-#
-#                 tdrive.reset_sleep_time( old_sleep )
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/solveable.html b/docs/_build/html/_modules/engforge/solveable.html deleted file mode 100644 index d3fb9db..0000000 --- a/docs/_build/html/_modules/engforge/solveable.html +++ /dev/null @@ -1,1080 +0,0 @@ - - - - - - engforge.solveable — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.solveable

-import attrs,attr
-import uuid
-import numpy
-import numpy as np
-import scipy.optimize as sciopt
-from contextlib import contextmanager
-import copy
-import datetime
-import typing
-
-
-# from engforge.dynamics import DynamicsMixin
-from engforge.attributes import AttributeInstance
-from engforge.engforge_attributes import AttributedBaseMixin
-from engforge.configuration import Configuration, forge
-from engforge.properties import *
-from engforge.system_reference import *
-from engforge.system_reference import Ref
-from engforge.solver_utils import *
-from engforge.attr_dynamics import IntegratorInstance
-
-import collections
-import itertools
-
-SOLVER_OPTIONS = ["root", "minimize"]
-
-
-

-[docs]
-class SolvableLog(LoggingMixin):
-    pass

-
-
-
-
-log = SolvableLog()
-
-#Anonymous Update Funcs (solve scoping issue)
-def _update_func(comp,eval_kw):
-    def updt(*args,**kw):
-        eval_kw.update(kw)
-        if log.log_level <= 5:
-            log.msg(f'update| {comp.name} ',lvl=5)
-        return comp.update(comp.parent, *args, **eval_kw)
-    if log.log_level <= 5:
-        log.msg(f'create method| {comp.name}| {eval_kw}')
-    updt.__name__ = f'{comp.name}_update'
-    return updt
-
-def _post_update_func(comp,eval_kw):
-    def updt(*args,**kw):
-        eval_kw.update(kw)
-        return comp.post_update(comp.parent, *args, **eval_kw)
-    if log.log_level <= 5:
-        log.msg(f'create post method| {comp.name}| {eval_kw}')
-    updt.__name__ = f'{comp.name}_post_update'
-    return updt
-
-def _cost_update(comp):
-    from engforge.eng.costs import Economics,CostModel    
-    
-    if isinstance(comp,Economics):
-        def updt(*args,**kw):
-            if log.log_level <= 8:
-                log.debug(f'update economics {comp.name} | {comp.term_length} ')
-            comp.system_properties_classdef(True)
-            comp.update(comp.parent, *args, **kw)
-        if log.log_level <= 8:
-            log.debug(f'economics update cb {comp.name} | {comp.term_length} ')
-        updt.__name__ = f'{comp.name}_econ_update'
-    else:
-        def updt(*args,**kw):
-            if log.log_level <= 7:
-                log.msg(f'update costs {comp.name} ',lvl=5)
-            comp.system_properties_classdef(True)
-            return comp.update_dflt_costs()
-        if log.log_level <= 7:
-            log.debug(f'cost update cb {comp.name} ')
-        updt.__name__ = f'{comp.name}_cost_update'
-        
-    return updt
-
-dflt_dynamics = {'dynamics.state':{},'dynamics.input':{},'dynamics.rate':{},'dynamics.output':{},'dynamic_comps':{}}
-skipa_attr_names = ("index","parent","dynamic_input_vars","dynamic_state_vars","dynamic_output_vars")
-
-    
-

-[docs]
-class SolveableMixin(AttributedBaseMixin):  #'Configuration'
-    """commonality for components,systems that identifies subsystems and states for solving.
-
-    This class defines the update structure of components and systems, and the storage of internal references to the system and its components. It also provides a method to iterate over the internal components and their references.
-
-    Importantly it defines the references to the system and its components, and the ability to set the system state from a dictionary of values across multiple objects. It also provides a method to iterate over the internal components and their references. There are several helper functions to these ends.
-    """
-
-    # TODO: add parent state storage
-    parent: "Configuration"
-
-    _prv_internal_references: dict
-    _prv_internal_components: dict
-    _prv_internal_systems: dict
-    _prv_internal_tabs: dict
-    _prv_system_references: dict
-
-    # Update Flow
-    #TODO: pass the problem vs the parent component, then locate this component in the problem and update any references
-

-[docs]
-    def update(self, parent, *args, **kwargs):
-        """Kwargs comes from eval_kw in solver"""
-        if log.log_level <= 5:
-            log.debug(f"void updating {self.__class__.__name__}.{self}")

-
-
-

-[docs]
-    def post_update(self, parent, *args, **kwargs):
-        """Kwargs comes from eval_kw in solver"""
-        if log.log_level <= 5:
-            log.debug(f"void post-updating {self.__class__.__name__}.{self}")

-
-
-

-[docs]
-    def collect_update_refs(self,eval_kw=None,ignore=None):
-        """checks all methods and creates ref's to execute them later"""
-        from engforge.eng.costs import CostModel,Economics
-
-        updt_refs = {}
-        from engforge.components import Component
-        from engforge.component_collections import ComponentIter
-
-        # Ignore
-        if ignore is None:
-            ignore = set()
-        elif self in ignore:
-            return
-        
-        for key, comp in self.internal_configurations(False).items():
-            if ignore is not None and comp in ignore:
-                continue
-
-            if not isinstance(comp,SolveableMixin):
-                continue            
-
-            #provide add eval_kw
-            if eval_kw and key in eval_kw:
-                eval_kw_comp = eval_kw[key]
-            else:
-                eval_kw_comp = {}
-            ekw = eval_kw_comp
-
-            #Add if its a unique update method (not the passthrough)
-            if isinstance(comp,(CostModel,Economics)):
-                ref = Ref(comp,_cost_update(comp))
-                updt_refs[key+'._cost_model_'] =  ref            
-            
-            elif comp.__class__.update != SolveableMixin.update:
-                ref = Ref(comp,_update_func(comp,ekw))
-                updt_refs[key] =  ref
-            
-            #Cost Models
-
-
-        ignore.add(self)
-        return updt_refs

-
-
-

-[docs]
-    def collect_post_update_refs(self,eval_kw=None,ignore=None):
-        """checks all methods and creates ref's to execute them later"""
-        updt_refs = {}
-        from engforge.components import Component
-        from engforge.component_collections import ComponentIter
-
-        # Ignore
-        if ignore is None:
-            ignore = set()
-        elif self in ignore:
-            return
-
-        for key, comp in self.internal_configurations(False).items():
-            if ignore is not None and comp in ignore:
-                continue
-
-            if not isinstance(comp,SolveableMixin):
-                continue            
-
-            # provide add eval_kw
-            if eval_kw and key in eval_kw:
-                eval_kw_comp = eval_kw[key]
-            else:
-                eval_kw_comp = {}
-            
-            ekw = eval_kw_comp
-                
-            #Add if its a unique update method (not the passthrough)
-            if comp.__class__.post_update != SolveableMixin.post_update:
-                ref = Ref(comp,_post_update_func(comp,ekw))
-                updt_refs[key] =  ref
-
-        ignore.add(self)
-        return updt_refs

-
-
-    # internals caching
-    # instance attributes
-
-    #TODO: move all system / property & identification to the problem_context or new system_identificaiton class (problem/base)
-    @instance_cached
-    def signals(self):
-        """this is just a record of signals from this solvable. dont use this to get the signals, use high level signals strategy #TODO: add signals strategy"""
-        return {k: getattr(self, k) for k in self.signals_attributes()}
-
-    @instance_cached
-    def solvers(self):
-        """this is just a record of any solvable attribute. dont use this to get the attribute, use another strategy"""        
-        return {k: getattr(self, k) for k in self.solvers_attributes()}
-
-    @instance_cached(allow_set=True)
-    def transients(self):
-        """this is just a record of any transient attribute. dont use this to get the transient, use another strategy"""   
-        return {k: getattr(self, k) for k in self.transients_attributes()}
-
-

-[docs]
-    def internal_components(self, recache=False) -> dict:
-        """get all the internal components"""
-        if recache == False and hasattr(self, "_prv_internal_components"):
-            return self._prv_internal_components
-        from engforge.components import Component
-
-        o = {k: getattr(self, k) for k in self.slots_attributes()}
-        o = {k: v for k, v in o.items() if isinstance(v, Component)}
-        self._prv_internal_components = o
-        return o

-
-
-

-[docs]
-    def internal_systems(self, recache=False) -> dict:
-        """get all the internal components"""
-        if recache == False and hasattr(self, "_prv_internal_systems"):
-            return self._prv_internal_systems
-        from engforge.system import System
-
-        o = {k: getattr(self, k) for k in self.slots_attributes()}
-        o = {k: v for k, v in o.items() if isinstance(v, System)}
-        self._prv_internal_systems = o
-        return o

-
-
-

-[docs]
-    def internal_tabulations(self, recache=False) -> dict:
-        """get all the internal tabulations"""
-        from engforge.tabulation import TabulationMixin
-
-        if recache == False and hasattr(self, "_prv_internal_tabs"):
-            return self._prv_internal_tabs
-
-        o = {k: getattr(self, k) for k in self.slots_attributes()}
-        o = {k: v for k, v in o.items() if isinstance(v, TabulationMixin)}
-        self._prv_internal_tabs = o
-        return o

-
-
-    # recursive references
-    @instance_cached
-    def iterable_components(self) -> dict:
-        """Finds ComponentIter internal_components that are not 'wide'"""
-        from engforge.component_collections import ComponentIter
-
-        return {
-            k: v
-            for k, v in self.internal_components().items()
-            if isinstance(v, ComponentIter) and not v.wide
-        }
-
-

-[docs]
-    def internal_references(self, recache=False,numeric_only=False) -> dict:
-        """get references to all internal attributes and values, only saving when complete cache info is requested (vs numeric only)"""
-        if not numeric_only and (recache == False and hasattr(self, "_prv_internal_references")):
-            return self._prv_internal_references
-
-        out = self._gather_references(numeric_only=numeric_only)
-        if not numeric_only: self._prv_internal_references = out
-        return out

-
-
-    def _gather_references(self,numeric_only=False) -> dict:
-        out = {}
-        out["attributes"] = at = {}
-        out["properties"] = pr = {}
-
-        for key in self.system_properties_classdef():
-            pr[key] = Ref(self, key, True, False)
-
-        if numeric_only:
-            for key in self.numeric_fields():
-                at[key] = Ref(self, key, False, True)
-        else:
-            for key in self.input_fields((list,tuple,dict)):
-                at[key] = Ref(self, key, False, True)
-
-        return out
-
-    def _iterate_components(self):
-        """sets the current component for each product combination of iterable_components"""
-
-        components = self.iterable_components
-
-        if not components:
-            yield  # enter once
-        else:
-
-            def _gen(gen, compkey):
-                for itemkey, item in gen:
-                    yield compkey, itemkey
-
-            iter_vals = {
-                cn: _gen(comp._item_gen(), cn)
-                for cn, comp in components.items()
-            }
-
-            for out in itertools.product(*list(iter_vals.values())):
-                for ck, ikey in out:
-                    # TODO: progress bar or print location
-                    components[ck].current_item = ikey
-                yield out
-
-            # finally reset the data!
-            for ck, comp in components.items():
-                comp.reset()
-
-

-[docs]
-    def comp_references(self,ignore_none_comp=True,**kw):
-        """A cached set of recursive references to any slot component
-        #FIXME: by instance recache on iterative component change or other signals
-        """
-        out = {}
-        for key, lvl, comp in self.go_through_configurations(parent_level=1,**kw):
-            if ignore_none_comp and not isinstance(comp, SolveableMixin):
-                continue
-            out[key] = comp
-        return out

-
-
-    # Run & Input
-    def _iterate_input_matrix(
-        self,
-        method,
-        cb=None,
-        sequence: list = None,
-        eval_kw: dict = None,
-        sys_kw: dict = None,
-        force_solve=False,
-        return_results=False,
-        method_kw: dict = None,
-        **kwargs,
-    ):
-        """applies a permutation of input vars for vars. runs the system instance by applying input to the system and its slot-components, ensuring that the targeted attributes actualy exist.
-
-        :param revert: will reset the values of X that were recorded at the beginning of the run.
-        :param cb: a callback function that takes the system as an argument cb(system)
-        :param sequence: a list of dictionaries that should be run in order per the outer-product of kwargs
-        :param eval_kw: a dictionary of keyword arguments to pass to the eval function of each component by their name and a set of keyword args. Use this to set values in the component that are not inputs to the system. No iteration occurs upon these values, they are static and irrevertable
-        :param sys_kw: a dictionary of keyword arguments to pass to the eval function of each system by their name and a set of keyword args. Use this to set values in the component that are not inputs to the system. No iteration occurs upon these values, they are static and irrevertable
-        :param kwargs: inputs are run on a product basis asusming they correspond to actual scoped vars (system.var or system.slot.var)
-
-
-        :returns: system or list of systems. If transient a set of systems that have been run with permutations of the input, otherwise a single system with all permutations input run
-        """
-        from engforge.system import System
-        from engforge.problem_context import ProblemExec
-
-        self.debug(
-            f"running [Solver].{method} {self.identity} with input {kwargs}"
-        )
-        assert hasattr(ProblemExec.class_cache,'session'), 'must be active context!'
-        # create iterable null for sequence
-        if sequence is None or not sequence:
-            sequence = [{}]
-
-        if method_kw is None:
-            method_kw = {}
-
-        # Create Keys List
-        sequence_keys = set()
-        for seq in sequence:
-            sequence_keys = sequence_keys.union(set(seq.keys()))
-
-        # RUN when not solved, or anything changed, or arguments or if forced
-        if force_solve or not self.solved or self.anything_changed or kwargs:
-            _input = self.parse_run_kwargs(**kwargs)
-
-            output = {}
-            inputs = {}
-            result = {"output": output, "input_sets": inputs}
-
-            # Pre Run Callback
-            self.pre_run_callback(eval_kw=eval_kw, sys_kw=sys_kw, **kwargs)
-
-            # Premute the input as per SS or Transient Logic
-            ingrp = list(_input.values())
-            keys = list(_input.keys())
-
-            # Iterate over components (they are assigned to the system by call)
-            for itercomp in self._iterate_components():
-                # Iterate over inputs
-                for vars in itertools.product(*ingrp):
-                    # Set the reference aliases
-                    cur = {k: v for k, v in zip(keys, vars)}
-
-                    # Iterate over Sequence (or run once)
-                    for seq in sequence:
-                        #apply sequence values
-                        icur = cur.copy()
-                        #apply sequence values
-                        if seq:
-                            icur.update(**seq)
-
-                        # Run The Method with inputs provisioned
-                        out = method(
-                            icur, eval_kw, sys_kw, cb=cb, **method_kw
-                        )
-
-                        if return_results:
-                            # store the output
-                            output[max(output) + 1 if output else 0] = out
-                            # store the input
-                            inputs[max(inputs) + 1 if inputs else 0] = icur
-
-            # nice
-            #TODO: wrap this with context manager
-            self._solved = True
-
-            # Pre Run Callback with current state
-            self.post_run_callback(eval_kw=eval_kw, sys_kw=sys_kw, **kwargs)
-
-            if return_results:
-                return result
-
-        elif not self.anything_changed:
-            self.warning(f"nothing changed, not running {self.identity}")
-
-            return
-        elif self.solved:
-            raise Exception("Analysis Already Solved")
-
-    # IO Functions
-

-[docs]
-    def parse_simulation_input(self, **kwargs):
-        """parses the simulation input
-
-        :param dt: timestep in s, required for transients
-        :param endtime: when to end the simulation
-        """
-        # timestep
-        if "dt" not in kwargs:
-            raise Exception("transients require `dt` to run")
-        # f"transients require timestep input `dt`"
-        dt = float(kwargs.pop("dt"))
-
-        # endtime
-        if "endtime" not in kwargs:
-            raise Exception("transients require `endtime` to run")
-
-        # add data
-        _trans_opts = {"dt": None, "endtime": None}
-        _trans_opts["dt"] = dt
-
-        # f"transients require `endtime` to specify "
-        _trans_opts["endtime"] = endtime = float(kwargs.pop("endtime"))
-        _trans_opts["Nrun"] = max(int(endtime / dt) + 1, 1)
-
-        # TODO: expose integrator choices
-        # TODO: add delay and signal & feedback options
-
-        return _trans_opts

-
-
-

-[docs]
-    def parse_run_kwargs(self, **kwargs):
-        """ensures correct input for simulation.
-        :returns: first set of input for initalization, and all input dictionaries as tuple.
-
-        """
-        # Validate OTher Arguments By Parameter Or Comp-Recursive
-        var_args = {k: v for k, v in kwargs.items() if "." not in k}
-        comp_args = {k: v for k, v in kwargs.items() if "." in k}
-
-        # check vars
-        inpossible = set.union(
-            set(self.input_fields()), set(self.slots_attributes())
-        )
-        argdiff = set(var_args).difference(inpossible)
-        assert not argdiff, f"bad input {argdiff}"
-
-        # check components
-        comps = set([k.split(".")[0] for k in comp_args.keys()])
-        compdiff = comps.difference(set(self.slots_attributes()))
-        assert not compdiff, f"bad slot references {compdiff}"
-
-        _input = {}
-        test = (
-            lambda v, add: isinstance(v, (int, float, str, *add)) or v is None
-        )
-
-        # vars input
-        for k, v in kwargs.items():
-            # If a slot check the type is applicable
-            subslot = self.check_ref_slot_type(k)
-            if subslot is not None:
-                # log.debug(f'found subslot {k}: {subslot}')
-                addty = subslot
-            else:
-                addty = []
-
-            # Ensure Its a List
-            if isinstance(v, numpy.ndarray):
-                v = v.tolist()
-
-            if not isinstance(v, list):
-                assert test(v, addty), f"bad values {k}:{v}"
-                v = [v]
-            else:
-                assert all(
-                    [test(vi, addty) for vi in v]
-                ), f"bad values: {k}:{v}"
-
-            if k not in _input:
-                _input[k] = v
-            else:
-                _input[k].extend(v)
-
-        return _input

-
-
-    # REFERENCE FUNCTIONS
-    # Location Funcitons
-

-[docs]
-    @classmethod
-    def locate(cls, key, fail=True) -> type:
-        """:returns: the class or attribute by key if its in this system class or a subcomponent. If nothing is found raise an error"""
-        # Nested
-        log.msg(f"locating {cls.__name__} | key: {key}")
-        val = None
-
-        if "." in key:
-            args = key.split(".")
-            comp, sub = args[0], ".".join(args[1:])
-            assert comp in cls.slots_attributes(), f"invalid {comp} in {key}"
-            comp_cls = cls.slots_attributes()[comp].type.accepted[0]
-            val = comp_cls.locate(sub, fail=True)
-
-        elif key in cls.input_fields():
-            val = cls.input_fields()[key]
-
-        elif key in cls.system_properties_classdef():
-            val = cls.system_properties_classdef()[key]
-
-        # Fail on comand but otherwise return val
-        if val is None:
-            if fail:
-                raise Exception(f"key {key} not found")
-            return None
-        return val

-
-
-

-[docs]
-    def locate_ref(self, key, fail=True, **kw):
-        """Pass a string of a relative var or property on this system or pass a callable to get a reference to a function. If the key has a `.` in it the comp the lowest level component will be returned, unless a callable is passed in which case this component will be used or the `comp` passed in the kw will be used.
-        :param key: the key to locate, or a callable to be used as a reference
-        :param comp: the component to use if a callable is passed
-        :returns: the instance assigned to this system. If the key has a `.` in it the comp the lowest level component will be returned
-        """
-
-        log.msg(f"locating {self.identity} | key: {key}")
-        val = None
-
-        #Handle callable key override
-        if callable(key):
-            comp = kw.pop("comp", self)
-            func = copy.copy(key)
-            return Ref(comp, func, **kw)
-        else:
-            assert 'comp' not in kw, f"comp kwarg not allowed with string key {key}"
-
-        if "." in key:
-            args = key.split(".")
-            comp, sub = args[0], ".".join(args[1:])
-            assert comp in self.slots_attributes(), f"invalid {comp} in {key}"
-            # comp_cls = cls.slots_attributes()[comp].type.accepted[0]
-            comp = getattr(self, comp)
-            if "." not in key:
-                return Ref(comp, sub, **kw)
-            if comp:
-                return comp.locate_ref(sub, fail=fail, **kw)
-            else:
-                return None
-
-        elif key in self.input_fields():
-            # val= cls.input_fields()[key]
-            return Ref(self, key, **kw)
-
-        elif key in self.system_properties_classdef():
-            # val= cls.system_properties_classdef()[key]
-            return Ref(self, key, **kw)
-
-        elif (
-            key in self.internal_configurations()
-            or key in self.slots_attributes()
-        ):
-            return Ref(self, key, **kw)
-
-        # Fail on comand but otherwise return val
-        if val is None:
-            if fail:
-                raise Exception(f"key {key} not found")
-            return None
-        return val

-
-
-    # Reference Caching
-    #TODO: move to problem context
-

-[docs]
-    def system_references(self, recache=False,numeric_only=False,**kw):
-        """gather a list of references to attributes and"""
-        if not numeric_only and not kw and (recache == False and hasattr(self, "_prv_system_references")):
-            return self._prv_system_references
-
-        out = self.internal_references(recache,numeric_only=numeric_only)
-        tatr = out["attributes"]
-        tprp = out["properties"]
-        comp_dict = {'':self}
-        out['components'] = comp_set_ref = {}
-
-        # component iternals
-        for key, comp in self.comp_references(**kw).items():
-            sout = comp.internal_references(recache,numeric_only=numeric_only)
-            satr = sout["attributes"]
-            sprp = sout["properties"]
-            
-            #find the parent component
-            key_segs = key.split('.')
-            if len(key_segs) == 1:
-                parent = ''
-            else:
-                parent = '.'.join(key_segs[:-1])
-
-            #parent refs for assigning a component
-            comp_dict[key] = comp
-            if parent in comp_dict:
-                attr_name = key.split('.')[-1]
-                comp_set_ref[key] = Ref(comp_dict[parent],attr_name,False,True)
-
-            # Fill in
-            for k, v in satr.items():
-                if k in skipa_attr_names:
-                    continue
-                tatr[f"{key}.{k}"] = v
-
-            for k, v in sprp.items():
-                tprp[f"{key}.{k}"] = v
-
-        if not numeric_only and not kw : self._prv_system_references = out
-        return out

-
-    
-

-[docs]
-    def collect_comp_refs(self,conf:"Configuration"=None,**kw):
-        """collects all the references for the system grouped by component"""    
-        if conf is None:
-            conf = self
-        comp_dict = {}
-        attr_dict = {}
-        cls_dict = {}
-        out = {'comps':comp_dict,'attrs':attr_dict,'type':cls_dict}
-        for key, lvl, conf in self.go_through_configurations(**kw):
-            comp_dict[key] = conf
-            attr_dict[key] = conf.collect_inst_attributes()
-
-        return out

-
-    
-    
-

-[docs]
-    def collect_solver_refs(self,conf:"Configuration"=None,check_atr_f=None,check_kw=None,check_dynamics=True,**kw):
-        """collects all the references for the system grouped by function and prepended with the system key"""    
-        from engforge.attributes import ATTR_BASE
-        from engforge.engforge_attributes import AttributedBaseMixin
-        
-        confobj = conf
-        if confobj is None:
-            confobj = self
-
-        comp_dict = {}
-        attr_dict = {}
-        cls_dict = {}
-        skipped = {}
-
-        out = {'comps':comp_dict,'attrs':attr_dict,'type':cls_dict,'skipped':skipped}
-        
-        #Go through all components
-        for key, lvl, conf in confobj.go_through_configurations(**kw):
-
-            if conf is None:
-                continue
-            
-            if hasattr(conf,'_solver_override') and conf._solver_override:
-                continue
-
-            #Get attributes & attribute instances
-            atrs = conf.collect_inst_attributes()
-            rawattr = conf.collect_inst_attributes(handle_inst=False)
-            key = f'{key}.' if key else '' #you need a dot if there's a key
-            comp_dict[key] = conf
-            #Gather attribute heirarchy and make key.var the dictionary entry
-            for atype,aval in atrs.items():
-                
-                ck_type = rawattr[atype]
-                if atype not in cls_dict:
-                    cls_dict[atype] = {}
-
-                if isinstance(aval,dict) and aval:
-                                       
-                    for k,pre,val in ATTR_BASE.unpack_atrs(aval,atype):
-
-                        #No Room For Components (SLOTS feature)
-                        if isinstance(val,(AttributedBaseMixin,ATTR_BASE)):
-                            if conf.log_level <= 5:
-                                conf.debug(f'skipping comp attr {val}')
-                            continue   
-
-                        if val is None:
-                            continue
-
-                        if conf.log_level <= 5:
-                            conf.msg(f'')
-                            conf.msg(f'got val: {k} {pre} {val}')  
-
-                        slv_type = None
-                        pre_var = pre.split('.')[-1]
-                        if hasattr(conf,pre_var):
-                            _var = getattr(conf,pre_var)
-                            if isinstance(_var,AttributeInstance):
-                                slv_type = _var
-                            conf.msg(f'slv type: {conf.classname}.{pre_var} -> {_var}')
-
-                        val_type = ck_type[pre_var]
-
-                        #Otherwise assign the data from last var and the compoenent name
-                        var_name = pre_var #prer alias
-                        if slv_type:
-                            var_name = slv_type.get_alias(pre)
-                        
-                        #Keep reference to the original type and name
-                        scope_name = f'{key}{var_name}'
-                        cls_dict[atype][scope_name] = val_type
-                        
-                        if conf.log_level <= 5:
-                            conf.msg(f'rec: {var_name} {k} {pre} {val} {slv_type}')
-
-                        #Check to skip this item
-                        #keep references even if null
-                        pre = f'{atype}.{k}' #pre switch
-                        if pre not in attr_dict:
-                            attr_dict[pre] = {}
-                        
-                        if isinstance(val,Ref) and val.allow_set:
-                            #its a var, skip it if it's already been skipped
-                            current_skipped = [set(v) for v in skipped.values()]
-                            if current_skipped and val.key in set.union(*current_skipped):
-                                continue
-                        
-                        #Perform the check
-                        if check_atr_f and not check_atr_f(pre,scope_name,val_type,check_kw):
-                            if conf.log_level <= 5:
-                                conf.msg(f'chk skip {scope_name} {k} {pre} {val}')
-                            if pre not in skipped:
-                                skipped[pre] = []
-
-                            if isinstance(val,Ref) and val.allow_set:
-                                #its a var
-                                skipped[pre].append(f'{key}{val.key}') 
-                            else:
-                                #not objective or settable, must be a obj/cond
-                                skipped[pre].append(scope_name)
-                            continue
-
-                        #if the value is a dictionary, unpack it with comp key
-                        if val:
-                            attr_dict[pre].update({scope_name:val})
-                        else:
-                            if attr_dict[pre]:
-                                continue #keep it!
-                            else:
-                                attr_dict[pre] = {} #reset it
-
-                elif atype not in attr_dict or not attr_dict[atype]:
-                   #print(f'unpacking {atype} {aval}')
-                   attr_dict[atype] = {}
-        
-        #Dynamic Variables Add, following the skipped items
-        if check_dynamics:
-            dyn_refs = self.collect_dynamic_refs(confobj).copy()
-            #house keeping to organize special returns 
-            
-            #TODO: generalize this with a function to update the attr dict serach result when changing components
-            out['dynamic_comps'] = dyn_comp = dyn_refs.pop('dynamic_comps',{})
-            
-            #Check the dynamics for the system
-            if check_atr_f or any([v for v in skipped.values()]):
-
-                skipd = set()
-                #check each group of dynamics
-                for pre,refs in dyn_refs.items():
-                    
-                    if pre not in skipped:
-                        skipped[pre] = []
-
-                    if pre not in attr_dict:
-                        attr_dict[pre] =  {} #initalize dynamic group
-                    
-                    #eval each ref for inclusion
-                    for var,ref in refs.items():
-                        
-                        key_segs = var.split('.')
-                        key = '' if len(key_segs) == 1 else '.'.join(key_segs[:-1])
-                        scoped_name = f'{var}'
-                        conf = dyn_comp.get(key)                        
-
-                        is_ref = isinstance(ref,Ref) 
-                        if not is_ref:
-                            conf.info(f'not ref {scoped_name}')
-                            continue
-
-                        if is_ref and not ref.allow_set:
-                            #adding unsettables (likely rates)
-                            attr_dict[pre].update(**{var:ref})
-                            self.debug(f'set escape: {scoped_name} {ref}')
-                            continue
-                        
-                        val_type = ref.comp
-                        if check_atr_f and isinstance(var,str) and check_atr_f(pre,var,val_type,check_kw):
-                            conf.msg(f'dynvar add {pre,var,val_type,skipd}')
-                            attr_dict[pre].update(**{var:ref})
-                        else:
-                            conf.msg(f'dynvar endskip {pre,var,val_type,skipd}')
-                            if check_atr_f: #then it didn't checkout
-                                skipped[pre].append(scope_name)
-
-            else:
-                #There's no checks to be done, just add these
-                attr_dict.update(**dyn_refs)
-        else:
-            cpy = dflt_dynamics.copy()
-            cpy.pop('dynamic_comps',{})
-            attr_dict.update(cpy)
-            
-                         
-
-        return out

-
-
-    #Dynamics info refs
-

-[docs]
-    def collect_dynamic_refs(
-        self, conf: "Configuration" = None, **kw
-    ) -> dict:
-        """collects the dynamics of the systems
-        1. Time.integrate
-        2. Dynamic Instances
-        """
-        from engforge.dynamics import DynamicsMixin
-        if conf is None:
-            conf = self
-        dynamics = {k:{} for k in dflt_dynamics}
-
-        for key, lvl, conf in conf.go_through_configurations(**kw):
-            # FIXME: add a check for the dynamics mixin, that isn't hacky
-            # BUG: importing dynamicsmixin resolves as different class in different modules, weird
-            # if "dynamicsmixin" not in str(conf.__class__.mro()).lower():
-            #     continue
-            if not isinstance(conf, DynamicsMixin) or not conf.is_dynamic:
-                continue
-
-            sval = f'{key}.' if key else ''
-            scope = lambda d: {f'{sval}{k}':v for k,v in d.items()}
-            dynamics['dynamics.state'].update(scope(conf.Xt_ref))
-            dynamics['dynamics.input'].update(scope(conf.Ut_ref))
-            dynamics['dynamics.output'].update(scope(conf.Yt_ref))
-            dynamics['dynamics.rate'].update(scope(conf.dXtdt_ref))
-            dynamics['dynamic_comps'][key] = conf
-
-        return dynamics

-
-
-
-

-[docs]
-    def get_system_input_refs(
-        self,
-        strings=False,
-        numeric=True,
-        misc=False,
-        all=False,
-        boolean=False,
-        **kw,
-    ) -> dict:
-        """
-        Get the references to system input based on the specified criteria.
-
-        :param strings: Include system properties of string type.
-        :param numeric: Include system properties of numeric type (float, int).
-        :param misc: Include system properties of miscellaneous type.
-        :param all: Include all system properties regardless of type.
-        :param boolean: Include system properties of boolean type.
-        :param kw: Additional keyword arguments passed to recursive config loop
-        :return: A dictionary of system property references.
-        :rtype: dict
-        """
-        from engforge.tabulation import SKIP_REF
-        refs = {}
-        for ckey, lvl, comp in self.go_through_configurations(**kw):
-            if comp is None:
-                continue
-            for p, atr in comp.input_fields().items():
-                if p in SKIP_REF and not all:
-                    continue
-                if all:
-                    refs[(f"{ckey}." if ckey else "") + p] = Ref(
-                        comp, p, False, True
-                    )
-                    continue
-                elif atr.type:
-                    ty = atr.type
-                    if issubclass(ty, (bool)):
-                        if not boolean:
-                            continue  # prevent catch at int type
-                        refs[(f"{ckey}." if ckey else "") + p] = Ref(
-                            comp, p, True, False
-                        )
-                    elif issubclass(ty, (float, int)) and numeric:
-                        refs[(f"{ckey}." if ckey else "") + p] = Ref(
-                            comp, p, False, True
-                        )
-                    elif issubclass(ty, (str)) and strings:
-                        refs[(f"{ckey}." if ckey else "") + p] = Ref(
-                            comp, p, False, True
-                        )
-                    elif misc:
-                        refs[(f"{ckey}." if ckey else "") + p] = Ref(
-                            comp, p, False, True
-                        )
-
-        return refs

-

-
-
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/solver.html b/docs/_build/html/_modules/engforge/solver.html deleted file mode 100644 index 2785c56..0000000 --- a/docs/_build/html/_modules/engforge/solver.html +++ /dev/null @@ -1,450 +0,0 @@ - - - - - - engforge.solver — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.solver

-"""solver defines a SolverMixin for use by System.
-
-Additionally the Solver attribute is defined to add complex behavior to a system as well as add constraints and transient integration.
-
-### A general Solver Run Will Look Like:
-0. run pre execute (signals=pre,both)
-1. add execution context with **kwargument for the signals. 
-2. parse signals here (through a new Signals.parse_rtkwargs(**kw)) which will non destructively parse the signals and return all the signal candiates which are put into an ProblemExec object that resets the signals after the run depending on the revert behavior
-3. the execute method will recieve this ProblemExec object where it can update the solver references / signals so that it can handle them per the signals api
-4. with self.execution_context(**kwargs) as ctx_exe: 
-    1. pre-update / signals
-    <FLEXIBLE_Exec>#self.execute(ctx_exe,**kwargs) 
-    2. post-update / signals
-    > signals will be reset after the execute per the api
-5. run post update
-6. exit condition check via problem context input
-"""
-
-import attrs
-import uuid
-import numpy
-import scipy.optimize as scopt
-from contextlib import contextmanager
-import copy
-import datetime
-
-# from engforge.dynamics import DynamicsMixin
-from engforge.properties import *
-from engforge.solveable import SolveableMixin
-from engforge.system_reference import *
-import pprint
-import itertools, collections
-import inspect
-
-SOLVER_OPTIONS = ["minimize"]#"root", "global", 
-from engforge.solver_utils import *
-from engforge.problem_context import *
-from engforge.attr_solver import Solver,SolverInstance
-import sys
-

-[docs]
-class SolverLog(LoggingMixin):
-    pass

-
-
-
-log = SolverLog()
-
-
-# add to any SolvableMixin to allow solver use from its namespace
-

-[docs]
-class SolverMixin(SolveableMixin):
-    """A base class inherited by solveable items providing the ability to solve itself"""
-
-    #TODO: implement constraint equality solver as root
-    
-    # Configuration Information
-    @property
-    def solved(self):
-        if self.last_context is None: 
-            return False        
-        elif self.last_context.data:
-            return True
-        return False
-    
-    # Replaces Tabulation Method
-    @solver_cached
-    def data_dict(self):
-        """records properties from the entire system, via system references cache"""
-        out = collections.OrderedDict()
-        sref = self.system_references()
-        for k, v in sref["attributes"].items():
-            val = v.value()
-            if isinstance(val, TABLE_TYPES):
-                out[k] = val
-            else:
-                out[k] = numpy.nan
-        for k, v in sref["properties"].items():
-            val = v.value()
-            if isinstance(val, TABLE_TYPES):
-                out[k] = val
-            else:
-                out[k] = numpy.nan
-        return out    
-    
-    #Official Solver Interface
-

-[docs]
-    def solver_vars(self,check_dynamics=True,addable=None,**kwargs):
-        """applies the default combo filter, and your keyword arguments to the collect_solver_refs to test the ref / vars creations
-        
-        parses `add_vars` in kwargs to append to the collected solver vars
-        :param add_vars: can be a str, a list or a dictionary of variables: solver_instance kwargs. If a str or list the variable will be added with positive only constraints. If a dictionary is chosen, it can have keys as parameters, and itself have a subdictionary with keys: min / max, where each respective value is placed in the constraints list, which may be a callable(sys,prob) or numeric. If nothing is specified the default is min=0,max=None, ie positive only.
-        """
-        from engforge.solver import combo_filter
-
-        out = self.collect_solver_refs(check_atr_f=combo_filter,check_kw=kwargs,check_dynamics=check_dynamics)
-
-        base_const = {'min':0,'max':None} #positive only
-
-        #get add_vars and add to attributes
-        if addable and ( addvar:= kwargs.get('add_vars',[])):
-            matches = []
-            if addvar:
-                
-                #handle csv, listify string
-                if isinstance(addvar,str):
-                    addvar = addvar.split(',')
-                
-                #handle dictionary                    
-                added = set(())
-                avars = list(addable['attributes'].keys())
-                for av in addvar: #list/dict-keys
-                    matches = set(fnmatch.filter(avars,av))
-                    #Lookup Constraints if input is a dictionary
-                    if isinstance(addvar,dict) and isinstance(addvar[av],dict):
-                        const = base_const.copy()
-                        const.update(addvar[av])
-                    elif isinstance(addvar,dict):
-                        raise ValueError(f'dictionary must have a subdictionary for {av}')
-                    else:
-                        const = base_const.copy()
-
-                    #for each match we add the variable
-                    for mtch in matches:
-                        if mtch in added:
-                            continue #add only once
-                        else:
-                            added.add(mtch)
-
-                        if self.log_level < 5:
-                            self.msg(f'adding {mtch} to solver vars')
-                        #add constraint values and type/instance
-                        ref = addable['attributes'][mtch].copy()
-                        mtch_type = Solver.declare_var(mtch) #type
-                        #bounds
-                        mtch_type.constraints[0]['value'] = const['min']
-                        mtch_type.constraints[1]['value'] = const['max'] 
-                        #instance
-                        mtch_inst = SolverInstance(mtch_type,self)
-                        #attach
-                        out['attrs']['solver.var'][mtch] = ref
-                        out['type']['solver'][mtch] = mtch_inst
-
-        return out

-
-    
-
-

-[docs]
-    def post_run_callback(self, **kwargs):
-        """user callback for when run is complete"""
-        pass

-
-
-

-[docs]
-    def pre_run_callback(self, **kwargs):
-        """user callback for when run is beginning"""
-        pass

-
-
-

-[docs]
-    def run(self, **kwargs):
-        """the steady state run the solver for the system. It will run the system with the input vars and return the system with the results. Dynamics systems will be run so they are in a steady state nearest their initial position."""
-
-        if 'opt_fail' not in kwargs:
-            kwargs['opt_fail'] = False
-
-        with ProblemExec(self,kwargs,level_name='run') as pbx:
-            #problem context removes slv/args from kwargs
-            return self._iterate_input_matrix(self.eval, return_results=True,**kwargs)

-
-
-
-

-[docs]
-    def run_internal_systems(self, sys_kw=None):
-        """runs internal systems with potentially scoped kwargs"""
-        # Pre Execute Which Sets Fields And PRE Signals
-        from engforge.system import System
-
-        # Record any changed state in components here, important for iterators
-        if isinstance(self, System):
-            self.system_references(recache=True)
-
-        # System Solver Loop
-        for key, comp in self.internal_systems().items():
-            if hasattr(comp,'_solver_override') and comp._solver_override:
-                if sys_kw and key in sys_kw:
-                    sys_kw_comp = sys_kw[key]
-                else:
-                    sys_kw_comp = {}
-
-                # Systems solve cycle
-                if isinstance(comp, System):  # should always be true
-                    self.info(f"solving {key} with {sys_kw_comp}")
-                    comp.eval(**sys_kw_comp)

-
- 
-    # Single Point Flow
-

-[docs]
-    def eval(
-        self, Xo=None,eval_kw: dict = None, sys_kw: dict = None,cb=None, **kw
-    ):
-        """Evaluates the system with pre/post execute methodology
-        :param kw: kwargs come from `sys_kw` input in run ect.
-        :param cb: an optional callback taking the system as an argument of the form (self,eval_kw,sys_kw,**kw)
-        """
-
-        # Transeint
-        from engforge.system import System
-        if kw.pop('refresh_references',True) and isinstance(self, System):
-            #recache is important for iterators #TODO: only with iterable comps
-            self.system_references(recache=True)    
-
-        #default behavior of system is to accept non-optimal results but describe the behavior anyways
-        if 'opt_fail' not in kw:
-            kw['opt_fail'] = False
-
-        
-        self.debug(f"running with kw:{kw}")
-        
-        #execute with problem context and execute signals
-        with ProblemExec(self,kw,level_name='eval',eval_kw=eval_kw, sys_kw=sys_kw,post_callback=cb,Xnew=Xo) as pbx:
-            out = self.execute(**kw)
-            pbx.exit_to_level(level='eval',revert=False)
-
-        if self.log_level >= 20:
-            sys.stdout.write('.')
-
-        return out

-
-
-

-[docs]
-    def execute(self,**kw):
-        """Solves the system's system of constraints and integrates transients if any exist
-
-        Override this function for custom solving functions, and call `solver` to use default solver functionality.
-
-        :returns: the result of this function is returned from solver()
-        """
-        # steady state
-        dflt = dict()#obj=None, cons=True, X0=None, dXdt=0)
-        dflt.update(kw)
-        return self.solver(**dflt)

-
-
-    # TODO: add global optimization search for objective addin, via a new  `search_optimization` method.
-
-    # TODO: code options for transient integration
-

-[docs]
-    def solver(
-            self, enter_refresh=True,save_on_exit=True,**kw
-        ):
-            """
-            runs the system solver using the current system state and modifying it. This is the default solver for the system, and it is recommended to add additional options or methods via the execute method.
-
-            
-
-            :param obj: the objective function to minimize, by default will minimize the sum of the squares of the residuals. Objective function should be a function(system,Xs,Xt) where Xs is the system state and Xt is the system transient state. The objective function will be argmin(X)|(1+custom_objective)*residual_RSS when `add_obj` is True in kw otherwise argmin(X)|custom_objective with constraints on the system as balances instead of first objective being included.
-            :param cons: the constraints to be used in the solver, by default will use the system's constraints will be enabled when True. If a dictionary is passed the solver will use the dictionary as the constraints in addition to system constraints. These can be individually disabled by key=None in the dictionary.
-
-            :param X0: the initial guess for the solver, by default will use the current system state. If a dictionary is passed the solver will use the dictionary as the initial guess in addition to the system state.
-            :param dXdt: can be 0 to indicate steady-state, or None to not run the transient constraints. Otherwise a partial dictionary of vars for the dynamics rates can be given, those not given will be assumed steady state or 0.
-
-            :param kw: additional options for the solver, such as the solver_option, or the solver method options. Described below
-            :param combos: a csv str or list of combos to include, including wildcards. the default means all combos will be run unless ign_combos or only combos alters behavior. The initial selection of combos is made by matching any case with the full name of the combo, or a parial name with a wildcard(s) in the combo name Ignore and only combos will further filter the selection. Wildcards / queries per fnmatch
-            :param ign_combos: a list of combo vars to ignore.
-            :param only_combos: a list of combo vars to include exclusively.
-            :param add_var: a csv str or variables to include, including wildcards. the default means all combos will be run unless ign_combos or only combos alters behavior. The initial selection of combos is made by matching any case with the full name of the combo, or a parial name with a wildcard(s) in the combo name Ignore and only combos will further filter the selection. Wildcards / queries per fnmatch
-            :param ign_var: a list of combo vars to ignore.
-            :param only_var: a list of combo vars to include exclusively.            
-            :param add_obj: a flag to add the objective to the system constraints, by default will add the objective to the system constraints. If False the objective will be the only constraint.
-            :param only_active: default True, will only look at active variables objectives and constraints
-            :param activate: default None, a list of solver vars to activate
-            :param deactivate: default None, a list of solver vars to deactivate (if not activated above)
-            """
-
-            #to your liking sir
-            opts = {} #TODO: add defaults
-            opts.update(kw) #your custom args!
-                   
-            #use problem execution context
-            self.debug(f'starting solver: {opts}')
-            
-            with ProblemExec(self,opts,level_name='sys_slvr',enter_refresh=enter_refresh,save_on_exit=save_on_exit) as pbx:
-                
-                #Use Solver Context to Solve
-                out = pbx.solve_min(**opts)
-                has_ans = 'ans' in out
-                #depending on the solver success, failure or no solution, we can exit the solver
-                if has_ans and out['ans'] and out['ans'].success:
-                    #this is where you want to be! <<<
-                    pbx.set_ref_values(out['Xans'])
-                    pbx.exit_to_level('sys_slvr',False)
-
-                elif has_ans and out['ans'] is None:
-                    #deterministic input based case for updates / signals
-                    self.debug(f'exiting solver with no solution {out}')
-                    pbx.exit_with_state() 
-
-                else:
-                    #handle failure options
-                    if pbx.opt_fail:
-
-                        #if log.log_level < 15:
-                        pbx.warning(f'Optimization Failed: {pbx.sys_refs} | {pbx.constraints}')
-
-                        #if log.log_level < 5:
-                        pbx.debug(f'{pbx.__dict__}')
-
-                        ve = f"Solver failed to converge: {out['ans']}"
-                        raise ValueError(ve)
-                    
-                    if pbx.fail_revert:
-                        pbx.exit_and_revert()
-                    else:
-                        pbx.exit_with_state()  
-                #close context
-            
-            #return output
-            return out

-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/solver_utils.html b/docs/_build/html/_modules/engforge/solver_utils.html deleted file mode 100644 index b85beac..0000000 --- a/docs/_build/html/_modules/engforge/solver_utils.html +++ /dev/null @@ -1,840 +0,0 @@ - - - - - - engforge.solver_utils — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.solver_utils

-from engforge.system_reference import *
-from engforge.logging import LoggingMixin
-#from engforge.execution_context import *
-
-import fnmatch
-
-

-[docs]
-class SolverUtilLog(LoggingMixin): pass

-
-log = SolverUtilLog() 
-
-# Objective functions & Utilities
-

-[docs]
-def f_lin_min(system,prob, Xref, Yref,weights=None, *args, **kw):
-    """
-    Creates an anonymous function with stored references to system, Yref, weights, that returns a scipy optimize friendly function of (x, Xref, *a, **kw) x which corresponds to the order of Xref dicts, and the other inputs are up to application.
-
-    :param system: the system object
-    :param Xref: a dictionary of reference values for X
-    :param Yref: a dictionary of reference values for Y
-    :param weights: optional weights for Yref
-    :param args: additional positional arguments
-    :param kw: additional keyword arguments
-
-    :return: the anonymous function
-    """
-    from engforge.problem_context import ProblemExec
-
-    #TODO: move these to problem context!!!
-    mult_pos = kw.pop("mult_pos", 1)
-    exp_pos = kw.pop("exp_pos", 1)
-    mult_neg = kw.pop("mult_neg", 1)
-    exp_neg = kw.pop("exp_neg", 1)
-    gam = norm_base = kw.pop("norm_base", 1)
-    inputs = [mult_neg,exp_neg,mult_pos,exp_pos,gam,norm_base]
-    is_lin = all(v==1 for v in inputs)
-
-    solver_ref =  system.collect_solver_refs()
-    solver_types = solver_ref.get('type',{}).get('solver',{})
-    base_dict = {'system':system,'Yref':Yref,'weights':weights,'args':args,'kw':kw}
-    xkey = "_".join(Xref.keys())
-    ykey = "_".join(Yref.keys())
-    alias_name = kw.pop("alias_name", f'min_X_{xkey}_Y_[{ykey}]')
-
-    vars = list(Xref.keys())  # static x_basis
-    yvar = list(Yref.keys())
-    weights = weights if weights is not None else np.ones(len(Yref))
-
-    def f(x, *rt_a,**rt_kw):
-        # anonymous function
-        
-        Xnext = {p:xi for p, xi in zip(vars, x)}
-
-        if rt_a or rt_kw:
-            slv_info = base_dict.copy()
-            slv_info.update({'rt_a':rt_a,'kw':rt_kw})
-        else:
-            slv_info = base_dict
-
-        #with revert_X(system,Xref,Xnext=Xnext):
-        #this will run all signals and updates selected in outer context
-        with ProblemExec(system,{},Xnew=Xnext,ctx_fail_new=True) as exc:
-            grp = (yvar, weights)
-            vals,pos,neg = [],[],[]
-            for p,n in zip(*grp):
-                ty = solver_types.get(p,None)
-                if ty is None or not hasattr(ty.solver,'kind')  or ty.solver.kind == 'min':
-                    arry = pos
-                elif ty.solver.kind == 'max':
-                    arry = neg
-                else:
-                    system.warning(f'non minmax obj: {p} {ty.solver.kind}')
-
-                ref = Yref[p]
-                val = eval_ref(ref,system,prob) * n
-                arry.append( val )
-                vals.append( val )
-
-            if not is_lin:
-                ps = mult_pos*np.array( pos )**exp_pos
-                #Min-Max Logic
-                if neg:
-                    ns = mult_neg*np.array( neg )**exp_neg
-                    ns = np.sum(ns)
-                    out= np.sum(ps)**gam - np.sum(ns)**gam
-                else:
-                    out = mult_pos*np.sum(ps)**gam
-                
-                if system.log_level < 5:
-                    system.debug(f'obj {alias_name}: {x} -> {vals}')
-
-                return out  # n sized normal residual vector
-            else:
-                #the faster linear case
-                if neg:
-                    return np.sum(np.array( pos )) - np.sum(np.array( neg ))
-                else:
-                    return np.sum(np.array( pos ))
-                
-    f.__name__ = f'min_Y_{"_".join(Yref.keys())}_X_{"_".join(Xref.keys())}]'
-
-    return f

-
-
-# signature in solve: refmin_solve(system,system,Xref)
-

-[docs]
-def objectify(function,system,Xrefs,prob=None,*args,**kwargs):
-    """converts a function f(system,slv_info:dict) into a function that safely changes states to the desired values and then runs the function. A function is returend as f(x,*args,**kw)"""
-    from engforge.problem_context import ProblemExec
-    base_dict = dict(system=system,Xrefs=Xrefs,args=args,**kwargs)
-    lvl_name = f'obj_{str(function.__name__.split("<function")[0])}'
-    alias_name = kwargs.pop("alias_name",lvl_name)
-    
-    prob = prob
-
-    #hello anonymous function
-    def f_obj(x,*rt_args,**rt_kwargs):
-        new_state = {p: x[i] for i, p in enumerate(Xrefs)}
-        #Enter existing problem context
-        with ProblemExec(system,{},Xnew=new_state,ctx_fail_new=True,level_name=lvl_name) as exc:
-            updtinfo = base_dict.copy()
-            updtinfo.update(x=x,rt_args=rt_args, **rt_kwargs)
-            prob = locals().get('prob',updtinfo)
-
-            out= function(system,prob)
-            if system.log_level <= 10:
-                system.debug(f'obj {alias_name}: {x} -> {out}')
-            return out        
-    
-    if system.log_level < 3:
-        system.msg(f'obj setup {function} - > {f_obj}')
-        system.msg(inspect.getsource(function))
-
-    fo = lambda x,*a,**kw: f_obj(x,prob,*a,**kw)
-    fo.__name__ =f'OBJ_{alias_name}'
-    return fo

-
-
-

-[docs]
-def secondary_obj(
-    obj_f, system,Xrefs,normalize=None,base_func=f_lin_min,*args,**kwargs
-):  
-    """modifies an objective function with a secondary function that is only considered when the primary function is minimized."""
-    from engforge.problem_context import ProblemExec
-    vars = list(Xrefs.keys())  # static x_basis
-    base_dict = dict(system=system,args=args,Xrefs=Xrefs,**kwargs)
-    lvl_name = f'{obj_f.__name__}_scndry'
-    alias_name = kwargs.pop("alias_name", lvl_name)
-
-    def f(x,*rt_args,**rt_kwargs): 
-
-        new_state = {p: x[i] for i, p in enumerate(Xrefs)}
-        base_call = base_func(system, Xrefs, normalize)        
-        #with revert_X(system, Xrefs,Xnext=new_state) as x_prev:
-
-        #Enter existing problem context
-        with ProblemExec(system,{},Xnew=new_state,ctx_fail_new=True,level_name=lvl_name) as exc:
-            A = base_call(x)
-            solver_info = base_dict.copy()
-            solver_info.update(x=x,Xrefs=Xrefs,normalize=normalize,rt_args=rt_args, **rt_kwargs)
-
-            out =  A * (1 + obj_f(system, solver_info))
-            if system.log_level < 5:
-                system.msg(f'obj {alias_name}: {x} -> {out}')
-            return out
-        
-    if system.log_level < 18:
-        system.debug(f'secondary setup {obj_f} - > {f}')
-        system.debug(inspect.getsource(function))        
-
-    return f

-
-
-

-[docs]
-def ref_to_val_constraint(system,ctx,Xrefs,var_ref,kind,val,contype='ineq',return_ref=False,*args,**kwargs):
-    """takes a var reference and a value and returns a function that can be used as a constraint for min/max cases. The function will be a function of the system and the info dictionary. The function will return the difference between the var value and the value.
-    """
-    info = ctx
-    #info = {'system':system,'Xrefs':Xrefs,'var_ref':var_ref,'kind':kind,'val':val,'args':args,'kwargs':kwargs}
-    p = var_ref
-    if isinstance(val,Ref):
-        if kind == 'min':
-            fun = lambda system,info: p.value(system,info) - val.value(system,info)
-        else:
-            fun = lambda system,info: val.value(system,info) - p.value(system,info)
-        fun.__name__ = f'REF{val.comp}.{kind}.{p.key}'
-        ref = Ref(val.comp,fun)
-    #Function Case
-    elif callable(val):
-        #print('ref to val con', val,kind,p)
-        if kind == 'min':
-            fun = lambda system,info: p.value(system,info) - val(system,info)
-        else:
-            fun = lambda system,info: val(system,info) - p.value(system,info)
-        fun.__name__ = f'REF.{kind}.{val.__name__}'
-        ref = Ref(p.comp,fun) #comp shouldn't matter
-    elif isinstance(val,(int,float)):
-        if kind == 'min':
-            fun = lambda system,info: p.value(system,info) - val
-        else:
-            fun = lambda system,info: val - p.value(system,info)
-        fun.__name__ = f'REF.{kind}.{val}'
-        ref = Ref(p.comp,fun) #comp shouldn't matter
-    else:
-        raise ValueError(f"bad constraint value: {val}")
-    
-    if return_ref:
-        return ref
-    
-    #Make Objective
-    return create_constraint(system,Xrefs,contype,ref,*args,**kwargs)

-
-
-

-[docs]
-def create_constraint(
-    system,Xref, contype: str, ref, con_args=None,*args, **kwargs
-):
-    """creates a constraint with bounded solver input from a constraint definition in dictionary with type and value. If value is a function it will be evaluated with the extra arguments provided. If var is None, then the constraint is assumed to be not in reference to the system x vars, otherwise lookups are made to that var.
-    
-    Creates F(x_solver:array) such that the current vars of system are reverted to after the function has returned, which is used directly by SciPy's optimize.minimize
-    
-    """
-    assert contype in (
-        "eq",
-        "ineq",
-    ), f"bad constraint type: {contype}"
-
-    if system.log_level < 5:
-        system.debug(f'create constraint {contype} {ref} {args} {kwargs}| {con_args}')
-
-    # its a function
-    _fun = lambda *args,**kw: ref.value(*args,**kw)
-    _fun.__name__ = f'const_{contype}_{ref.comp.classname}_{ref.key}'
-    fun = objectify(_fun,system,Xref,*args,**kwargs)
-    cons = {"type": contype, "fun": fun}
-    if con_args:
-        cons['args'] = con_args
-    return cons

-
-
-#TODO: integrate / merge with ProblemExec (all cmted out)
-# def misc_to_ref(system,val,*args,**kwargs):
-#     """takes a var reference and a value and returns a function that can be used as a constraint for min/max cases. The function will be a function of the system and the info dictionary. The function will return the difference between the var value and the value.
-#     """
-#     if isinstance(val,Ref):
-#         #fun = lambda *a,**kw:val.value()
-#         ref = Ref(val.comp,val)
-#     #Function Case
-#     elif callable(val):
-#         fun = lambda system,info: val(system,info)
-#         fun.__name__ = val.__name__
-#         ref = Ref(None,fun) #comp shouldn't matter
-#     elif isinstance(val,(int,float)):
-#         fun = lambda system,info: val
-#         fun.__name__ = f'const_{str(val)}'
-#         ref = Ref(None,fun) #comp shouldn't matter
-#     else:
-#         raise ValueError(f"bad constraint value: {val}")
-#     
-#     return ref
-
-
-# Reference Jacobean Calculation
-#TODO: hessian ect...
-# def calcJacobean(
-#     sys, Yrefs: dict, Xrefs: dict, X0: dict = None, pct=0.001, diff=0.0001
-# ):
-#     """
-#     returns the jacobiean by modifying X' <= X*pct + diff and recording the differences. When abs(x) < pct x' = x*1.1 + diff.
-# 
-#     jacobean will be ordered by Xrefs/Yrefs, so use ordered dict to keep order
-#     """
-# 
-#     if X0 is None:
-#         X0 = refset_get(Xrefs)
-# 
-#     assert len(Xrefs) == len(X0)
-#     assert len(Yrefs) >= 1
-# 
-#     with sys.revert_X(refs=Xrefs): #TODO: replace with context manager
-#         #initalize here
-#         refset_input(Xrefs, X0)
-# 
-#         rows = []
-#         dxs = []
-#         Fbase = refset_get(Yrefs)
-#         for k, v in Xrefs.items():
-#             x = v.value()#TODO: add context manager,sys
-#             if not isinstance(x, (float, int)):
-#                 sys.warning(f"var: {k} is not numeric {x}, skpping")
-#                 continue
-# 
-#             if abs(x) > pct:
-#                 new_x = x * (1 + pct) + diff
-#             else:
-#                 new_x = x * (1.1) + diff
-#             dx = new_x - x
-#             #print(dx, new_x, x)
-#             dxs.append(dx)
-# 
-#             v.set_value(new_x)  # set delta
-#             sys.pre_execute()
-# 
-#             F_ = refset_get(Yrefs)
-#             Fmod = [(F_[k] - fb) / dx for k, fb in Fbase.items()]
-# 
-#             rows.append(Fmod)
-#             v.set_value(x)  # reset value
-# 
-#     return np.column_stack(rows)
-
-
-#TODO: integrate / merge with ProblemExec (all below)
-

-[docs]
-def refmin_solve(
-    system,
-    prob,
-    Xref: dict,
-    Yref: dict,
-    Xo=None,
-    weights: np.array = None,
-    ffunc=f_lin_min,
-    **kw,
-):
-    """minimize the difference between two dictionaries of refernces, x references are changed in place, y will be solved to zero, options ensue for cases where the solution is not ideal
-
-    :param Xref: dictionary of references to the x values, or independents
-    :param Yref: dictionary of references to the value of objectives to be minimized
-    :param Xo: initial guess for the x values as a list against Xref order, or a dictionary
-    :param weights: a dictionary of values to weights the x values by, list also ok as long as same length and order as Xref
-    :param reset: if the solution fails, reset the x values to their original state, if true will reset the x values to their original state on failure overiding doset.
-    :param doset: if the solution is successful, set the x values to the solution by default, otherwise follows reset, if not successful reset is checked first, then doset
-    """
-    vars = list(Xref.keys())  # static x_basis
-    
-    # The above code is a Python script that includes a TODO comment indicating
-    # that x-normalization needs to be incorporated into the code. The code itself
-    # is not shown, but it likely involves some operations on a variable or data
-    # structure named "x" that require normalization. The TODO comment serves as a
-    # reminder for the developer to implement this functionality at a later time.
-    #TODO: incorporate x-normilization
-    norm_x,weights = handle_normalize(weights,Xref,Yref)
-
-    # make objective function
-    Fc = ffunc(system,prob,Xref,Yref,weights)
-    Fc.__name__ = ffunc.__name__
-
-    if Xo is None:
-        Xo = [Xref[p].value() for p in vars]
-
-    elif isinstance(Xo, dict):
-        Xo = [Xo[p] for p in vars]
-
-    # TODO: IO for jacobean and state estimations (complex as function definition, requires learning)
-    system.debug(f'minimize! {Fc.__name__,Xo,vars,kw}')
-    #kw.pop('prob',None)
-    kw.pop('info',None) #info added from context constraints
-    ans = sciopt.minimize(Fc, Xo, **kw)
-    return ans

-
-
-

-[docs]
-def handle_normalize(norm,Xref,Yref):
-    vars = list(Xref.keys())  # static x_basis
-    if norm is None:
-        normX = np.ones(len(vars))
-        normY = np.ones(len(Yref))
-    elif isinstance(norm, (list, tuple, np.ndarray)):
-        assert len(norm) == len(vars), "bad length-X norm input"
-        normX = np.array(norm)
-        normY = np.ones(len(Yref)) #default to 1
-    elif isinstance(norm, (dict)):
-        normX = np.array([norm[p] if p in norm else 1 for p in vars])
-        normY = np.array([norm[p] if p in norm else 1 for p in Yref])
-
-    return normX,normY  

-
-
-
-
-#Parsing Utilities
-

-[docs]
-def arg_var_compare(var,seq):
-    if '*' in seq:
-        return fnmatch.fnmatch(var,seq)
-    else:
-        return var == seq

-
-    
-

-[docs]
-def str_list_f(out:list,sep=','):
-    if isinstance(out,str):
-        out = out.split(sep)
-    return out

-
-
-

-[docs]
-def ext_str_list(extra_kw,key,default=None):
-    if key in extra_kw:
-        out = extra_kw[key]
-        return str_list_f(out)
-    else:
-        out = default
-    return out

-
-
-SLVR_SCOPE_PARM = ['solver.eq','solver.ineq','solver.var','solver.obj','time.var','time.rate','dynamics.state','dynamics.rate']
-
-

-[docs]
-def combo_filter(attr_name,var_name, solver_inst, extra_kw,combos=None)->bool:
-    #TODO: allow solver_inst to be None for dyn-classes
-    #proceed to filter active items if vars / combos inputs is '*' select all, otherwise discard if not active
-    #corresondes to problem_context.slv_dflt_options
-    if extra_kw is None:
-        extra_kw = {}
-
-    outa = True
-    if extra_kw.get('only_active',True):
-
-        outa  =  filt_active(var_name,solver_inst,extra_kw=extra_kw,dflt=False)
-        if not outa:
-            log.msg(f'filt not active: {var_name:>10} {attr_name:>15}| C:{False}\tV:{False}\tA:{False}\tO:{False}')
-            return False
-        
-    both_match =  extra_kw.get('both_match',True)
-    #Otherwise look at the combo filter, its its false return that
-    outc = filter_combos(var_name,solver_inst, extra_kw,combos)
-    outp = None
-
-    #if the combo filter didn't explicitly fail, check the var filter
-    if (outc and both_match) or (not outc and not both_match):
-        outp = filter_vals(var_name,solver_inst, extra_kw)
-        if log.log_level <=2:
-            log.msg(f'both match? {var_name:>20}| {outp} {outc}')
-
-        if both_match:
-            outr = all((outp,outc))
-        else:
-            outr = any((outp,outc))
-    else:
-        if log.log_level <=2:
-            log.msg(f'initial match: {var_name:>20}| {outc}')
-        outr = outc
-    
-    fin =  bool(outr) and outa
-
-    if not fin:
-        log.debug(f'filter: {var_name:>20} {attr_name:>15}| C:{outc}\tV:{outp}\tA:{outa}\tO:{fin}')
-    elif fin:
-        log.debug(f'filter: {var_name:>20} {attr_name:>15}| C:{outc}\tV:{outp}\tA:{outa}\tO:{fin}| {combos}')
-
-    return fin

-
-
-#filters return true for items they want to remove
-

-[docs]
-def filter_combos(var,inst,extra_kw=None,combos_in=None):
-    from engforge.attr_solver import SolverInstance
-    from engforge.attr_dynamics import IntegratorInstance
-    from engforge.attr_signals import SignalInstance
-    #not considered
-    
-    if log.log_level <= 2:
-        log.info(f'checking combos: {var} {inst} {extra_kw} {combos_in}')
-
-    #gather combos either given or not
-    if combos_in is None and not isinstance(inst,(SolverInstance,IntegratorInstance,SignalInstance)):
-        return True
-    elif combos_in:
-        combos = combos_in
-    else:
-        combos = str_list_f(getattr(inst,'combos', 'default'))
-    
-    #parse extra kwargs
-    groups = ext_str_list(extra_kw,'combos','')
-    bm = extra_kw.get('both_match',True)
-    if groups is None:
-        return bm if bm is True else None
-    
-    igngrp = ext_str_list(extra_kw,'ign_combos',None)
-    onlygrp = ext_str_list(extra_kw,'only_combos',None)
-    
-    if not combos:
-        log.info(f'no combos for {var} {combos} {groups}')
-        return None #no combos to filter to match, its permanent
-    
-    #check values, and return on first match
-    for var in combos:
-        initial_match = [grp for grp in groups if arg_var_compare(var,grp)]
-        if not any(initial_match):
-            if log.log_level < 3:
-                log.msg(f'skip {var}: nothing ')
-            continue #not even
-
-        if onlygrp and not any(arg_var_compare(var,grp) for grp in onlygrp):
-            if log.log_level < 3:
-                log.msg(f'skip {var} not in {onlygrp}')
-            continue
-
-        if igngrp and any(arg_var_compare(var,grp) for grp in igngrp):
-            if log.log_level < 3:
-                log.msg(f'skip {var} in {igngrp}')
-            continue
-        
-        return True #you've passed all the filters and found a match
-    
-    return False    #no matches, return false

-
-    
-

-[docs]
-def filter_vals(var,inst,extra_kw=None):
-    from engforge.attr_solver import SolverInstance
-    from engforge.attr_dynamics import IntegratorInstance
-    from engforge.attr_signals import SignalInstance
-    from engforge.dynamics import DynamicsMixin
-    
-    #add_vars = ext_str_list(extra_kw,'add_vars',None)
-    groups = ext_str_list(extra_kw,'slv_vars','')
-    if groups is None:
-        return True #no var filter!
-    
-    igngrp = ext_str_list(extra_kw,'ign_vars',None)
-    onlygrp = ext_str_list(extra_kw,'only_vars',None)
-
-    if log.log_level <= 2:
-        log.info(f'checking vals: {var} {inst} {extra_kw}')
-
-    #vars not considered
-    if not isinstance(inst,(SolverInstance,IntegratorInstance,SignalInstance,DynamicsMixin)):
-        return True
-
-    #add vars overrides all other filters
-    #NOTE: add_vars is for variables that aren't defined already, slv_vars is for variables that are defined
-    # if add_vars:
-    #     if any([arg_var_compare(var,avar) for avar in add_vars]):
-    #         if log.log_level < 3:
-    #             log.msg(f'adding solver var')            
-    #         return True
-
-    #check values, and filters
-    initial_match = [grp for grp in groups if arg_var_compare(var,grp)]
-    if log.log_level < 2:
-        log.msg(f'initial match: {var} in {initial_match}')
-
-    if not any(initial_match):
-        if log.log_level < 3:
-            log.msg(f'skip {var}: nothing')
-        return False
-    if onlygrp and not any(arg_var_compare(var,grp) for grp in onlygrp):
-        if log.log_level < 3:
-            log.msg(f'skip {var} not in {onlygrp}')
-        return False    
-    if igngrp and any(arg_var_compare(var,grp) for grp in igngrp):
-        if log.log_level < 3:
-            log.msg(f'skip {var} in {igngrp}')
-        return False
-    return True

-
-
-

-[docs]
-def filt_active(var,inst,extra_kw=None,dflt=False):
-    from engforge.attr_solver import SolverInstance
-    from engforge.attr_dynamics import IntegratorInstance
-    from engforge.attr_signals import SignalInstance
-    
-    #not considered
-    if not isinstance(inst,(SolverInstance,IntegratorInstance,SignalInstance)):
-        return True
-
-    activate = ext_str_list(extra_kw,'activate',[])
-    deactivate = ext_str_list(extra_kw,'deactivate',[])  
-
-    act = inst.is_active(dflt) #default is inclusion boolean 
-    
-    #check for possibilities of activation
-    if not act and not activate:
-        if log.log_level < 3:
-            log.msg(f'skip {var}: not active')
-        return False #shortcut
-    if activate and any(arg_var_compare(var,grp) for grp in activate):
-        if log.log_level < 3:
-            log.msg(f'{var} activated!')
-        return True
-    if deactivate and any(arg_var_compare(var,grp) for grp in deactivate):
-        if log.log_level < 3:
-            log.msg(f'{var} deactivated!')
-        return False
-    log.msg(f'{var} is active={act}!')
-    return act

-
-
-
-
-
-
-
-
-
-
-
-# def solve_root(
-#     self, Xref, Yref, Xreset, vars, output=None, fail=True, **kw
-# ):
-#     """
-#     Solve the root problem using the given vars.
-# 
-#     :param Xref: The reference input values.
-#     :param Yref: The reference output values.
-#     :param Xreset: The reset input values.
-#     :param vars: The list of var names.
-#     :param output: The output dictionary to store the results. (default: None)
-#     :param fail: Flag indicating whether to raise an exception if the solver doesn't converge. (default: True)
-#     :param kw: Additional keyword arguments.
-#     :return: The output dictionary containing the results.
-#     :rtype: dict
-#     """
-#     if output is None:
-#         output = {
-#             "Xstart": Xreset,
-#             "vars": vars,
-#             "Xans": None,
-#             "success": None,
-#         }
-# 
-#     assert len(Xref) == len(Yref), "Xref and Xreset must have the same length"
-# 
-#     self._ans = refroot_solve(self, Xref, Yref, ret_ans=True, **kw)
-#     output["ans"] = self._ans
-#     if self._ans.success:
-#         # Set Values
-#         Xa = {p: self._ans.x[i] for i, p in enumerate(vars)}
-#         output["Xans"] = Xa
-#         Ref.refset_input(Xref, Xa)
-#         self.pre_execute()
-#         self._converged = True
-#         output["success"] = True
-#     else:
-#         Ref.refset_input(Xref, Xreset)
-#         self.pre_execute()
-#         self._converged = False
-#         if fail:
-#             raise Exception(f"solver didnt converge: {self._ans}")
-#         output["success"] = False
-# 
-#     return output
-    
-
-
-
-
-
-
-
-
-#### TODO: solve equillibrium case first using root solver for tough problems
-# # make anonymous function
-# def f_lin_slv(system, Xref: dict, Yref: dict, normalize=None,slv_info=None):
-#     vars = list(Xref.keys())  # static x_basis
-#     yvar = list(Yref.keys())
-#     def f(x):  # anonymous function
-#         # set state
-#         for p, xi in zip(vars, x):
-#             Xref[p].set_value(xi)
-#         print(Xref,Yref)
-#         grp = (yvar, x, normalize)
-#         vals = [eval_ref(Yref[p],system,slv_info) / n for p, x, n in zip(*grp)]
-#         return vals  # n sized normal residual vector
-# 
-#     return f
-# 
-# def refroot_solve(
-#     system,
-#     Xref: dict,
-#     Yref: dict,
-#     Xo=None,
-#     normalize: np.array = None,
-#     reset=True,
-#     doset=True,
-#     fail=True,
-#     ret_ans=False,
-#     ffunc=f_lin_slv,
-#     **kw,
-# ):
-#     """find the input X to ensure the difference between two dictionaries of refernces, x references are changed in place, y will be solved to zero, options ensue for cases where the solution is not ideal
-# 
-#     :param Xref: dictionary of references to the x values
-#     :param Yref: dictionary of references to the y values
-#     :param Xo: initial guess for the x values as a list against Xref order, or a dictionary
-#     :param normalize: a dictionary of values to normalize the x values by, list also ok as long as same length and order as Xref
-#     :param reset: if the solution fails, reset the x values to their original state, if true will reset the x values to their original state on failure overiding doset.
-#     :param doset: if the solution is successful, set the x values to the solution by default, otherwise follows reset, if not successful reset is checked first, then doset
-#     """
-#     vars = list(Xref.keys())  # static x_basis
-#     if normalize is None:
-#         normalize = np.ones(len(vars))
-#     elif isinstance(normalize, (list, tuple, np.ndarray)):
-#         assert len(normalize) == len(vars), "bad length normalize"
-#     elif isinstance(normalize, (dict)):
-#         normalize = np.array([normalize[p] for p in vars])
-# 
-#     # make objective function
-#     f = ffunc(system, Xref, Yref, normalize)
-# 
-#     # get state
-#     if reset:
-#         x_pre = refset_get(Xref)  # record before changing
-# 
-#     if Xo is None:
-#         Xo = [Xref[p].value() for p in vars]
-# 
-#     elif isinstance(Xo, dict):
-#         Xo = [Xo[p] for p in vars]
-# 
-#     # solve
-#     ans = sciopt.root(f, Xo, **kw)
-#  
-#     return process_ans(ans,vars,Xref,x_pre,doset,reset,fail,ret_ans)
-# 
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/system.html b/docs/_build/html/_modules/engforge/system.html deleted file mode 100644 index 0ebbec7..0000000 --- a/docs/_build/html/_modules/engforge/system.html +++ /dev/null @@ -1,255 +0,0 @@ - - - - - - engforge.system — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.system

-"""A System is a Configuration that orchestrates dataflow between components, as well as solving systems of equations in the presense of limits, as well as formatting results of each Component into reporting ready dataframe. System's solver behavior is inspired by NASA's numerical propulsion simulation system (NPSS) to solve systems of inequalities in complex systems.
-
-Component or other subsystems are added to a System class with `Slots`:
-    ```
-    class CustomSystem(System):
-        slot_name = Slot.define(Component,ComponentSubclass,System)
-    ```
-
-Component's data flow is established via `SignalS` that are defined:
-    ```
-    class CustomSystem(System):
-        signal_name = Signal.define(source_attr_or_property, target_attr)
-        control_signal = Signal.define(source_attr_or_property, target_attr,control_with='system.attr or slot.attr`)
-    ```
-    - source_attr: can reference a locally defined slot attribute (a la attr's fields) or any locally defined slot system property
-    - target_attr: must be a locally defined slot attribute or system attribute.
-
-update description to include solver
-
-A system calculates its state upon calling `System.run()`. This executes `pre_execute()` first which will directly update any attributes based on their `Signal` definition between `Slot` components. Once convergence is reached target_attr's are updated in `post_execute()` for cyclic SignalS.
-
-If the system encounters a subsystem in its solver routine, the subsystem is evald() and its results used as static in that iteration,ie it isn't included in the system level dependents if cyclic references are found.
-
-
-The solver uses the root or cobla scipy optimizer results on quick references to internal component references. Upon solving the system
-
-SignalS can be limited with constrains via `min or max` values on `NumericProperty` which can be numeric values (int or float) or functions taking one argument of the component it is defined on. Additionally signals may take arguments of `min` or `max` which are numeric values or callbacks which take the system instance as an argument.
-"""
-import attrs
-
-from engforge.properties import *
-from engforge.logging import LoggingMixin
-from engforge.configuration import Configuration, forge
-from engforge.components import SolveableInterface
-from engforge.solver import SolverMixin
-from engforge.attr_plotting import PlottingMixin
-from engforge.dynamics import GlobalDynamics
-
-import copy
-import collections
-import typing
-import numpy
-
-
-# make a module logger
-

-[docs]
-class SystemsLog(LoggingMixin):
-    pass

-
-
-
-log = SystemsLog()
-
-#NOTE: solver must come before solvable interface since it overrides certain methods
-

-[docs]
-@forge
-class System(SolverMixin, SolveableInterface, PlottingMixin,GlobalDynamics):
-    """A system defines SlotS for Components, and data flow between them using SignalS
-
-    The system records all attribues to its subcomponents via system_references with scoped keys to references to set or get attributes, as well as observe system properties. These are cached upon first access in an instance.
-
-    The table is made up of these system references, allowing low overhead recording of systems with many variables.
-
-    When solving by default the run(revert=True) call will revert the system state to what it was before the system began.
-    """
-    
-    #default to nothing
-    dynamic_input_vars: list = attrs.field(factory=list)
-    dynamic_state_vars: list = attrs.field(factory=list)
-    dynamic_output_vars: list = attrs.field(factory=list)
-    
-
-    _anything_changed_ = True
-    _solver_override: bool = False #this comp will run with run_internal_systems when True, otherwise it resolves to global solver behavior, also prevents the solver from reaching into this system
-
-
-    # Properties!
-    @system_property
-    def converged(self) -> int:
-        if self.last_context is None: 
-            return None        
-        return self.last_context.converged
-
-    @system_property
-    def run_id(self) -> int:
-        if self.last_context is None: 
-            return None
-        return self.last_context.problem_id
-
-

-[docs]
-    @classmethod
-    def subclasses(cls, out=None):
-        """
-        return all subclasses of components, including their subclasses
-        :param out: out is to pass when the middle of a recursive operation, do not use it!
-        """
-
-        # init the set by default
-        if out is None:
-            out = set()
-
-        for cls in cls.__subclasses__():
-            out.add(cls)
-            cls.subclasses(out)
-
-        return out

-
-
-

-[docs]
-    def clone(self):
-        """returns a clone of this system, often used to iterate the system without affecting the input values at the last convergence step."""
-        return copy.deepcopy(self)

-
-
-    @property
-    def identity(self):
-        if self.run_id:
-            return f"{self.name}_{self.run_id}"
-        else:
-            return f"{self.name}"
-
-    @property
-    def _anything_changed(self):
-        """looks at internal components as well as flag for anything chagned."""
-        if self._anything_changed_:
-            return True
-        elif any([c.anything_changed for k, c in self.comp_references().items()]):
-            return True
-        return False
-
-    @_anything_changed.setter
-    def _anything_changed(self, inpt):
-        """allows default functionality with new property system"""
-        self.mark_all_comps_changed(inpt)
-
-

-[docs]
-    def mark_all_comps_changed(self,inpt:bool):
-        """mark all components as changed, useful for forcing a re-run of the system, or for marking data as saved"""
-        self._anything_changed_ = inpt
-        for k, c in self.comp_references().items():
-            c._anything_changed = inpt       

-

-
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/system_reference.html b/docs/_build/html/_modules/engforge/system_reference.html deleted file mode 100644 index ae8d9b1..0000000 --- a/docs/_build/html/_modules/engforge/system_reference.html +++ /dev/null @@ -1,411 +0,0 @@ - - - - - - engforge.system_reference — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.system_reference

-"""Module to define the Ref class and utility methods for working with it.
-
-Ref's are designed to create adhoc links between the systems & components of the system, and their properties. This is useful for creating optimization problems, and for creating dynamic links between the state and properties of the system. Care must be used on the component objects changing of state, the recommened procedure is to copy your base system to prevent hysterisis and other issues, then push/pop X values through the optimization methods and change state upon success
-
-Ref.component can be a Component,System or dictionary for referencing via keyword. Ref.key can be a string or a callable, if callable the ref will be evaluated as the result of the callable (allow_set=False), this renders the component unused, and disables the ability to set the value of the reference.
-"""
-import attrs
-import inspect
-import numpy as np
-import collections
-import scipy.optimize as sciopt
-from contextlib import contextmanager
-from engforge.properties import *
-import copy
-
-

-[docs]
-class RefLog(LoggingMixin):
-    pass

-
-
-
-log = RefLog()
-
-
-

-[docs]
-def refset_input(refs, delta_dict,chk=True,fail=True,warn=True):
-    """change a set of refs with a dictionary of values. If chk is True k will be checked for membership in refs"""
-    for k, v in delta_dict.items():
-        memb =  k in refs
-        if not chk or memb:
-            refs[k].set_value(v)
-        elif fail and chk and not memb:
-            raise KeyError(f"key {k} not in refs {refs.keys()}")
-        elif warn and chk and not memb:
-            log.warning(f"key {k} not in refs {refs.keys()}")

-
-
-
-

-[docs]
-def refset_get(refs,*args,**kw):
-    out = {}
-    for k in refs:
-        try:
-            out[k] = refs[k].value(*args,**kw)
-        except Exception as e:
-            rf = refs[k]
-            log.error(e,f'issue with ref: {rf}|{rf.key}|{rf.comp}')
-
-    return out

-
-
-
-# def f_root(ResRef: collections.OrderedDict, norm: dict = None):
-#     residual = [v.value() / (norm[k] if norm else 1) for k, v in ResRef.items()]
-#     res = np.array(residual)
-#     return res
-# 
-# 
-# def f_min(ResRef: collections.OrderedDict, norm: dict = None):
-#     res = [v.value() / (norm[k] if norm else 1) for k, v in ResRef.items()]
-#     ans = np.linalg.norm(res, 2)
-# 
-#     if ans < 1:
-#         return ans**0.5
-#     return ans
-
-
-

-[docs]
-def eval_ref(canidate,*args,**kw):
-    #print(f'eval_ref {canidate,args,kw}')
-    if isinstance(canidate, Ref):
-        return canidate.value(*args,**kw)
-    elif callable(canidate):  
-        o = canidate(*args,**kw)
-        return o
-    return canidate

-
-
-

-[docs]
-def scale_val(val, mult=None, bias=None, power=None)->float:
-    if any((mult,bias,power)):
-        if power is not None:
-            val = val ** power    
-        if mult is not None:
-            val = mult * val
-        if bias is not None:
-            val = bias + val
-    return val

-
-
-
-

-[docs]
-def maybe_ref(can,astype=None,mult=None,bias=None,power=None,*args,**kw):
-    """returns the value of a ref if it is a ref, otherwise returns the value"""
-    #print(f'maybe  {can,astype}')
-    #print(can,astype,mult,bias,power,args,kw)
-    if isinstance(can,Ref):
-        val = can.value(*args,**kw)
-        return scale_val(val,mult,bias,power)
-    elif astype and isinstance(can,astype):
-        ref = can.as_ref_dict() #TODO: optimize this
-        return scale_val(ref.value(*args,**kw),mult,bias,power)
-    return can

-
-
-

-[docs]
-def maybe_attr_inst(can,astype=None):
-    """returns the ref if is one otherwise convert it, otherwise returns the value"""
-    if isinstance(can,Ref):
-        return can
-    elif astype and isinstance(can,astype):
-        return astype.backref.handle_instance(can)
-    return can

-
-
-
-#Important State Preservation
-#TODO: check for hidden X dependents / circular references ect.
-#TODO: make global storage for Ref's based on the comp,key pair. This 
-

-[docs]
-class Ref:
-    """A way to create portable references to system's and their component's properties, ref can also take a key to a zero argument function which will be evald. This is useful for creating an adhoc optimization problems dynamically between variables. However use must be carefully controlled to avoid circular references, and understanding the safe use of the refset_input and refset_get methods (changing state on actual system).
-
-    A dictionary can be used as a component, and the key will be used to access the value in the dictionary.
-
-    The key can be a callable of (*args,**kw) only in which case Ref.value(*args,**kw) will take input, and the ref will be evaluated as the result of the callable (allow_set=False), this renders the component unused, and disables the ability to set the value of the reference.
-
-    The ability to set this ref with another on key input allows for creating a reference that is identical to another reference except for the component provided if it is not None.
-    """
-
-    __slots__ = [
-        "comp",
-        "key",
-        "use_call",
-        "use_dict",
-        "allow_set",
-        "eval_f",
-        "key_override",
-        '_value_eval',
-        '_log_func',
-        'hxd',
-        '_name'
-    ]
-    comp: "TabulationMixin"
-    key: str
-    use_call: bool
-    use_dict: bool
-    allow_set: bool
-    eval_f: callable
-    key_override: bool
-    _value_eval: callable
-    _log_func: callable
-
-    def __init__(self, comp, key, use_call=True, allow_set=True, eval_f=None):
-        self.set(comp, key, use_call, allow_set, eval_f)
-
-    def set(self, comp, key, use_call=True, allow_set=True, eval_f=None):
-        
-        #key can be a ref, in which case this ref will be identical to the other ref except for the component provided if it is not None
-        if isinstance(key,Ref):
-            self.__dict__.update(key.__dict__)
-            if comp is not None:
-                self.comp = comp
-            return #a monkey patch
-
-        self.comp = comp
-        if isinstance(self.comp, dict):
-            self.use_dict = True
-            self._name = 'dict'
-        else:
-            self.use_dict = False
-
-        self.key_override = False
-        if callable(key):
-            self.key_override = True
-            self.key = key #this should take have signature f(system,slv_info)
-            self.use_call = False
-            self.allow_set = False
-            self.eval_f = eval_f
-            self._name = 'callable'
-        else:
-            self.key = key
-            self.use_call = use_call
-            self.allow_set = allow_set
-            self.eval_f = eval_f
-            if not self.use_dict:
-                self._name = self.comp.classname
-
-        if not hasattr(self, '_name'):
-            self._name = "NULL"
-
-        self.hxd = str(hex(id(self)))[-6:]
-
-        self.setup_calls()
-
-

-[docs]
-    def setup_calls(self):
-        """caches anonymous functions for value and logging speedup"""
-        if self.comp and isinstance(self.comp,LoggingMixin) and self.comp.log_level <= 2:
-            self._log_func = lambda val: self.comp.msg(f"REF[get] {str(self):<50} -> {val}")
-        else:
-            self._log_func = None
-
-        if self.key_override:
-            self._value_eval = lambda *a,**kw: self.key(*a,**kw)
-        else:
-            #do not cross reference vars!
-            if self.use_dict:
-                p = lambda *a,**kw: self.comp.get(self.key)
-            elif self.key in self.comp.__dict__:
-                p = lambda *a,**kw: self.comp.__dict__[self.key]
-            else:
-                p = lambda *a,**kw: getattr(self.comp, self.key)
-
-            if self.eval_f:
-                g = lambda *a,**kw: self.eval_f(p(*a,**kw))
-            else:
-                g = p
-
-            self._value_eval = g

-
-
-
-

-[docs]
-    def copy(self, **changes):
-        """copy the reference, and make changes to the copy"""
-        if "key" not in changes:
-            changes["key"] = self.key
-        if "comp" not in changes:
-            changes["comp"] = self.comp
-        cy = copy.copy(self)
-        cy.set(**changes)
-        return cy

-
-
-    def value(self,*args,**kw):
-        if log.log_level <= 10:
-            try:
-                o = self._value_eval(*args,**kw)
-                if self._log_func:
-                    self._log_func(o)
-                return o
-            except Exception as e:
-                log.error(e,f'issue with ref: {self}|{self.key}|{self.comp}')
-        else:
-            o = self._value_eval(*args,**kw)
-            if self._log_func:
-                self._log_func(o)
-            return o
-
-    def set_value(self, val):
-        if self.allow_set:
-            if self.value() != val: #this increases perf. by reducing writes
-                if self.comp and self.comp.log_level < 10:
-                    self.comp.msg(f"REF[set] {self} <- {val}")
-                return setattr(self.comp, self.key, val)
-        else:
-            raise Exception(f"not allowed to set value on {self.key}")
-
-    def __str__(self) -> str:
-        if self.use_dict:
-            return f"REF[{self.hxd}][DICT.{self.key}]"
-        if self.key_override:
-            return f"REF[{self.hxd}][{self._name}.{self.key.__name__}]"
-        return f"REF[{self.hxd}][{self._name}.{self.key}]"
-
-    def __repr__(self) -> str:
-        if self.key_override:
-            return f"REF[{self.hxd}][{self._name}.{self.key.__name__}]"        
-        return f"REF[{self.hxd}][{self._name}.{self.key}]"
-
-    # Utilty Methods
-    refset_get = refset_get
-    refset_input = refset_input

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/tabulation.html b/docs/_build/html/_modules/engforge/tabulation.html deleted file mode 100644 index cc51b04..0000000 --- a/docs/_build/html/_modules/engforge/tabulation.html +++ /dev/null @@ -1,383 +0,0 @@ - - - - - - engforge.tabulation — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.tabulation

-"""Tabulation Module:
-
-Incrementally records attrs input values and system_properties per save_data() call.
-
-save_data() is called after item.eval() is called.
-"""
-
-from contextlib import contextmanager
-import attr
-
-from engforge.common import inst_vectorize, chunks
-
-# from engforge.configuration import Configuration, forge
-from engforge.solveable import SolveableMixin
-from engforge.logging import LoggingMixin
-from engforge.dataframe import DataframeMixin
-from engforge.typing import *
-from engforge.properties import *
-from typing import Callable
-
-import numpy
-import pandas
-import os
-import collections
-import uuid
-
-

-[docs]
-class TableLog(LoggingMixin):
-    pass

-
-log = TableLog()
-
-SKIP_REF = ["run_id", "converged", "name", "index",'converged']
-
-
-
-
-

-[docs]
-class TabulationMixin(SolveableMixin, DataframeMixin):
-    """In which we define a class that can enable tabulation"""
-
-    # Super Special Tabulating Index
-    #index = 0  # Not an attr on purpose, we want pandas to provide the index
-
-    # override per class:
-    _skip_table_vars: list = None
-    _skip_plot_vars: list
-
-    # Cached and private
-    #_table: dict = None
-    _anything_changed: bool
-    _always_save_data = False
-
-    @property
-    def anything_changed(self):
-        """use the on_setattr method to determine if anything changed,
-        also assume that stat_tab could change without input changes"""
-        if not hasattr(self, "_anything_changed"):
-            self._anything_changed = True
-
-        if self._anything_changed or self.always_save_data:
-            if self.log_level <= 5:
-                self.msg(
-                    f"change: {self._anything_changed}| always: {self.always_save_data}"
-                )
-            return True
-        return False
-
-    @property
-    def last_context(self):
-        """Returns the last context"""
-        raise NotImplemented('this should be implemented in the solvable class')
-
-    @solver_cached
-    def dataframe(self):
-        if hasattr(self,'last_context') and hasattr(self.last_context, "dataframe"):
-            return self.last_context.dataframe
-        return pandas.DataFrame([])
-
-    @property
-    def plotable_variables(self):
-        """Checks columns for ones that only contain numeric types or haven't been explicitly skipped"""
-        if self.dataframe is not None:
-            check_type = lambda key: all(
-                [isinstance(v, NUMERIC_TYPES) for v in self.dataframe[key]]
-            )
-            check_non_mono = lambda key: len(set(self.dataframe[key])) > 1
-
-            return [
-                var
-                for var in self.dataframe.columns
-                if var.lower() not in self.skip_plot_vars
-                and check_type(var)
-                and check_non_mono(var)
-            ]
-        return []
-
-    # Properties & Attribues
-    def print_info(self):
-        print(f"INFO: {self.name} | {self.identity}")
-        print("#" * 80)
-        for key, value in sorted(self.data_dict.items(), key=lambda kv: kv[0]):
-            print(f"{key:>40} | {value}")
-
-    @property
-    def data_dict(self):
-        """this is what is captured and used in each row of the dataframe / table"""
-        #NOTE: Solver class overrides this with full system references
-        out = collections.OrderedDict()
-        sref = self.internal_references()
-        for k, v in sref["attributes"].items():
-            if k in self.attr_raw_keys:
-                out[k] = v.value()
-        for k, v in sref["properties"].items():
-            out[k] = v.value()
-        return out
-
-    @instance_cached
-    def attr_raw_keys(self) -> list:
-        good = set(self.table_fields())
-        return [k for k in attr.fields_dict(self.__class__).keys() if k in good]
-
-    def set_attr(self, **kwargs):
-        assert set(kwargs).issubset(set(self.attr_raw_keys))
-        # TODO: support subcomponents via slots lookup
-        for k, v in kwargs.items():
-            setattr(self, k, v)
-
-    @instance_cached
-    def always_save_data(self):
-        """Checks if any properties are stochastic (random)"""
-        return self._always_save_data
-
-    @solver_cached
-    def table_dict(self):
-        # We use __get__ to emulate the property, we could call regularly from self but this is more straightforward
-        return {
-            k.lower(): obj.__get__(self)
-            for k, obj in self.system_properties_def.items()
-        }
-
-    @solver_cached
-    def system_properties(self):
-        # We use __get__ to emulate the property, we could call regularly from self but this is more straightforward
-        tabulated_properties = [
-            obj.__get__(self) for k, obj in self.system_properties_def.items()
-        ]
-        return tabulated_properties
-
-    @instance_cached
-    def system_properties_labels(self) -> list:
-        """Returns the labels from table properties"""
-        class_dict = self.__class__.__dict__
-        tabulated_properties = [
-            obj.label.lower() for k, obj in self.system_properties_def.items()
-        ]
-        return tabulated_properties
-
-    @instance_cached
-    def system_properties_types(self) -> list:
-        """Returns the types from table properties"""
-        class_dict = self.__class__.__dict__
-        tabulated_properties = [
-            obj.return_type for k, obj in self.system_properties_def.items()
-        ]
-        return tabulated_properties
-
-    @instance_cached
-    def system_properties_keys(self) -> list:
-        """Returns the table property keys"""
-        tabulated_properties = [
-            k for k, obj in self.system_properties_def.items()
-        ]
-        return tabulated_properties
-
-    @instance_cached
-    def system_properties_description(self) -> list:
-        """returns system_property descriptions if they exist"""
-        class_dict = self.__class__.__dict__
-        tabulated_properties = [
-            obj.desc for k, obj in self.system_properties_def.items()
-        ]
-        return tabulated_properties
-
-    @classmethod
-    def cls_all_property_labels(cls):
-        return [
-            obj.label for k, obj in cls.system_properties_classdef().items()
-        ]
-
-    @classmethod
-    def cls_all_property_keys(cls):
-        return [k for k, obj in cls.system_properties_classdef().items()]
-
-    @classmethod
-    def cls_all_attrs_fields(cls):
-        return attr.fields_dict(cls)
-
-    @solver_cached
-    def system_properties_def(self):
-        """Combine other classes table properties into this one, in the case of subclassed system_properties as a property that is cached"""
-        return self.__class__.system_properties_classdef()
-
-

-[docs]
-    @classmethod
-    def system_properties_classdef(cls, recache=False):
-        """Combine other parent-classes table properties into this one, in the case of subclassed system_properties"""
-        from engforge.tabulation import TabulationMixin
-
-        # Use a cache for deep recursion
-        if not recache and hasattr(cls, "_{cls.__name__}_system_properties"):
-            res = getattr(cls, "_{cls.__name__}_system_properties")
-            if res is not None:
-                return res
-
-        # otherwise make the cache
-        __system_properties = {}
-        for k, obj in cls.__dict__.items():
-            if isinstance(obj, system_property):
-                __system_properties[k] = obj
-
-        #
-        mrl = cls.mro()
-        inx_comp = mrl.index(TabulationMixin)
-
-        # Ensures everything is includes Tabulation Functionality
-        mrvs = mrl[1:inx_comp]
-
-        for mrv in mrvs:
-            # Remove anything not in the user code
-            log.msg(f"adding system properties from {mrv.__name__}")
-            if (
-                issubclass(mrv, TabulationMixin)
-                # and "engforge" not in mrv.__module__
-            ):
-                for k, obj in mrv.__dict__.items():
-                    if k in SKIP_REF:
-                        continue
-                    if k not in __system_properties and isinstance(
-                        obj, system_property
-                    ):  # Precedent
-                        # Assumes our instance has assumed this table property
-                        prop = getattr(cls, k, None)
-                        if prop and isinstance(prop, system_property):
-                            __system_properties[k] = prop
-                            log.msg(
-                                f"adding system property {mrv.__name__}.{k}"
-                            )
-
-        setattr(cls, "_{cls.__name__}_system_properties", __system_properties)
-
-        return __system_properties

-
-
-    @classmethod
-    def pre_compile(cls):
-        cls._anything_changed = True  # set default on class
-        if any(
-            [
-                v.stochastic
-                for k, v in cls.system_properties_classdef(True).items()
-            ]
-        ):
-            log.info(f"setting always save on {cls.__name__}")
-            cls._always_save_data = True
-
-    @property
-    def system_id(self) -> str:
-        """returns an instance unique id based on id(self)"""
-        idd = id(self)
-        return f"{self.classname}.{idd}"

-
-
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/engforge/typing.html b/docs/_build/html/_modules/engforge/typing.html deleted file mode 100644 index ab1b48f..0000000 --- a/docs/_build/html/_modules/engforge/typing.html +++ /dev/null @@ -1,209 +0,0 @@ - - - - - - engforge.typing — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -

Source code for engforge.typing

-"""
-
-"""
-import pandas, attr, numpy
-from engforge.properties import *
-import attrs
-
-# import matplotlib.pyplot as plt
-pandas.set_option("use_inf_as_na", True)
-
-# Type Checking
-NUMERIC_TYPES = (float, int, numpy.int64, numpy.float64)
-NUMERIC_NAN_TYPES = (float, int, type(None), numpy.int64, numpy.float64)
-STR_TYPES = (str, numpy.string_)
-TABLE_TYPES = (int, float, str, type(None), numpy.int64, numpy.float64)
-
-
-# TODO: add min / max args & attrs boilerplate
-

-[docs]
-def NUMERIC_VALIDATOR():
-    return attr.validators.instance_of(NUMERIC_TYPES)

-
-
-
-

-[docs]
-def NUMERIC_NAN_VALIDATOR():
-    return attr.validators.instance_of(NUMERIC_NAN_TYPES)

-
-
-
-

-[docs]
-def STR_VALIDATOR():
-    return attr.validators.instance_of(STR_TYPES)

-
-
-
-ATTR_VALIDATOR_TYPES = (
-    attr.validators._AndValidator,
-    attr.validators._InstanceOfValidator,
-    attr.validators._MatchesReValidator,
-    attr.validators._ProvidesValidator,
-    attr.validators._OptionalValidator,
-    attr.validators._InValidator,
-    attr.validators._IsCallableValidator,
-    attr.validators._DeepIterable,
-    attr.validators._DeepMapping,
-)
-
-TAB_VALIDATOR_TYPE = (
-    attr.validators._InstanceOfValidator
-)  # our validators should require a type i think, at least for tabulation
-
-
-# Improved Attrs Creation Fields
-

-[docs]
-def Options(*choices, **kwargs):
-    """creates an attrs field with validated choices on init and setattr
-    :param choices: a list of choices that are validated on input, the first becoming the default unless it is passed in kwargs
-    :param kwargs: keyword args passed to attrs field"""
-    assert choices, f"must have some choices!"
-    assert "type" not in kwargs, "options type set is str"
-    assert set([type(c) for c in choices]) == set((str,)), "choices must be str"
-    assert "on_setattr" not in kwargs
-
-    validators = [attrs.validators.in_(choices)]
-
-    # Merge Validators
-    if "validators" in kwargs:
-        in_validators = kwargs.pop("validators")
-        if isinstance(in_validators, list):
-            validators.extend(in_validators)
-        elif isinstance(in_validators, attr.validators._ValidatorType):
-            validators.append(in_validators)
-        else:
-            raise ValueError(f"bad validator {in_validators}")
-
-    # Default
-    if "default" in kwargs:
-        default = kwargs.pop("default")
-        assert type(default) is str
-    else:
-        default = choices[0]
-
-    on_setattr = [attrs.setters.validate]
-
-    # Create The Attr!
-    a = attrs.field(
-        default=default,
-        type=str,
-        validator=validators,
-        on_setattr=on_setattr,
-        **kwargs,
-    )
-    return a

-
-
-
-# def Numeric #TODO with min/max that is enforced in solver!
-
- -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_modules/index.html b/docs/_build/html/_modules/index.html deleted file mode 100644 index 48caf16..0000000 --- a/docs/_build/html/_modules/index.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - Overview: module code — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • Overview: module code
    • -
  • -
    • -
-
-
-
-
- -

All modules for which code is available

- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.analysis.Analysis.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.analysis.Analysis.rst.txt deleted file mode 100644 index 1a505c4..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.analysis.Analysis.rst.txt +++ /dev/null @@ -1,133 +0,0 @@ -engforge.analysis.Analysis -========================== - -.. currentmodule:: engforge.analysis - -.. autoclass:: Analysis - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Analysis.add_fields - ~Analysis.change_all_log_lvl - ~Analysis.check_ref_slot_type - ~Analysis.cls_all_attrs_fields - ~Analysis.cls_all_property_keys - ~Analysis.cls_all_property_labels - ~Analysis.cls_compile - ~Analysis.collect_all_attributes - ~Analysis.collect_comp_refs - ~Analysis.collect_dynamic_refs - ~Analysis.collect_inst_attributes - ~Analysis.collect_post_update_refs - ~Analysis.collect_solver_refs - ~Analysis.collect_update_refs - ~Analysis.comp_references - ~Analysis.compile_classes - ~Analysis.copy_config_at_state - ~Analysis.critical - ~Analysis.debug - ~Analysis.difference - ~Analysis.error - ~Analysis.extract_message - ~Analysis.filter - ~Analysis.format_columns - ~Analysis.get_system_input_refs - ~Analysis.go_through_configurations - ~Analysis.info - ~Analysis.input_attrs - ~Analysis.input_fields - ~Analysis.installSTDLogger - ~Analysis.internal_components - ~Analysis.internal_configurations - ~Analysis.internal_references - ~Analysis.internal_systems - ~Analysis.internal_tabulations - ~Analysis.locate - ~Analysis.locate_ref - ~Analysis.make_plots - ~Analysis.message_with_identiy - ~Analysis.msg - ~Analysis.numeric_fields - ~Analysis.parent_configurations_cls - ~Analysis.parse_run_kwargs - ~Analysis.parse_simulation_input - ~Analysis.plot_attributes - ~Analysis.post_process - ~Analysis.post_update - ~Analysis.pre_compile - ~Analysis.print_info - ~Analysis.report_results - ~Analysis.resetLog - ~Analysis.resetSystemLogs - ~Analysis.run - ~Analysis.set_attr - ~Analysis.setattrs - ~Analysis.signals_attributes - ~Analysis.slack_notification - ~Analysis.slot_refs - ~Analysis.slots_attributes - ~Analysis.smart_split_dataframe - ~Analysis.solvers_attributes - ~Analysis.subclasses - ~Analysis.subcls_compile - ~Analysis.system_properties_classdef - ~Analysis.system_references - ~Analysis.table_fields - ~Analysis.trace_attributes - ~Analysis.transients_attributes - ~Analysis.update - ~Analysis.validate_class - ~Analysis.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Analysis.anything_changed - ~Analysis.as_dict - ~Analysis.attrs_fields - ~Analysis.classname - ~Analysis.data_dict - ~Analysis.dataframe - ~Analysis.dataframe_constants - ~Analysis.dataframe_variants - ~Analysis.displayname - ~Analysis.filename - ~Analysis.identity - ~Analysis.input_as_dict - ~Analysis.last_context - ~Analysis.log_fmt - ~Analysis.log_level - ~Analysis.log_on - ~Analysis.log_silo - ~Analysis.logger - ~Analysis.numeric_as_dict - ~Analysis.numeric_hash - ~Analysis.plotable_variables - ~Analysis.skip_plot_vars - ~Analysis.slack_webhook_url - ~Analysis.stored_plots - ~Analysis.system_id - ~Analysis.unique_hash - ~Analysis.uploaded - ~Analysis.system - ~Analysis.table_reporters - ~Analysis.plot_reporters - ~Analysis.show_plots - ~Analysis.name - ~Analysis.parent - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.analysis.make_reporter_check.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.analysis.make_reporter_check.rst.txt deleted file mode 100644 index 940d0dd..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.analysis.make_reporter_check.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.analysis.make\_reporter\_check -======================================= - -.. currentmodule:: engforge.analysis - -.. autofunction:: make_reporter_check \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.analysis.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.analysis.rst.txt deleted file mode 100644 index 40506dc..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.analysis.rst.txt +++ /dev/null @@ -1,40 +0,0 @@ -engforge.analysis -================= - -.. automodule:: engforge.analysis - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - make_reporter_check - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - Analysis - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_dynamics.IntegratorInstance.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_dynamics.IntegratorInstance.rst.txt deleted file mode 100644 index 8fadd49..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_dynamics.IntegratorInstance.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -engforge.attr\_dynamics.IntegratorInstance -========================================== - -.. currentmodule:: engforge.attr_dynamics - -.. autoclass:: IntegratorInstance - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~IntegratorInstance.as_ref_dict - ~IntegratorInstance.compile - ~IntegratorInstance.get_alias - ~IntegratorInstance.is_active - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~IntegratorInstance.system - ~IntegratorInstance.solver - ~IntegratorInstance.var_ref - ~IntegratorInstance.rate_ref - ~IntegratorInstance.active - ~IntegratorInstance.classname - ~IntegratorInstance.combos - ~IntegratorInstance.constraint_refs - ~IntegratorInstance.constraints - ~IntegratorInstance.current_rate - ~IntegratorInstance.integrated - ~IntegratorInstance.normalize - ~IntegratorInstance.rate - ~IntegratorInstance.rates - ~IntegratorInstance.slvtype - ~IntegratorInstance.var - ~IntegratorInstance.class_attr - ~IntegratorInstance.backref - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_dynamics.TRANSIENT.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_dynamics.TRANSIENT.rst.txt deleted file mode 100644 index 3534c5c..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_dynamics.TRANSIENT.rst.txt +++ /dev/null @@ -1,77 +0,0 @@ -engforge.attr\_dynamics.TRANSIENT -================================= - -.. currentmodule:: engforge.attr_dynamics - -.. autoclass:: TRANSIENT - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~TRANSIENT.add_var_constraint - ~TRANSIENT.class_validate - ~TRANSIENT.collect_attr_inst - ~TRANSIENT.collect_cls - ~TRANSIENT.configure_for_system - ~TRANSIENT.configure_instance - ~TRANSIENT.constraint_exists - ~TRANSIENT.create_instance - ~TRANSIENT.define - ~TRANSIENT.define_validate - ~TRANSIENT.evolve - ~TRANSIENT.from_counting_attr - ~TRANSIENT.handle_instance - ~TRANSIENT.integrate - ~TRANSIENT.make_attribute - ~TRANSIENT.make_factory - ~TRANSIENT.process_combos - ~TRANSIENT.subclasses - ~TRANSIENT.unpack_atrs - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~TRANSIENT.name - ~TRANSIENT.default - ~TRANSIENT.validator - ~TRANSIENT.repr - ~TRANSIENT.eq - ~TRANSIENT.eq_key - ~TRANSIENT.order - ~TRANSIENT.order_key - ~TRANSIENT.hash - ~TRANSIENT.init - ~TRANSIENT.metadata - ~TRANSIENT.type - ~TRANSIENT.converter - ~TRANSIENT.kw_only - ~TRANSIENT.inherited - ~TRANSIENT.on_setattr - ~TRANSIENT.alias - ~TRANSIENT.allow_constraint_override - ~TRANSIENT.attr_prefix - ~TRANSIENT.default_options - ~TRANSIENT.none_ok - ~TRANSIENT.template_class - ~TRANSIENT.mode - ~TRANSIENT.var - ~TRANSIENT.rate - ~TRANSIENT.constraints - ~TRANSIENT.config_cls - ~TRANSIENT.active - ~TRANSIENT.combos - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_dynamics.Time.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_dynamics.Time.rst.txt deleted file mode 100644 index 042e844..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_dynamics.Time.rst.txt +++ /dev/null @@ -1,77 +0,0 @@ -engforge.attr\_dynamics.Time -============================ - -.. currentmodule:: engforge.attr_dynamics - -.. autoclass:: Time - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Time.add_var_constraint - ~Time.class_validate - ~Time.collect_attr_inst - ~Time.collect_cls - ~Time.configure_for_system - ~Time.configure_instance - ~Time.constraint_exists - ~Time.create_instance - ~Time.define - ~Time.define_validate - ~Time.evolve - ~Time.from_counting_attr - ~Time.handle_instance - ~Time.integrate - ~Time.make_attribute - ~Time.make_factory - ~Time.process_combos - ~Time.subclasses - ~Time.unpack_atrs - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Time.name - ~Time.default - ~Time.validator - ~Time.repr - ~Time.eq - ~Time.eq_key - ~Time.order - ~Time.order_key - ~Time.hash - ~Time.init - ~Time.metadata - ~Time.type - ~Time.converter - ~Time.kw_only - ~Time.inherited - ~Time.on_setattr - ~Time.alias - ~Time.allow_constraint_override - ~Time.attr_prefix - ~Time.default_options - ~Time.none_ok - ~Time.template_class - ~Time.mode - ~Time.var - ~Time.rate - ~Time.constraints - ~Time.config_cls - ~Time.active - ~Time.combos - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_dynamics.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_dynamics.rst.txt deleted file mode 100644 index 7c2d0bc..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_dynamics.rst.txt +++ /dev/null @@ -1,34 +0,0 @@ -engforge.attr\_dynamics -======================= - -.. automodule:: engforge.attr_dynamics - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - IntegratorInstance - TRANSIENT - Time - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.PLOT.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.PLOT.rst.txt deleted file mode 100644 index 6c19b73..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.PLOT.rst.txt +++ /dev/null @@ -1,85 +0,0 @@ -engforge.attr\_plotting.Plot -============================ - -.. currentmodule:: engforge.attr_plotting - -.. autoclass:: Plot - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Plot.class_validate - ~Plot.collect_attr_inst - ~Plot.collect_cls - ~Plot.configure_for_system - ~Plot.configure_instance - ~Plot.create_instance - ~Plot.define - ~Plot.define_validate - ~Plot.evolve - ~Plot.from_counting_attr - ~Plot.handle_instance - ~Plot.make_attribute - ~Plot.make_factory - ~Plot.plot_extra - ~Plot.plot_vars - ~Plot.process_combos - ~Plot.subclasses - ~Plot.unpack_atrs - ~Plot.validate_plot_args - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Plot.name - ~Plot.default - ~Plot.validator - ~Plot.repr - ~Plot.eq - ~Plot.eq_key - ~Plot.order - ~Plot.order_key - ~Plot.hash - ~Plot.init - ~Plot.metadata - ~Plot.type - ~Plot.converter - ~Plot.kw_only - ~Plot.inherited - ~Plot.on_setattr - ~Plot.alias - ~Plot.attr_prefix - ~Plot.cls_vars - ~Plot.default_options - ~Plot.none_ok - ~Plot.std_fields - ~Plot.template_class - ~Plot.title - ~Plot.type_var_options - ~Plot.types - ~Plot.kind - ~Plot.x - ~Plot.y - ~Plot.hue - ~Plot.col - ~Plot.row - ~Plot.plot_func - ~Plot.plot_args - ~Plot.config_cls - ~Plot.active - ~Plot.combos - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.PlotBase.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.PlotBase.rst.txt deleted file mode 100644 index e1748ba..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.PlotBase.rst.txt +++ /dev/null @@ -1,75 +0,0 @@ -engforge.attr\_plotting.PlotBase -================================ - -.. currentmodule:: engforge.attr_plotting - -.. autoclass:: PlotBase - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~PlotBase.class_validate - ~PlotBase.collect_attr_inst - ~PlotBase.collect_cls - ~PlotBase.configure_for_system - ~PlotBase.configure_instance - ~PlotBase.create_instance - ~PlotBase.define - ~PlotBase.define_validate - ~PlotBase.evolve - ~PlotBase.from_counting_attr - ~PlotBase.handle_instance - ~PlotBase.make_attribute - ~PlotBase.make_factory - ~PlotBase.plot_extra - ~PlotBase.plot_vars - ~PlotBase.process_combos - ~PlotBase.subclasses - ~PlotBase.unpack_atrs - ~PlotBase.validate_plot_args - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~PlotBase.name - ~PlotBase.default - ~PlotBase.validator - ~PlotBase.repr - ~PlotBase.eq - ~PlotBase.eq_key - ~PlotBase.order - ~PlotBase.order_key - ~PlotBase.hash - ~PlotBase.init - ~PlotBase.metadata - ~PlotBase.type - ~PlotBase.converter - ~PlotBase.kw_only - ~PlotBase.inherited - ~PlotBase.on_setattr - ~PlotBase.alias - ~PlotBase.attr_prefix - ~PlotBase.cls_vars - ~PlotBase.default_options - ~PlotBase.none_ok - ~PlotBase.template_class - ~PlotBase.title - ~PlotBase.config_cls - ~PlotBase.kind - ~PlotBase.active - ~PlotBase.combos - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.PlotInstance.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.PlotInstance.rst.txt deleted file mode 100644 index d50d6ae..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.PlotInstance.rst.txt +++ /dev/null @@ -1,44 +0,0 @@ -engforge.attr\_plotting.PlotInstance -==================================== - -.. currentmodule:: engforge.attr_plotting - -.. autoclass:: PlotInstance - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~PlotInstance.as_ref_dict - ~PlotInstance.compile - ~PlotInstance.get_alias - ~PlotInstance.is_active - ~PlotInstance.plot - ~PlotInstance.process_fig - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~PlotInstance.active - ~PlotInstance.classname - ~PlotInstance.combos - ~PlotInstance.identity - ~PlotInstance.refs - ~PlotInstance.plot_cls - ~PlotInstance.system - ~PlotInstance.class_attr - ~PlotInstance.backref - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.PlotLog.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.PlotLog.rst.txt deleted file mode 100644 index aa4c74a..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.PlotLog.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.attr\_plotting.PlotLog -=============================== - -.. currentmodule:: engforge.attr_plotting - -.. autoclass:: PlotLog - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~PlotLog.add_fields - ~PlotLog.change_all_log_lvl - ~PlotLog.critical - ~PlotLog.debug - ~PlotLog.error - ~PlotLog.extract_message - ~PlotLog.filter - ~PlotLog.info - ~PlotLog.installSTDLogger - ~PlotLog.message_with_identiy - ~PlotLog.msg - ~PlotLog.resetLog - ~PlotLog.resetSystemLogs - ~PlotLog.slack_notification - ~PlotLog.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~PlotLog.identity - ~PlotLog.log_fmt - ~PlotLog.log_level - ~PlotLog.log_on - ~PlotLog.logger - ~PlotLog.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.PlottingMixin.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.PlottingMixin.rst.txt deleted file mode 100644 index 811b3dd..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.PlottingMixin.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -engforge.attr\_plotting.PlottingMixin -===================================== - -.. currentmodule:: engforge.attr_plotting - -.. autoclass:: PlottingMixin - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~PlottingMixin.make_plots - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~PlottingMixin.plots - ~PlottingMixin.stored_plots - ~PlottingMixin.traces - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.Trace.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.Trace.rst.txt deleted file mode 100644 index cad2d94..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.Trace.rst.txt +++ /dev/null @@ -1,87 +0,0 @@ -engforge.attr\_plotting.Trace -============================= - -.. currentmodule:: engforge.attr_plotting - -.. autoclass:: Trace - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Trace.class_validate - ~Trace.collect_attr_inst - ~Trace.collect_cls - ~Trace.configure_for_system - ~Trace.configure_instance - ~Trace.create_instance - ~Trace.define - ~Trace.define_validate - ~Trace.evolve - ~Trace.from_counting_attr - ~Trace.handle_instance - ~Trace.make_attribute - ~Trace.make_factory - ~Trace.plot_extra - ~Trace.plot_vars - ~Trace.process_combos - ~Trace.subclasses - ~Trace.unpack_atrs - ~Trace.valid_non_vars - ~Trace.valid_vars_options - ~Trace.validate_plot_args - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Trace.name - ~Trace.default - ~Trace.validator - ~Trace.repr - ~Trace.eq - ~Trace.eq_key - ~Trace.order - ~Trace.order_key - ~Trace.hash - ~Trace.init - ~Trace.metadata - ~Trace.type - ~Trace.converter - ~Trace.kw_only - ~Trace.inherited - ~Trace.on_setattr - ~Trace.alias - ~Trace.all_options - ~Trace.always - ~Trace.attr_prefix - ~Trace.cls_vars - ~Trace.default_options - ~Trace.none_ok - ~Trace.template_class - ~Trace.title - ~Trace.type_options - ~Trace.type_var_options - ~Trace.types - ~Trace.y2 - ~Trace.y - ~Trace.x - ~Trace.plot_args - ~Trace.extra_args - ~Trace.config_cls - ~Trace.kind - ~Trace.active - ~Trace.combos - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.TraceInstance.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.TraceInstance.rst.txt deleted file mode 100644 index 2be3988..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.TraceInstance.rst.txt +++ /dev/null @@ -1,45 +0,0 @@ -engforge.attr\_plotting.TraceInstance -===================================== - -.. currentmodule:: engforge.attr_plotting - -.. autoclass:: TraceInstance - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~TraceInstance.as_ref_dict - ~TraceInstance.compile - ~TraceInstance.get_alias - ~TraceInstance.is_active - ~TraceInstance.plot - ~TraceInstance.plot_extra - ~TraceInstance.process_fig - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~TraceInstance.active - ~TraceInstance.classname - ~TraceInstance.combos - ~TraceInstance.identity - ~TraceInstance.refs - ~TraceInstance.plot_cls - ~TraceInstance.system - ~TraceInstance.class_attr - ~TraceInstance.backref - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.conv_ctx.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.conv_ctx.rst.txt deleted file mode 100644 index a71663f..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.conv_ctx.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.attr\_plotting.conv\_ctx -================================= - -.. currentmodule:: engforge.attr_plotting - -.. autofunction:: conv_ctx \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.conv_maps.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.conv_maps.rst.txt deleted file mode 100644 index 5976995..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.conv_maps.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.attr\_plotting.conv\_maps -================================== - -.. currentmodule:: engforge.attr_plotting - -.. autofunction:: conv_maps \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.conv_theme.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.conv_theme.rst.txt deleted file mode 100644 index 36a824a..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.conv_theme.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.attr\_plotting.conv\_theme -=================================== - -.. currentmodule:: engforge.attr_plotting - -.. autofunction:: conv_theme \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.install_seaborn.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.install_seaborn.rst.txt deleted file mode 100644 index 042c0fb..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.install_seaborn.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.attr\_plotting.install\_seaborn -======================================== - -.. currentmodule:: engforge.attr_plotting - -.. autofunction:: install_seaborn \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.rst.txt deleted file mode 100644 index 9d08358..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -engforge.attr\_plotting -======================= - -.. automodule:: engforge.attr_plotting - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - conv_ctx - conv_maps - conv_theme - install_seaborn - save_all_figures_to_pdf - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - PLOT - Plot - PlotBase - PlotInstance - PlotLog - PlottingMixin - Trace - TraceInstance - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.save_all_figures_to_pdf.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.save_all_figures_to_pdf.rst.txt deleted file mode 100644 index 6d61811..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_plotting.save_all_figures_to_pdf.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.attr\_plotting.save\_all\_figures\_to\_pdf -=================================================== - -.. currentmodule:: engforge.attr_plotting - -.. autofunction:: save_all_figures_to_pdf \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_signals.Signal.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_signals.Signal.rst.txt deleted file mode 100644 index e34df7e..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_signals.Signal.rst.txt +++ /dev/null @@ -1,72 +0,0 @@ -engforge.attr\_signals.Signal -============================= - -.. currentmodule:: engforge.attr_signals - -.. autoclass:: Signal - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Signal.class_validate - ~Signal.collect_attr_inst - ~Signal.collect_cls - ~Signal.configure_for_system - ~Signal.configure_instance - ~Signal.create_instance - ~Signal.define - ~Signal.define_validate - ~Signal.evolve - ~Signal.from_counting_attr - ~Signal.handle_instance - ~Signal.make_attribute - ~Signal.make_factory - ~Signal.process_combos - ~Signal.subclasses - ~Signal.unpack_atrs - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Signal.name - ~Signal.default - ~Signal.validator - ~Signal.repr - ~Signal.eq - ~Signal.eq_key - ~Signal.order - ~Signal.order_key - ~Signal.hash - ~Signal.init - ~Signal.metadata - ~Signal.type - ~Signal.converter - ~Signal.kw_only - ~Signal.inherited - ~Signal.on_setattr - ~Signal.alias - ~Signal.attr_prefix - ~Signal.default_options - ~Signal.none_ok - ~Signal.template_class - ~Signal.mode - ~Signal.target - ~Signal.source - ~Signal.config_cls - ~Signal.active - ~Signal.combos - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_signals.SignalInstance.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_signals.SignalInstance.rst.txt deleted file mode 100644 index 23a623d..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_signals.SignalInstance.rst.txt +++ /dev/null @@ -1,44 +0,0 @@ -engforge.attr\_signals.SignalInstance -===================================== - -.. currentmodule:: engforge.attr_signals - -.. autoclass:: SignalInstance - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~SignalInstance.apply - ~SignalInstance.as_ref_dict - ~SignalInstance.compile - ~SignalInstance.get_alias - ~SignalInstance.is_active - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~SignalInstance.active - ~SignalInstance.classname - ~SignalInstance.combos - ~SignalInstance.mode - ~SignalInstance.system - ~SignalInstance.signal - ~SignalInstance.target - ~SignalInstance.source - ~SignalInstance.class_attr - ~SignalInstance.backref - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_signals.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_signals.rst.txt deleted file mode 100644 index 5015c40..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_signals.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -engforge.attr\_signals -====================== - -.. automodule:: engforge.attr_signals - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - Signal - SignalInstance - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_slots.Slot.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_slots.Slot.rst.txt deleted file mode 100644 index e61d0da..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_slots.Slot.rst.txt +++ /dev/null @@ -1,77 +0,0 @@ -engforge.attr\_slots.Slot -========================= - -.. currentmodule:: engforge.attr_slots - -.. autoclass:: Slot - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Slot.class_validate - ~Slot.collect_attr_inst - ~Slot.collect_cls - ~Slot.configure_for_system - ~Slot.configure_instance - ~Slot.create_instance - ~Slot.define - ~Slot.define_iterator - ~Slot.define_validate - ~Slot.evolve - ~Slot.from_counting_attr - ~Slot.handle_instance - ~Slot.make_accepted - ~Slot.make_attribute - ~Slot.make_factory - ~Slot.process_combos - ~Slot.subclasses - ~Slot.unpack_atrs - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Slot.name - ~Slot.default - ~Slot.validator - ~Slot.repr - ~Slot.eq - ~Slot.eq_key - ~Slot.order - ~Slot.order_key - ~Slot.hash - ~Slot.init - ~Slot.metadata - ~Slot.type - ~Slot.converter - ~Slot.kw_only - ~Slot.inherited - ~Slot.on_setattr - ~Slot.alias - ~Slot.attr_prefix - ~Slot.default_ok - ~Slot.default_options - ~Slot.dflt_kw - ~Slot.instance_class - ~Slot.none_ok - ~Slot.template_class - ~Slot.accepted - ~Slot.config_cls - ~Slot.is_iter - ~Slot.wide - ~Slot.active - ~Slot.combos - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_slots.SlotLog.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_slots.SlotLog.rst.txt deleted file mode 100644 index 54da7af..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_slots.SlotLog.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.attr\_slots.SlotLog -============================ - -.. currentmodule:: engforge.attr_slots - -.. autoclass:: SlotLog - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~SlotLog.add_fields - ~SlotLog.change_all_log_lvl - ~SlotLog.critical - ~SlotLog.debug - ~SlotLog.error - ~SlotLog.extract_message - ~SlotLog.filter - ~SlotLog.info - ~SlotLog.installSTDLogger - ~SlotLog.message_with_identiy - ~SlotLog.msg - ~SlotLog.resetLog - ~SlotLog.resetSystemLogs - ~SlotLog.slack_notification - ~SlotLog.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~SlotLog.identity - ~SlotLog.log_fmt - ~SlotLog.log_level - ~SlotLog.log_on - ~SlotLog.logger - ~SlotLog.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_slots.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_slots.rst.txt deleted file mode 100644 index 5bae2e4..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_slots.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -engforge.attr\_slots -==================== - -.. automodule:: engforge.attr_slots - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - Slot - SlotLog - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_solver.AttrSolverLog.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_solver.AttrSolverLog.rst.txt deleted file mode 100644 index c90c836..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_solver.AttrSolverLog.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.attr\_solver.AttrSolverLog -=================================== - -.. currentmodule:: engforge.attr_solver - -.. autoclass:: AttrSolverLog - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~AttrSolverLog.add_fields - ~AttrSolverLog.change_all_log_lvl - ~AttrSolverLog.critical - ~AttrSolverLog.debug - ~AttrSolverLog.error - ~AttrSolverLog.extract_message - ~AttrSolverLog.filter - ~AttrSolverLog.info - ~AttrSolverLog.installSTDLogger - ~AttrSolverLog.message_with_identiy - ~AttrSolverLog.msg - ~AttrSolverLog.resetLog - ~AttrSolverLog.resetSystemLogs - ~AttrSolverLog.slack_notification - ~AttrSolverLog.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~AttrSolverLog.identity - ~AttrSolverLog.log_fmt - ~AttrSolverLog.log_level - ~AttrSolverLog.log_on - ~AttrSolverLog.logger - ~AttrSolverLog.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_solver.Solver.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_solver.Solver.rst.txt deleted file mode 100644 index 2d9b6fb..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_solver.Solver.rst.txt +++ /dev/null @@ -1,85 +0,0 @@ -engforge.attr\_solver.Solver -============================ - -.. currentmodule:: engforge.attr_solver - -.. autoclass:: Solver - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Solver.add_var_constraint - ~Solver.class_validate - ~Solver.collect_attr_inst - ~Solver.collect_cls - ~Solver.con_eq - ~Solver.con_ineq - ~Solver.configure_for_system - ~Solver.configure_instance - ~Solver.constraint_equality - ~Solver.constraint_exists - ~Solver.constraint_inequality - ~Solver.create_instance - ~Solver.declare_var - ~Solver.define_validate - ~Solver.evolve - ~Solver.from_counting_attr - ~Solver.handle_instance - ~Solver.make_attribute - ~Solver.make_factory - ~Solver.obj - ~Solver.objective - ~Solver.process_combos - ~Solver.subclasses - ~Solver.unpack_atrs - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Solver.name - ~Solver.default - ~Solver.validator - ~Solver.repr - ~Solver.eq - ~Solver.eq_key - ~Solver.order - ~Solver.order_key - ~Solver.hash - ~Solver.init - ~Solver.metadata - ~Solver.type - ~Solver.converter - ~Solver.kw_only - ~Solver.inherited - ~Solver.on_setattr - ~Solver.alias - ~Solver.allow_constraint_override - ~Solver.attr_prefix - ~Solver.combos - ~Solver.default_options - ~Solver.define - ~Solver.lhs - ~Solver.none_ok - ~Solver.rhs - ~Solver.template_class - ~Solver.var - ~Solver.slvtype - ~Solver.constraints - ~Solver.normalize - ~Solver.active - ~Solver.config_cls - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_solver.SolverInstance.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_solver.SolverInstance.rst.txt deleted file mode 100644 index 43a4ac8..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_solver.SolverInstance.rst.txt +++ /dev/null @@ -1,48 +0,0 @@ -engforge.attr\_solver.SolverInstance -==================================== - -.. currentmodule:: engforge.attr_solver - -.. autoclass:: SolverInstance - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~SolverInstance.as_ref_dict - ~SolverInstance.compile - ~SolverInstance.get_alias - ~SolverInstance.is_active - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~SolverInstance.active - ~SolverInstance.classname - ~SolverInstance.combos - ~SolverInstance.constraints - ~SolverInstance.normalize - ~SolverInstance.slvtype - ~SolverInstance.system - ~SolverInstance.solver - ~SolverInstance.obj - ~SolverInstance.var - ~SolverInstance.lhs - ~SolverInstance.rhs - ~SolverInstance.const_f - ~SolverInstance.class_attr - ~SolverInstance.backref - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attr_solver.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attr_solver.rst.txt deleted file mode 100644 index 42fef93..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attr_solver.rst.txt +++ /dev/null @@ -1,34 +0,0 @@ -engforge.attr\_solver -===================== - -.. automodule:: engforge.attr_solver - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - AttrSolverLog - Solver - SolverInstance - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.attributes.ATTRLog.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attributes.ATTRLog.rst.txt deleted file mode 100644 index 23117c3..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attributes.ATTRLog.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.attributes.ATTRLog -=========================== - -.. currentmodule:: engforge.attributes - -.. autoclass:: ATTRLog - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~ATTRLog.add_fields - ~ATTRLog.change_all_log_lvl - ~ATTRLog.critical - ~ATTRLog.debug - ~ATTRLog.error - ~ATTRLog.extract_message - ~ATTRLog.filter - ~ATTRLog.info - ~ATTRLog.installSTDLogger - ~ATTRLog.message_with_identiy - ~ATTRLog.msg - ~ATTRLog.resetLog - ~ATTRLog.resetSystemLogs - ~ATTRLog.slack_notification - ~ATTRLog.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ATTRLog.identity - ~ATTRLog.log_fmt - ~ATTRLog.log_level - ~ATTRLog.log_on - ~ATTRLog.logger - ~ATTRLog.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attributes.ATTR_BASE.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attributes.ATTR_BASE.rst.txt deleted file mode 100644 index de29d1c..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attributes.ATTR_BASE.rst.txt +++ /dev/null @@ -1,69 +0,0 @@ -engforge.attributes.ATTR\_BASE -============================== - -.. currentmodule:: engforge.attributes - -.. autoclass:: ATTR_BASE - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~ATTR_BASE.class_validate - ~ATTR_BASE.collect_attr_inst - ~ATTR_BASE.collect_cls - ~ATTR_BASE.configure_for_system - ~ATTR_BASE.configure_instance - ~ATTR_BASE.create_instance - ~ATTR_BASE.define - ~ATTR_BASE.define_validate - ~ATTR_BASE.evolve - ~ATTR_BASE.from_counting_attr - ~ATTR_BASE.handle_instance - ~ATTR_BASE.make_attribute - ~ATTR_BASE.make_factory - ~ATTR_BASE.process_combos - ~ATTR_BASE.subclasses - ~ATTR_BASE.unpack_atrs - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ATTR_BASE.name - ~ATTR_BASE.default - ~ATTR_BASE.validator - ~ATTR_BASE.repr - ~ATTR_BASE.eq - ~ATTR_BASE.eq_key - ~ATTR_BASE.order - ~ATTR_BASE.order_key - ~ATTR_BASE.hash - ~ATTR_BASE.init - ~ATTR_BASE.metadata - ~ATTR_BASE.type - ~ATTR_BASE.converter - ~ATTR_BASE.kw_only - ~ATTR_BASE.inherited - ~ATTR_BASE.on_setattr - ~ATTR_BASE.alias - ~ATTR_BASE.attr_prefix - ~ATTR_BASE.default_options - ~ATTR_BASE.none_ok - ~ATTR_BASE.template_class - ~ATTR_BASE.config_cls - ~ATTR_BASE.active - ~ATTR_BASE.combos - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attributes.AttributeInstance.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attributes.AttributeInstance.rst.txt deleted file mode 100644 index 1906bdb..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attributes.AttributeInstance.rst.txt +++ /dev/null @@ -1,39 +0,0 @@ -engforge.attributes.AttributeInstance -===================================== - -.. currentmodule:: engforge.attributes - -.. autoclass:: AttributeInstance - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~AttributeInstance.as_ref_dict - ~AttributeInstance.compile - ~AttributeInstance.get_alias - ~AttributeInstance.is_active - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~AttributeInstance.active - ~AttributeInstance.classname - ~AttributeInstance.combos - ~AttributeInstance.class_attr - ~AttributeInstance.system - ~AttributeInstance.backref - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.attributes.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.attributes.rst.txt deleted file mode 100644 index fef17e8..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.attributes.rst.txt +++ /dev/null @@ -1,34 +0,0 @@ -engforge.attributes -=================== - -.. automodule:: engforge.attributes - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - ATTRLog - ATTR_BASE - AttributeInstance - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.common.ForgeLog.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.common.ForgeLog.rst.txt deleted file mode 100644 index 0231c97..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.common.ForgeLog.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.common.ForgeLog -======================== - -.. currentmodule:: engforge.common - -.. autoclass:: ForgeLog - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~ForgeLog.add_fields - ~ForgeLog.change_all_log_lvl - ~ForgeLog.critical - ~ForgeLog.debug - ~ForgeLog.error - ~ForgeLog.extract_message - ~ForgeLog.filter - ~ForgeLog.info - ~ForgeLog.installSTDLogger - ~ForgeLog.message_with_identiy - ~ForgeLog.msg - ~ForgeLog.resetLog - ~ForgeLog.resetSystemLogs - ~ForgeLog.slack_notification - ~ForgeLog.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ForgeLog.identity - ~ForgeLog.log_fmt - ~ForgeLog.log_level - ~ForgeLog.log_on - ~ForgeLog.logger - ~ForgeLog.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.common.chunks.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.common.chunks.rst.txt deleted file mode 100644 index 732ba27..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.common.chunks.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.common.chunks -====================== - -.. currentmodule:: engforge.common - -.. autofunction:: chunks \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.common.get_size.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.common.get_size.rst.txt deleted file mode 100644 index 530a2c9..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.common.get_size.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.common.get\_size -========================= - -.. currentmodule:: engforge.common - -.. autofunction:: get_size \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.common.inst_vectorize.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.common.inst_vectorize.rst.txt deleted file mode 100644 index 8a25e56..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.common.inst_vectorize.rst.txt +++ /dev/null @@ -1,24 +0,0 @@ -engforge.common.inst\_vectorize -=============================== - -.. currentmodule:: engforge.common - -.. autoclass:: inst_vectorize - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - - - - - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.common.is_ec2_instance.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.common.is_ec2_instance.rst.txt deleted file mode 100644 index c39a2a0..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.common.is_ec2_instance.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.common.is\_ec2\_instance -================================= - -.. currentmodule:: engforge.common - -.. autofunction:: is_ec2_instance \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.common.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.common.rst.txt deleted file mode 100644 index 6afc397..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.common.rst.txt +++ /dev/null @@ -1,43 +0,0 @@ -engforge.common -=============== - -.. automodule:: engforge.common - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - chunks - get_size - is_ec2_instance - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - ForgeLog - inst_vectorize - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.component_collections.ComponentDict.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.component_collections.ComponentDict.rst.txt deleted file mode 100644 index 7ce6676..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.component_collections.ComponentDict.rst.txt +++ /dev/null @@ -1,189 +0,0 @@ -engforge.component\_collections.ComponentDict -============================================= - -.. currentmodule:: engforge.component_collections - -.. autoclass:: ComponentDict - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~ComponentDict.add_fields - ~ComponentDict.change_all_log_lvl - ~ComponentDict.check_ref_slot_type - ~ComponentDict.clear - ~ComponentDict.cls_all_attrs_fields - ~ComponentDict.cls_all_property_keys - ~ComponentDict.cls_all_property_labels - ~ComponentDict.cls_compile - ~ComponentDict.collect_all_attributes - ~ComponentDict.collect_comp_refs - ~ComponentDict.collect_dynamic_refs - ~ComponentDict.collect_inst_attributes - ~ComponentDict.collect_post_update_refs - ~ComponentDict.collect_solver_refs - ~ComponentDict.collect_update_refs - ~ComponentDict.comp_references - ~ComponentDict.compile_classes - ~ComponentDict.copy - ~ComponentDict.copy_config_at_state - ~ComponentDict.create_dynamic_matricies - ~ComponentDict.create_feedthrough_matrix - ~ComponentDict.create_input_matrix - ~ComponentDict.create_output_constants - ~ComponentDict.create_output_matrix - ~ComponentDict.create_state_constants - ~ComponentDict.create_state_matrix - ~ComponentDict.critical - ~ComponentDict.debug - ~ComponentDict.determine_nearest_stationary_state - ~ComponentDict.difference - ~ComponentDict.error - ~ComponentDict.extract_message - ~ComponentDict.filter - ~ComponentDict.format_columns - ~ComponentDict.fromkeys - ~ComponentDict.get - ~ComponentDict.get_system_input_refs - ~ComponentDict.go_through_configurations - ~ComponentDict.info - ~ComponentDict.input_attrs - ~ComponentDict.input_fields - ~ComponentDict.installSTDLogger - ~ComponentDict.internal_components - ~ComponentDict.internal_configurations - ~ComponentDict.internal_references - ~ComponentDict.internal_systems - ~ComponentDict.internal_tabulations - ~ComponentDict.items - ~ComponentDict.keys - ~ComponentDict.linear_output - ~ComponentDict.linear_step - ~ComponentDict.locate - ~ComponentDict.locate_ref - ~ComponentDict.message_with_identiy - ~ComponentDict.msg - ~ComponentDict.nonlinear_output - ~ComponentDict.nonlinear_step - ~ComponentDict.numeric_fields - ~ComponentDict.parent_configurations_cls - ~ComponentDict.parse_run_kwargs - ~ComponentDict.parse_simulation_input - ~ComponentDict.plot_attributes - ~ComponentDict.pop - ~ComponentDict.popitem - ~ComponentDict.post_update - ~ComponentDict.pre_compile - ~ComponentDict.print_info - ~ComponentDict.rate - ~ComponentDict.rate_linear - ~ComponentDict.rate_nonlinear - ~ComponentDict.ref_dXdt - ~ComponentDict.reset - ~ComponentDict.resetLog - ~ComponentDict.resetSystemLogs - ~ComponentDict.set_attr - ~ComponentDict.set_time - ~ComponentDict.setattrs - ~ComponentDict.setdefault - ~ComponentDict.signals_attributes - ~ComponentDict.slack_notification - ~ComponentDict.slot_refs - ~ComponentDict.slots_attributes - ~ComponentDict.smart_split_dataframe - ~ComponentDict.solvers_attributes - ~ComponentDict.step - ~ComponentDict.subclasses - ~ComponentDict.subcls_compile - ~ComponentDict.system_properties_classdef - ~ComponentDict.system_references - ~ComponentDict.table_fields - ~ComponentDict.trace_attributes - ~ComponentDict.transients_attributes - ~ComponentDict.update - ~ComponentDict.update_dynamics - ~ComponentDict.update_feedthrough - ~ComponentDict.update_input - ~ComponentDict.update_output_constants - ~ComponentDict.update_output_matrix - ~ComponentDict.update_state - ~ComponentDict.update_state_constants - ~ComponentDict.validate_class - ~ComponentDict.values - ~ComponentDict.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ComponentDict.Ut_ref - ~ComponentDict.Xt_ref - ~ComponentDict.Yt_ref - ~ComponentDict.anything_changed - ~ComponentDict.as_dict - ~ComponentDict.attrs_fields - ~ComponentDict.classname - ~ComponentDict.current - ~ComponentDict.dXtdt_ref - ~ComponentDict.data_dict - ~ComponentDict.dataframe_constants - ~ComponentDict.dataframe_variants - ~ComponentDict.displayname - ~ComponentDict.dynamic_A - ~ComponentDict.dynamic_B - ~ComponentDict.dynamic_C - ~ComponentDict.dynamic_D - ~ComponentDict.dynamic_F - ~ComponentDict.dynamic_K - ~ComponentDict.dynamic_input - ~ComponentDict.dynamic_input_vars - ~ComponentDict.dynamic_output - ~ComponentDict.dynamic_output_vars - ~ComponentDict.dynamic_state - ~ComponentDict.dynamic_state_vars - ~ComponentDict.filename - ~ComponentDict.identity - ~ComponentDict.input_as_dict - ~ComponentDict.last_context - ~ComponentDict.log_fmt - ~ComponentDict.log_level - ~ComponentDict.log_on - ~ComponentDict.log_silo - ~ComponentDict.logger - ~ComponentDict.nonlinear - ~ComponentDict.numeric_as_dict - ~ComponentDict.numeric_hash - ~ComponentDict.plotable_variables - ~ComponentDict.skip_plot_vars - ~ComponentDict.slack_webhook_url - ~ComponentDict.static_A - ~ComponentDict.static_B - ~ComponentDict.static_C - ~ComponentDict.static_D - ~ComponentDict.static_F - ~ComponentDict.static_K - ~ComponentDict.system_id - ~ComponentDict.time - ~ComponentDict.unique_hash - ~ComponentDict.update_interval - ~ComponentDict.wide - ~ComponentDict.component_type - ~ComponentDict.data - ~ComponentDict.current_item - ~ComponentDict.parent - ~ComponentDict.name - ~ComponentDict.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.component_collections.ComponentIter.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.component_collections.ComponentIter.rst.txt deleted file mode 100644 index dbc5113..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.component_collections.ComponentIter.rst.txt +++ /dev/null @@ -1,178 +0,0 @@ -engforge.component\_collections.ComponentIter -============================================= - -.. currentmodule:: engforge.component_collections - -.. autoclass:: ComponentIter - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~ComponentIter.add_fields - ~ComponentIter.change_all_log_lvl - ~ComponentIter.check_ref_slot_type - ~ComponentIter.cls_all_attrs_fields - ~ComponentIter.cls_all_property_keys - ~ComponentIter.cls_all_property_labels - ~ComponentIter.cls_compile - ~ComponentIter.collect_all_attributes - ~ComponentIter.collect_comp_refs - ~ComponentIter.collect_dynamic_refs - ~ComponentIter.collect_inst_attributes - ~ComponentIter.collect_post_update_refs - ~ComponentIter.collect_solver_refs - ~ComponentIter.collect_update_refs - ~ComponentIter.comp_references - ~ComponentIter.compile_classes - ~ComponentIter.copy_config_at_state - ~ComponentIter.create_dynamic_matricies - ~ComponentIter.create_feedthrough_matrix - ~ComponentIter.create_input_matrix - ~ComponentIter.create_output_constants - ~ComponentIter.create_output_matrix - ~ComponentIter.create_state_constants - ~ComponentIter.create_state_matrix - ~ComponentIter.critical - ~ComponentIter.debug - ~ComponentIter.determine_nearest_stationary_state - ~ComponentIter.difference - ~ComponentIter.error - ~ComponentIter.extract_message - ~ComponentIter.filter - ~ComponentIter.format_columns - ~ComponentIter.get_system_input_refs - ~ComponentIter.go_through_configurations - ~ComponentIter.info - ~ComponentIter.input_attrs - ~ComponentIter.input_fields - ~ComponentIter.installSTDLogger - ~ComponentIter.internal_components - ~ComponentIter.internal_configurations - ~ComponentIter.internal_references - ~ComponentIter.internal_systems - ~ComponentIter.internal_tabulations - ~ComponentIter.linear_output - ~ComponentIter.linear_step - ~ComponentIter.locate - ~ComponentIter.locate_ref - ~ComponentIter.message_with_identiy - ~ComponentIter.msg - ~ComponentIter.nonlinear_output - ~ComponentIter.nonlinear_step - ~ComponentIter.numeric_fields - ~ComponentIter.parent_configurations_cls - ~ComponentIter.parse_run_kwargs - ~ComponentIter.parse_simulation_input - ~ComponentIter.plot_attributes - ~ComponentIter.post_update - ~ComponentIter.pre_compile - ~ComponentIter.print_info - ~ComponentIter.rate - ~ComponentIter.rate_linear - ~ComponentIter.rate_nonlinear - ~ComponentIter.ref_dXdt - ~ComponentIter.reset - ~ComponentIter.resetLog - ~ComponentIter.resetSystemLogs - ~ComponentIter.set_attr - ~ComponentIter.set_time - ~ComponentIter.setattrs - ~ComponentIter.signals_attributes - ~ComponentIter.slack_notification - ~ComponentIter.slot_refs - ~ComponentIter.slots_attributes - ~ComponentIter.smart_split_dataframe - ~ComponentIter.solvers_attributes - ~ComponentIter.step - ~ComponentIter.subclasses - ~ComponentIter.subcls_compile - ~ComponentIter.system_properties_classdef - ~ComponentIter.system_references - ~ComponentIter.table_fields - ~ComponentIter.trace_attributes - ~ComponentIter.transients_attributes - ~ComponentIter.update - ~ComponentIter.update_dynamics - ~ComponentIter.update_feedthrough - ~ComponentIter.update_input - ~ComponentIter.update_output_constants - ~ComponentIter.update_output_matrix - ~ComponentIter.update_state - ~ComponentIter.update_state_constants - ~ComponentIter.validate_class - ~ComponentIter.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ComponentIter.Ut_ref - ~ComponentIter.Xt_ref - ~ComponentIter.Yt_ref - ~ComponentIter.anything_changed - ~ComponentIter.as_dict - ~ComponentIter.attrs_fields - ~ComponentIter.classname - ~ComponentIter.current - ~ComponentIter.dXtdt_ref - ~ComponentIter.data_dict - ~ComponentIter.dataframe_constants - ~ComponentIter.dataframe_variants - ~ComponentIter.displayname - ~ComponentIter.dynamic_A - ~ComponentIter.dynamic_B - ~ComponentIter.dynamic_C - ~ComponentIter.dynamic_D - ~ComponentIter.dynamic_F - ~ComponentIter.dynamic_K - ~ComponentIter.dynamic_input - ~ComponentIter.dynamic_input_vars - ~ComponentIter.dynamic_output - ~ComponentIter.dynamic_output_vars - ~ComponentIter.dynamic_state - ~ComponentIter.dynamic_state_vars - ~ComponentIter.filename - ~ComponentIter.identity - ~ComponentIter.input_as_dict - ~ComponentIter.last_context - ~ComponentIter.log_fmt - ~ComponentIter.log_level - ~ComponentIter.log_on - ~ComponentIter.log_silo - ~ComponentIter.logger - ~ComponentIter.nonlinear - ~ComponentIter.numeric_as_dict - ~ComponentIter.numeric_hash - ~ComponentIter.plotable_variables - ~ComponentIter.skip_plot_vars - ~ComponentIter.slack_webhook_url - ~ComponentIter.static_A - ~ComponentIter.static_B - ~ComponentIter.static_C - ~ComponentIter.static_D - ~ComponentIter.static_F - ~ComponentIter.static_K - ~ComponentIter.system_id - ~ComponentIter.time - ~ComponentIter.unique_hash - ~ComponentIter.update_interval - ~ComponentIter.wide - ~ComponentIter.data - ~ComponentIter.current_item - ~ComponentIter.parent - ~ComponentIter.name - ~ComponentIter.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.component_collections.ComponentIterator.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.component_collections.ComponentIterator.rst.txt deleted file mode 100644 index 7c56d14..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.component_collections.ComponentIterator.rst.txt +++ /dev/null @@ -1,190 +0,0 @@ -engforge.component\_collections.ComponentIterator -================================================= - -.. currentmodule:: engforge.component_collections - -.. autoclass:: ComponentIterator - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~ComponentIterator.add_fields - ~ComponentIterator.append - ~ComponentIterator.change_all_log_lvl - ~ComponentIterator.check_ref_slot_type - ~ComponentIterator.clear - ~ComponentIterator.cls_all_attrs_fields - ~ComponentIterator.cls_all_property_keys - ~ComponentIterator.cls_all_property_labels - ~ComponentIterator.cls_compile - ~ComponentIterator.collect_all_attributes - ~ComponentIterator.collect_comp_refs - ~ComponentIterator.collect_dynamic_refs - ~ComponentIterator.collect_inst_attributes - ~ComponentIterator.collect_post_update_refs - ~ComponentIterator.collect_solver_refs - ~ComponentIterator.collect_update_refs - ~ComponentIterator.comp_references - ~ComponentIterator.compile_classes - ~ComponentIterator.copy - ~ComponentIterator.copy_config_at_state - ~ComponentIterator.count - ~ComponentIterator.create_dynamic_matricies - ~ComponentIterator.create_feedthrough_matrix - ~ComponentIterator.create_input_matrix - ~ComponentIterator.create_output_constants - ~ComponentIterator.create_output_matrix - ~ComponentIterator.create_state_constants - ~ComponentIterator.create_state_matrix - ~ComponentIterator.critical - ~ComponentIterator.debug - ~ComponentIterator.determine_nearest_stationary_state - ~ComponentIterator.difference - ~ComponentIterator.error - ~ComponentIterator.extend - ~ComponentIterator.extract_message - ~ComponentIterator.filter - ~ComponentIterator.format_columns - ~ComponentIterator.get_system_input_refs - ~ComponentIterator.go_through_configurations - ~ComponentIterator.index - ~ComponentIterator.info - ~ComponentIterator.input_attrs - ~ComponentIterator.input_fields - ~ComponentIterator.insert - ~ComponentIterator.installSTDLogger - ~ComponentIterator.internal_components - ~ComponentIterator.internal_configurations - ~ComponentIterator.internal_references - ~ComponentIterator.internal_systems - ~ComponentIterator.internal_tabulations - ~ComponentIterator.linear_output - ~ComponentIterator.linear_step - ~ComponentIterator.locate - ~ComponentIterator.locate_ref - ~ComponentIterator.message_with_identiy - ~ComponentIterator.msg - ~ComponentIterator.nonlinear_output - ~ComponentIterator.nonlinear_step - ~ComponentIterator.numeric_fields - ~ComponentIterator.parent_configurations_cls - ~ComponentIterator.parse_run_kwargs - ~ComponentIterator.parse_simulation_input - ~ComponentIterator.plot_attributes - ~ComponentIterator.pop - ~ComponentIterator.post_update - ~ComponentIterator.pre_compile - ~ComponentIterator.print_info - ~ComponentIterator.rate - ~ComponentIterator.rate_linear - ~ComponentIterator.rate_nonlinear - ~ComponentIterator.ref_dXdt - ~ComponentIterator.remove - ~ComponentIterator.reset - ~ComponentIterator.resetLog - ~ComponentIterator.resetSystemLogs - ~ComponentIterator.reverse - ~ComponentIterator.set_attr - ~ComponentIterator.set_time - ~ComponentIterator.setattrs - ~ComponentIterator.signals_attributes - ~ComponentIterator.slack_notification - ~ComponentIterator.slot_refs - ~ComponentIterator.slots_attributes - ~ComponentIterator.smart_split_dataframe - ~ComponentIterator.solvers_attributes - ~ComponentIterator.sort - ~ComponentIterator.step - ~ComponentIterator.subclasses - ~ComponentIterator.subcls_compile - ~ComponentIterator.system_properties_classdef - ~ComponentIterator.system_references - ~ComponentIterator.table_fields - ~ComponentIterator.trace_attributes - ~ComponentIterator.transients_attributes - ~ComponentIterator.update - ~ComponentIterator.update_dynamics - ~ComponentIterator.update_feedthrough - ~ComponentIterator.update_input - ~ComponentIterator.update_output_constants - ~ComponentIterator.update_output_matrix - ~ComponentIterator.update_state - ~ComponentIterator.update_state_constants - ~ComponentIterator.validate_class - ~ComponentIterator.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ComponentIterator.Ut_ref - ~ComponentIterator.Xt_ref - ~ComponentIterator.Yt_ref - ~ComponentIterator.anything_changed - ~ComponentIterator.as_dict - ~ComponentIterator.attrs_fields - ~ComponentIterator.classname - ~ComponentIterator.current - ~ComponentIterator.dXtdt_ref - ~ComponentIterator.data_dict - ~ComponentIterator.dataframe_constants - ~ComponentIterator.dataframe_variants - ~ComponentIterator.displayname - ~ComponentIterator.dynamic_A - ~ComponentIterator.dynamic_B - ~ComponentIterator.dynamic_C - ~ComponentIterator.dynamic_D - ~ComponentIterator.dynamic_F - ~ComponentIterator.dynamic_K - ~ComponentIterator.dynamic_input - ~ComponentIterator.dynamic_input_vars - ~ComponentIterator.dynamic_output - ~ComponentIterator.dynamic_output_vars - ~ComponentIterator.dynamic_state - ~ComponentIterator.dynamic_state_vars - ~ComponentIterator.filename - ~ComponentIterator.identity - ~ComponentIterator.input_as_dict - ~ComponentIterator.last_context - ~ComponentIterator.log_fmt - ~ComponentIterator.log_level - ~ComponentIterator.log_on - ~ComponentIterator.log_silo - ~ComponentIterator.logger - ~ComponentIterator.nonlinear - ~ComponentIterator.numeric_as_dict - ~ComponentIterator.numeric_hash - ~ComponentIterator.plotable_variables - ~ComponentIterator.skip_plot_vars - ~ComponentIterator.slack_webhook_url - ~ComponentIterator.static_A - ~ComponentIterator.static_B - ~ComponentIterator.static_C - ~ComponentIterator.static_D - ~ComponentIterator.static_F - ~ComponentIterator.static_K - ~ComponentIterator.system_id - ~ComponentIterator.time - ~ComponentIterator.unique_hash - ~ComponentIterator.update_interval - ~ComponentIterator.wide - ~ComponentIterator.component_type - ~ComponentIterator.data - ~ComponentIterator.current_item - ~ComponentIterator.parent - ~ComponentIterator.name - ~ComponentIterator.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.component_collections.check_comp_type.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.component_collections.check_comp_type.rst.txt deleted file mode 100644 index 804ccc6..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.component_collections.check_comp_type.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.component\_collections.check\_comp\_type -================================================= - -.. currentmodule:: engforge.component_collections - -.. autofunction:: check_comp_type \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.component_collections.iter_tkn.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.component_collections.iter_tkn.rst.txt deleted file mode 100644 index b54632e..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.component_collections.iter_tkn.rst.txt +++ /dev/null @@ -1,24 +0,0 @@ -engforge.component\_collections.iter\_tkn -========================================= - -.. currentmodule:: engforge.component_collections - -.. autoclass:: iter_tkn - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - - - - - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.component_collections.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.component_collections.rst.txt deleted file mode 100644 index 10a8b1c..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.component_collections.rst.txt +++ /dev/null @@ -1,43 +0,0 @@ -engforge.component\_collections -=============================== - -.. automodule:: engforge.component_collections - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - check_comp_type - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - ComponentDict - ComponentIter - ComponentIterator - iter_tkn - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.components.Component.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.components.Component.rst.txt deleted file mode 100644 index 2a9f61b..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.components.Component.rst.txt +++ /dev/null @@ -1,173 +0,0 @@ -engforge.components.Component -============================= - -.. currentmodule:: engforge.components - -.. autoclass:: Component - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Component.add_fields - ~Component.change_all_log_lvl - ~Component.check_ref_slot_type - ~Component.cls_all_attrs_fields - ~Component.cls_all_property_keys - ~Component.cls_all_property_labels - ~Component.cls_compile - ~Component.collect_all_attributes - ~Component.collect_comp_refs - ~Component.collect_dynamic_refs - ~Component.collect_inst_attributes - ~Component.collect_post_update_refs - ~Component.collect_solver_refs - ~Component.collect_update_refs - ~Component.comp_references - ~Component.compile_classes - ~Component.copy_config_at_state - ~Component.create_dynamic_matricies - ~Component.create_feedthrough_matrix - ~Component.create_input_matrix - ~Component.create_output_constants - ~Component.create_output_matrix - ~Component.create_state_constants - ~Component.create_state_matrix - ~Component.critical - ~Component.debug - ~Component.determine_nearest_stationary_state - ~Component.difference - ~Component.error - ~Component.extract_message - ~Component.filter - ~Component.format_columns - ~Component.get_system_input_refs - ~Component.go_through_configurations - ~Component.info - ~Component.input_attrs - ~Component.input_fields - ~Component.installSTDLogger - ~Component.internal_components - ~Component.internal_configurations - ~Component.internal_references - ~Component.internal_systems - ~Component.internal_tabulations - ~Component.linear_output - ~Component.linear_step - ~Component.locate - ~Component.locate_ref - ~Component.message_with_identiy - ~Component.msg - ~Component.nonlinear_output - ~Component.nonlinear_step - ~Component.numeric_fields - ~Component.parent_configurations_cls - ~Component.parse_run_kwargs - ~Component.parse_simulation_input - ~Component.plot_attributes - ~Component.post_update - ~Component.pre_compile - ~Component.print_info - ~Component.rate - ~Component.rate_linear - ~Component.rate_nonlinear - ~Component.ref_dXdt - ~Component.resetLog - ~Component.resetSystemLogs - ~Component.set_attr - ~Component.set_time - ~Component.setattrs - ~Component.signals_attributes - ~Component.slack_notification - ~Component.slot_refs - ~Component.slots_attributes - ~Component.smart_split_dataframe - ~Component.solvers_attributes - ~Component.step - ~Component.subclasses - ~Component.subcls_compile - ~Component.system_properties_classdef - ~Component.system_references - ~Component.table_fields - ~Component.trace_attributes - ~Component.transients_attributes - ~Component.update - ~Component.update_dynamics - ~Component.update_feedthrough - ~Component.update_input - ~Component.update_output_constants - ~Component.update_output_matrix - ~Component.update_state - ~Component.update_state_constants - ~Component.validate_class - ~Component.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Component.Ut_ref - ~Component.Xt_ref - ~Component.Yt_ref - ~Component.anything_changed - ~Component.as_dict - ~Component.attrs_fields - ~Component.classname - ~Component.dXtdt_ref - ~Component.data_dict - ~Component.dataframe_constants - ~Component.dataframe_variants - ~Component.displayname - ~Component.dynamic_A - ~Component.dynamic_B - ~Component.dynamic_C - ~Component.dynamic_D - ~Component.dynamic_F - ~Component.dynamic_K - ~Component.dynamic_input - ~Component.dynamic_input_vars - ~Component.dynamic_output - ~Component.dynamic_output_vars - ~Component.dynamic_state - ~Component.dynamic_state_vars - ~Component.filename - ~Component.identity - ~Component.input_as_dict - ~Component.last_context - ~Component.log_fmt - ~Component.log_level - ~Component.log_on - ~Component.log_silo - ~Component.logger - ~Component.nonlinear - ~Component.numeric_as_dict - ~Component.numeric_hash - ~Component.plotable_variables - ~Component.skip_plot_vars - ~Component.slack_webhook_url - ~Component.static_A - ~Component.static_B - ~Component.static_C - ~Component.static_D - ~Component.static_F - ~Component.static_K - ~Component.system_id - ~Component.time - ~Component.unique_hash - ~Component.update_interval - ~Component.parent - ~Component.name - ~Component.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.components.SolveableInterface.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.components.SolveableInterface.rst.txt deleted file mode 100644 index 5090092..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.components.SolveableInterface.rst.txt +++ /dev/null @@ -1,123 +0,0 @@ -engforge.components.SolveableInterface -====================================== - -.. currentmodule:: engforge.components - -.. autoclass:: SolveableInterface - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~SolveableInterface.add_fields - ~SolveableInterface.change_all_log_lvl - ~SolveableInterface.check_ref_slot_type - ~SolveableInterface.cls_all_attrs_fields - ~SolveableInterface.cls_all_property_keys - ~SolveableInterface.cls_all_property_labels - ~SolveableInterface.cls_compile - ~SolveableInterface.collect_all_attributes - ~SolveableInterface.collect_comp_refs - ~SolveableInterface.collect_dynamic_refs - ~SolveableInterface.collect_inst_attributes - ~SolveableInterface.collect_post_update_refs - ~SolveableInterface.collect_solver_refs - ~SolveableInterface.collect_update_refs - ~SolveableInterface.comp_references - ~SolveableInterface.compile_classes - ~SolveableInterface.copy_config_at_state - ~SolveableInterface.critical - ~SolveableInterface.debug - ~SolveableInterface.difference - ~SolveableInterface.error - ~SolveableInterface.extract_message - ~SolveableInterface.filter - ~SolveableInterface.format_columns - ~SolveableInterface.get_system_input_refs - ~SolveableInterface.go_through_configurations - ~SolveableInterface.info - ~SolveableInterface.input_attrs - ~SolveableInterface.input_fields - ~SolveableInterface.installSTDLogger - ~SolveableInterface.internal_components - ~SolveableInterface.internal_configurations - ~SolveableInterface.internal_references - ~SolveableInterface.internal_systems - ~SolveableInterface.internal_tabulations - ~SolveableInterface.locate - ~SolveableInterface.locate_ref - ~SolveableInterface.message_with_identiy - ~SolveableInterface.msg - ~SolveableInterface.numeric_fields - ~SolveableInterface.parent_configurations_cls - ~SolveableInterface.parse_run_kwargs - ~SolveableInterface.parse_simulation_input - ~SolveableInterface.plot_attributes - ~SolveableInterface.post_update - ~SolveableInterface.pre_compile - ~SolveableInterface.print_info - ~SolveableInterface.resetLog - ~SolveableInterface.resetSystemLogs - ~SolveableInterface.set_attr - ~SolveableInterface.setattrs - ~SolveableInterface.signals_attributes - ~SolveableInterface.slack_notification - ~SolveableInterface.slot_refs - ~SolveableInterface.slots_attributes - ~SolveableInterface.smart_split_dataframe - ~SolveableInterface.solvers_attributes - ~SolveableInterface.subclasses - ~SolveableInterface.subcls_compile - ~SolveableInterface.system_properties_classdef - ~SolveableInterface.system_references - ~SolveableInterface.table_fields - ~SolveableInterface.trace_attributes - ~SolveableInterface.transients_attributes - ~SolveableInterface.update - ~SolveableInterface.validate_class - ~SolveableInterface.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~SolveableInterface.anything_changed - ~SolveableInterface.as_dict - ~SolveableInterface.attrs_fields - ~SolveableInterface.classname - ~SolveableInterface.data_dict - ~SolveableInterface.dataframe_constants - ~SolveableInterface.dataframe_variants - ~SolveableInterface.displayname - ~SolveableInterface.filename - ~SolveableInterface.identity - ~SolveableInterface.input_as_dict - ~SolveableInterface.last_context - ~SolveableInterface.log_fmt - ~SolveableInterface.log_level - ~SolveableInterface.log_on - ~SolveableInterface.log_silo - ~SolveableInterface.logger - ~SolveableInterface.numeric_as_dict - ~SolveableInterface.numeric_hash - ~SolveableInterface.plotable_variables - ~SolveableInterface.skip_plot_vars - ~SolveableInterface.slack_webhook_url - ~SolveableInterface.system_id - ~SolveableInterface.unique_hash - ~SolveableInterface.parent - ~SolveableInterface.name - ~SolveableInterface.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.components.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.components.rst.txt deleted file mode 100644 index 5bbfe66..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.components.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -engforge.components -=================== - -.. automodule:: engforge.components - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - Component - SolveableInterface - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.configuration.ConfigLog.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.configuration.ConfigLog.rst.txt deleted file mode 100644 index 36ebe4e..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.configuration.ConfigLog.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.configuration.ConfigLog -================================ - -.. currentmodule:: engforge.configuration - -.. autoclass:: ConfigLog - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~ConfigLog.add_fields - ~ConfigLog.change_all_log_lvl - ~ConfigLog.critical - ~ConfigLog.debug - ~ConfigLog.error - ~ConfigLog.extract_message - ~ConfigLog.filter - ~ConfigLog.info - ~ConfigLog.installSTDLogger - ~ConfigLog.message_with_identiy - ~ConfigLog.msg - ~ConfigLog.resetLog - ~ConfigLog.resetSystemLogs - ~ConfigLog.slack_notification - ~ConfigLog.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ConfigLog.identity - ~ConfigLog.log_fmt - ~ConfigLog.log_level - ~ConfigLog.log_on - ~ConfigLog.logger - ~ConfigLog.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.configuration.Configuration.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.configuration.Configuration.rst.txt deleted file mode 100644 index c871179..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.configuration.Configuration.rst.txt +++ /dev/null @@ -1,87 +0,0 @@ -engforge.configuration.Configuration -==================================== - -.. currentmodule:: engforge.configuration - -.. autoclass:: Configuration - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Configuration.add_fields - ~Configuration.change_all_log_lvl - ~Configuration.check_ref_slot_type - ~Configuration.cls_compile - ~Configuration.collect_all_attributes - ~Configuration.collect_inst_attributes - ~Configuration.compile_classes - ~Configuration.copy_config_at_state - ~Configuration.critical - ~Configuration.debug - ~Configuration.difference - ~Configuration.error - ~Configuration.extract_message - ~Configuration.filter - ~Configuration.go_through_configurations - ~Configuration.info - ~Configuration.input_attrs - ~Configuration.input_fields - ~Configuration.installSTDLogger - ~Configuration.internal_configurations - ~Configuration.message_with_identiy - ~Configuration.msg - ~Configuration.numeric_fields - ~Configuration.parent_configurations_cls - ~Configuration.plot_attributes - ~Configuration.pre_compile - ~Configuration.resetLog - ~Configuration.resetSystemLogs - ~Configuration.setattrs - ~Configuration.signals_attributes - ~Configuration.slack_notification - ~Configuration.slot_refs - ~Configuration.slots_attributes - ~Configuration.solvers_attributes - ~Configuration.subclasses - ~Configuration.subcls_compile - ~Configuration.table_fields - ~Configuration.trace_attributes - ~Configuration.transients_attributes - ~Configuration.validate_class - ~Configuration.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Configuration.as_dict - ~Configuration.attrs_fields - ~Configuration.classname - ~Configuration.displayname - ~Configuration.filename - ~Configuration.identity - ~Configuration.input_as_dict - ~Configuration.log_fmt - ~Configuration.log_level - ~Configuration.log_on - ~Configuration.log_silo - ~Configuration.logger - ~Configuration.numeric_as_dict - ~Configuration.numeric_hash - ~Configuration.slack_webhook_url - ~Configuration.unique_hash - ~Configuration.name - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.configuration.comp_transform.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.configuration.comp_transform.rst.txt deleted file mode 100644 index 30890ba..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.configuration.comp_transform.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.configuration.comp\_transform -====================================== - -.. currentmodule:: engforge.configuration - -.. autofunction:: comp_transform \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.configuration.conv_nms.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.configuration.conv_nms.rst.txt deleted file mode 100644 index c22080b..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.configuration.conv_nms.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.configuration.conv\_nms -================================ - -.. currentmodule:: engforge.configuration - -.. autofunction:: conv_nms \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.configuration.forge.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.configuration.forge.rst.txt deleted file mode 100644 index fade198..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.configuration.forge.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.configuration.forge -============================ - -.. currentmodule:: engforge.configuration - -.. autofunction:: forge \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.configuration.meta.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.configuration.meta.rst.txt deleted file mode 100644 index a3cfbea..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.configuration.meta.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.configuration.meta -=========================== - -.. currentmodule:: engforge.configuration - -.. autofunction:: meta \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.configuration.name_generator.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.configuration.name_generator.rst.txt deleted file mode 100644 index 3be6b1c..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.configuration.name_generator.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.configuration.name\_generator -====================================== - -.. currentmodule:: engforge.configuration - -.. autofunction:: name_generator \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.configuration.property_changed.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.configuration.property_changed.rst.txt deleted file mode 100644 index 2f77d40..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.configuration.property_changed.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.configuration.property\_changed -======================================== - -.. currentmodule:: engforge.configuration - -.. autofunction:: property_changed \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.configuration.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.configuration.rst.txt deleted file mode 100644 index de573f2..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.configuration.rst.txt +++ /dev/null @@ -1,47 +0,0 @@ -engforge.configuration -====================== - -.. automodule:: engforge.configuration - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - comp_transform - conv_nms - forge - meta - name_generator - property_changed - signals_slots_handler - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - ConfigLog - Configuration - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.configuration.signals_slots_handler.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.configuration.signals_slots_handler.rst.txt deleted file mode 100644 index 3dca73d..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.configuration.signals_slots_handler.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.configuration.signals\_slots\_handler -============================================== - -.. currentmodule:: engforge.configuration - -.. autofunction:: signals_slots_handler \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.dataframe.DataFrameLog.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.dataframe.DataFrameLog.rst.txt deleted file mode 100644 index 7b1a837..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.dataframe.DataFrameLog.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.dataframe.DataFrameLog -=============================== - -.. currentmodule:: engforge.dataframe - -.. autoclass:: DataFrameLog - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~DataFrameLog.add_fields - ~DataFrameLog.change_all_log_lvl - ~DataFrameLog.critical - ~DataFrameLog.debug - ~DataFrameLog.error - ~DataFrameLog.extract_message - ~DataFrameLog.filter - ~DataFrameLog.info - ~DataFrameLog.installSTDLogger - ~DataFrameLog.message_with_identiy - ~DataFrameLog.msg - ~DataFrameLog.resetLog - ~DataFrameLog.resetSystemLogs - ~DataFrameLog.slack_notification - ~DataFrameLog.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~DataFrameLog.identity - ~DataFrameLog.log_fmt - ~DataFrameLog.log_level - ~DataFrameLog.log_on - ~DataFrameLog.logger - ~DataFrameLog.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.dataframe.DataframeMixin.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.dataframe.DataframeMixin.rst.txt deleted file mode 100644 index 74d4d15..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.dataframe.DataframeMixin.rst.txt +++ /dev/null @@ -1,35 +0,0 @@ -engforge.dataframe.DataframeMixin -================================= - -.. currentmodule:: engforge.dataframe - -.. autoclass:: DataframeMixin - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~DataframeMixin.format_columns - ~DataframeMixin.smart_split_dataframe - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~DataframeMixin.dataframe - ~DataframeMixin.dataframe_constants - ~DataframeMixin.dataframe_variants - ~DataframeMixin.skip_plot_vars - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.dataframe.dataframe_prop.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.dataframe.dataframe_prop.rst.txt deleted file mode 100644 index e7aac4c..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.dataframe.dataframe_prop.rst.txt +++ /dev/null @@ -1,34 +0,0 @@ -engforge.dataframe.dataframe\_prop -================================== - -.. currentmodule:: engforge.dataframe - -.. autoclass:: dataframe_prop - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~dataframe_prop.deleter - ~dataframe_prop.get_func_return - ~dataframe_prop.getter - ~dataframe_prop.setter - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~dataframe_prop.must_return - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.dataframe.dataframe_property.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.dataframe.dataframe_property.rst.txt deleted file mode 100644 index d8ef32b..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.dataframe.dataframe_property.rst.txt +++ /dev/null @@ -1,34 +0,0 @@ -engforge.dataframe.dataframe\_property -====================================== - -.. currentmodule:: engforge.dataframe - -.. autoclass:: dataframe_property - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~dataframe_property.deleter - ~dataframe_property.get_func_return - ~dataframe_property.getter - ~dataframe_property.setter - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~dataframe_property.must_return - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.dataframe.determine_split.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.dataframe.determine_split.rst.txt deleted file mode 100644 index 5363351..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.dataframe.determine_split.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.dataframe.determine\_split -=================================== - -.. currentmodule:: engforge.dataframe - -.. autofunction:: determine_split \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.dataframe.df_prop.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.dataframe.df_prop.rst.txt deleted file mode 100644 index 89cbe82..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.dataframe.df_prop.rst.txt +++ /dev/null @@ -1,34 +0,0 @@ -engforge.dataframe.df\_prop -=========================== - -.. currentmodule:: engforge.dataframe - -.. autoclass:: df_prop - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~df_prop.deleter - ~df_prop.get_func_return - ~df_prop.getter - ~df_prop.setter - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~df_prop.must_return - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.dataframe.is_uniform.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.dataframe.is_uniform.rst.txt deleted file mode 100644 index 53326fd..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.dataframe.is_uniform.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.dataframe.is\_uniform -============================== - -.. currentmodule:: engforge.dataframe - -.. autofunction:: is_uniform \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.dataframe.key_func.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.dataframe.key_func.rst.txt deleted file mode 100644 index e830d7d..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.dataframe.key_func.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.dataframe.key\_func -============================ - -.. currentmodule:: engforge.dataframe - -.. autofunction:: key_func \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.dataframe.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.dataframe.rst.txt deleted file mode 100644 index 584aa25..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.dataframe.rst.txt +++ /dev/null @@ -1,47 +0,0 @@ -engforge.dataframe -================== - -.. automodule:: engforge.dataframe - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - determine_split - is_uniform - key_func - split_dataframe - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - DataFrameLog - DataframeMixin - dataframe_prop - dataframe_property - df_prop - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.dataframe.split_dataframe.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.dataframe.split_dataframe.rst.txt deleted file mode 100644 index 3cbd79b..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.dataframe.split_dataframe.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.dataframe.split\_dataframe -=================================== - -.. currentmodule:: engforge.dataframe - -.. autofunction:: split_dataframe \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.DBConnection.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.datastores.data.DBConnection.rst.txt deleted file mode 100644 index 38d3f9b..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.DBConnection.rst.txt +++ /dev/null @@ -1,69 +0,0 @@ -engforge.datastores.data.DBConnection -===================================== - -.. currentmodule:: engforge.datastores.data - -.. autoclass:: DBConnection - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~DBConnection.add_fields - ~DBConnection.change_all_log_lvl - ~DBConnection.cleanup_sessions - ~DBConnection.configure - ~DBConnection.critical - ~DBConnection.debug - ~DBConnection.ensure_database_exists - ~DBConnection.error - ~DBConnection.extract_message - ~DBConnection.filter - ~DBConnection.info - ~DBConnection.installSTDLogger - ~DBConnection.message_with_identiy - ~DBConnection.msg - ~DBConnection.rebuild_database - ~DBConnection.resetLog - ~DBConnection.resetSystemLogs - ~DBConnection.session_scope - ~DBConnection.slack_notification - ~DBConnection.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~DBConnection.Session - ~DBConnection.connect_args - ~DBConnection.connection_string - ~DBConnection.dbname - ~DBConnection.echo - ~DBConnection.engine - ~DBConnection.host - ~DBConnection.identity - ~DBConnection.log_fmt - ~DBConnection.log_level - ~DBConnection.log_on - ~DBConnection.logger - ~DBConnection.max_overflow - ~DBConnection.passd - ~DBConnection.pool_size - ~DBConnection.port - ~DBConnection.scopefunc - ~DBConnection.session_factory - ~DBConnection.slack_webhook_url - ~DBConnection.user - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.DiskCacheStore.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.datastores.data.DiskCacheStore.rst.txt deleted file mode 100644 index 0579f82..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.DiskCacheStore.rst.txt +++ /dev/null @@ -1,64 +0,0 @@ -engforge.datastores.data.DiskCacheStore -======================================= - -.. currentmodule:: engforge.datastores.data - -.. autoclass:: DiskCacheStore - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~DiskCacheStore.add_fields - ~DiskCacheStore.change_all_log_lvl - ~DiskCacheStore.critical - ~DiskCacheStore.debug - ~DiskCacheStore.error - ~DiskCacheStore.expire - ~DiskCacheStore.extract_message - ~DiskCacheStore.filter - ~DiskCacheStore.get - ~DiskCacheStore.info - ~DiskCacheStore.installSTDLogger - ~DiskCacheStore.message_with_identiy - ~DiskCacheStore.msg - ~DiskCacheStore.resetLog - ~DiskCacheStore.resetSystemLogs - ~DiskCacheStore.set - ~DiskCacheStore.slack_notification - ~DiskCacheStore.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~DiskCacheStore.alt_path - ~DiskCacheStore.cache - ~DiskCacheStore.cache_init_kwargs - ~DiskCacheStore.cache_root - ~DiskCacheStore.current_keys - ~DiskCacheStore.expire_threshold - ~DiskCacheStore.identity - ~DiskCacheStore.last_expire - ~DiskCacheStore.log_fmt - ~DiskCacheStore.log_level - ~DiskCacheStore.log_on - ~DiskCacheStore.logger - ~DiskCacheStore.retries - ~DiskCacheStore.size_limit - ~DiskCacheStore.slack_webhook_url - ~DiskCacheStore.sleep_time - ~DiskCacheStore.timeout - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.addapt_numpy_array.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.datastores.data.addapt_numpy_array.rst.txt deleted file mode 100644 index c693e12..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.addapt_numpy_array.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.datastores.data.addapt\_numpy\_array -============================================= - -.. currentmodule:: engforge.datastores.data - -.. autofunction:: addapt_numpy_array \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.addapt_numpy_float32.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.datastores.data.addapt_numpy_float32.rst.txt deleted file mode 100644 index 8a897ec..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.addapt_numpy_float32.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.datastores.data.addapt\_numpy\_float32 -=============================================== - -.. currentmodule:: engforge.datastores.data - -.. autofunction:: addapt_numpy_float32 \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.addapt_numpy_float64.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.datastores.data.addapt_numpy_float64.rst.txt deleted file mode 100644 index 262310b..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.addapt_numpy_float64.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.datastores.data.addapt\_numpy\_float64 -=============================================== - -.. currentmodule:: engforge.datastores.data - -.. autofunction:: addapt_numpy_float64 \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.addapt_numpy_int32.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.datastores.data.addapt_numpy_int32.rst.txt deleted file mode 100644 index 24756fb..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.addapt_numpy_int32.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.datastores.data.addapt\_numpy\_int32 -============================================= - -.. currentmodule:: engforge.datastores.data - -.. autofunction:: addapt_numpy_int32 \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.addapt_numpy_int64.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.datastores.data.addapt_numpy_int64.rst.txt deleted file mode 100644 index 41e13fd..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.addapt_numpy_int64.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.datastores.data.addapt\_numpy\_int64 -============================================= - -.. currentmodule:: engforge.datastores.data - -.. autofunction:: addapt_numpy_int64 \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.autocorrelation_direct.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.datastores.data.autocorrelation_direct.rst.txt deleted file mode 100644 index 98dc313..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.autocorrelation_direct.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.datastores.data.autocorrelation\_direct -================================================ - -.. currentmodule:: engforge.datastores.data - -.. autofunction:: autocorrelation_direct \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.autocorrelation_fft.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.datastores.data.autocorrelation_fft.rst.txt deleted file mode 100644 index 17a5258..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.autocorrelation_fft.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.datastores.data.autocorrelation\_fft -============================================= - -.. currentmodule:: engforge.datastores.data - -.. autofunction:: autocorrelation_fft \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.autocorrelation_numpy.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.datastores.data.autocorrelation_numpy.rst.txt deleted file mode 100644 index 3f7f95c..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.autocorrelation_numpy.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.datastores.data.autocorrelation\_numpy -=============================================== - -.. currentmodule:: engforge.datastores.data - -.. autofunction:: autocorrelation_numpy \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.nan_to_null.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.datastores.data.nan_to_null.rst.txt deleted file mode 100644 index f7b6907..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.nan_to_null.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.datastores.data.nan\_to\_null -====================================== - -.. currentmodule:: engforge.datastores.data - -.. autofunction:: nan_to_null \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.datastores.data.rst.txt deleted file mode 100644 index 5f49fe5..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.datastores.data.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -engforge.datastores.data -======================== - -.. automodule:: engforge.datastores.data - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - addapt_numpy_array - addapt_numpy_float32 - addapt_numpy_float64 - addapt_numpy_int32 - addapt_numpy_int64 - autocorrelation_direct - autocorrelation_fft - autocorrelation_numpy - nan_to_null - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - DBConnection - DiskCacheStore - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.datastores.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.datastores.rst.txt deleted file mode 100644 index 3b9e80c..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.datastores.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -engforge.datastores -=================== - -.. automodule:: engforge.datastores - - - - - - - - - - - - - - - - - - - -.. autosummary:: - :toctree: - :template: custom-module-template.rst - :recursive: - - data - gdocs - reporting - secrets - diff --git a/docs/_build/html/_sources/_autosummary/engforge.dynamics.DynamicsMixin.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.dynamics.DynamicsMixin.rst.txt deleted file mode 100644 index 7fafead..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.dynamics.DynamicsMixin.rst.txt +++ /dev/null @@ -1,161 +0,0 @@ -engforge.dynamics.DynamicsMixin -=============================== - -.. currentmodule:: engforge.dynamics - -.. autoclass:: DynamicsMixin - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~DynamicsMixin.add_fields - ~DynamicsMixin.change_all_log_lvl - ~DynamicsMixin.check_ref_slot_type - ~DynamicsMixin.cls_compile - ~DynamicsMixin.collect_all_attributes - ~DynamicsMixin.collect_comp_refs - ~DynamicsMixin.collect_dynamic_refs - ~DynamicsMixin.collect_inst_attributes - ~DynamicsMixin.collect_post_update_refs - ~DynamicsMixin.collect_solver_refs - ~DynamicsMixin.collect_update_refs - ~DynamicsMixin.comp_references - ~DynamicsMixin.compile_classes - ~DynamicsMixin.copy_config_at_state - ~DynamicsMixin.create_dynamic_matricies - ~DynamicsMixin.create_feedthrough_matrix - ~DynamicsMixin.create_input_matrix - ~DynamicsMixin.create_output_constants - ~DynamicsMixin.create_output_matrix - ~DynamicsMixin.create_state_constants - ~DynamicsMixin.create_state_matrix - ~DynamicsMixin.critical - ~DynamicsMixin.debug - ~DynamicsMixin.determine_nearest_stationary_state - ~DynamicsMixin.difference - ~DynamicsMixin.error - ~DynamicsMixin.extract_message - ~DynamicsMixin.filter - ~DynamicsMixin.get_system_input_refs - ~DynamicsMixin.go_through_configurations - ~DynamicsMixin.info - ~DynamicsMixin.input_attrs - ~DynamicsMixin.input_fields - ~DynamicsMixin.installSTDLogger - ~DynamicsMixin.internal_components - ~DynamicsMixin.internal_configurations - ~DynamicsMixin.internal_references - ~DynamicsMixin.internal_systems - ~DynamicsMixin.internal_tabulations - ~DynamicsMixin.linear_output - ~DynamicsMixin.linear_step - ~DynamicsMixin.locate - ~DynamicsMixin.locate_ref - ~DynamicsMixin.message_with_identiy - ~DynamicsMixin.msg - ~DynamicsMixin.nonlinear_output - ~DynamicsMixin.nonlinear_step - ~DynamicsMixin.numeric_fields - ~DynamicsMixin.parent_configurations_cls - ~DynamicsMixin.parse_run_kwargs - ~DynamicsMixin.parse_simulation_input - ~DynamicsMixin.plot_attributes - ~DynamicsMixin.post_update - ~DynamicsMixin.pre_compile - ~DynamicsMixin.rate - ~DynamicsMixin.rate_linear - ~DynamicsMixin.rate_nonlinear - ~DynamicsMixin.ref_dXdt - ~DynamicsMixin.resetLog - ~DynamicsMixin.resetSystemLogs - ~DynamicsMixin.set_time - ~DynamicsMixin.setattrs - ~DynamicsMixin.signals_attributes - ~DynamicsMixin.slack_notification - ~DynamicsMixin.slot_refs - ~DynamicsMixin.slots_attributes - ~DynamicsMixin.solvers_attributes - ~DynamicsMixin.step - ~DynamicsMixin.subclasses - ~DynamicsMixin.subcls_compile - ~DynamicsMixin.system_references - ~DynamicsMixin.table_fields - ~DynamicsMixin.trace_attributes - ~DynamicsMixin.transients_attributes - ~DynamicsMixin.update - ~DynamicsMixin.update_dynamics - ~DynamicsMixin.update_feedthrough - ~DynamicsMixin.update_input - ~DynamicsMixin.update_output_constants - ~DynamicsMixin.update_output_matrix - ~DynamicsMixin.update_state - ~DynamicsMixin.update_state_constants - ~DynamicsMixin.validate_class - ~DynamicsMixin.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~DynamicsMixin.Ut_ref - ~DynamicsMixin.Xt_ref - ~DynamicsMixin.Yt_ref - ~DynamicsMixin.as_dict - ~DynamicsMixin.attrs_fields - ~DynamicsMixin.cache_dXdt - ~DynamicsMixin.classname - ~DynamicsMixin.dXtdt_ref - ~DynamicsMixin.displayname - ~DynamicsMixin.dynamic_A - ~DynamicsMixin.dynamic_B - ~DynamicsMixin.dynamic_C - ~DynamicsMixin.dynamic_D - ~DynamicsMixin.dynamic_F - ~DynamicsMixin.dynamic_K - ~DynamicsMixin.dynamic_input - ~DynamicsMixin.dynamic_input_size - ~DynamicsMixin.dynamic_input_vars - ~DynamicsMixin.dynamic_output - ~DynamicsMixin.dynamic_output_size - ~DynamicsMixin.dynamic_output_vars - ~DynamicsMixin.dynamic_state - ~DynamicsMixin.dynamic_state_size - ~DynamicsMixin.dynamic_state_vars - ~DynamicsMixin.filename - ~DynamicsMixin.identity - ~DynamicsMixin.input_as_dict - ~DynamicsMixin.is_dynamic - ~DynamicsMixin.log_fmt - ~DynamicsMixin.log_level - ~DynamicsMixin.log_on - ~DynamicsMixin.log_silo - ~DynamicsMixin.logger - ~DynamicsMixin.nonlinear - ~DynamicsMixin.numeric_as_dict - ~DynamicsMixin.numeric_hash - ~DynamicsMixin.slack_webhook_url - ~DynamicsMixin.static_A - ~DynamicsMixin.static_B - ~DynamicsMixin.static_C - ~DynamicsMixin.static_D - ~DynamicsMixin.static_F - ~DynamicsMixin.static_K - ~DynamicsMixin.time - ~DynamicsMixin.unique_hash - ~DynamicsMixin.update_interval - ~DynamicsMixin.name - ~DynamicsMixin.parent - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.dynamics.GlobalDynamics.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.dynamics.GlobalDynamics.rst.txt deleted file mode 100644 index d6df7f5..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.dynamics.GlobalDynamics.rst.txt +++ /dev/null @@ -1,159 +0,0 @@ -engforge.dynamics.GlobalDynamics -================================ - -.. currentmodule:: engforge.dynamics - -.. autoclass:: GlobalDynamics - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~GlobalDynamics.add_fields - ~GlobalDynamics.change_all_log_lvl - ~GlobalDynamics.check_ref_slot_type - ~GlobalDynamics.cls_compile - ~GlobalDynamics.collect_all_attributes - ~GlobalDynamics.collect_comp_refs - ~GlobalDynamics.collect_dynamic_refs - ~GlobalDynamics.collect_inst_attributes - ~GlobalDynamics.collect_post_update_refs - ~GlobalDynamics.collect_solver_refs - ~GlobalDynamics.collect_update_refs - ~GlobalDynamics.comp_references - ~GlobalDynamics.compile_classes - ~GlobalDynamics.copy_config_at_state - ~GlobalDynamics.create_dynamic_matricies - ~GlobalDynamics.create_feedthrough_matrix - ~GlobalDynamics.create_input_matrix - ~GlobalDynamics.create_output_constants - ~GlobalDynamics.create_output_matrix - ~GlobalDynamics.create_state_constants - ~GlobalDynamics.create_state_matrix - ~GlobalDynamics.critical - ~GlobalDynamics.debug - ~GlobalDynamics.determine_nearest_stationary_state - ~GlobalDynamics.difference - ~GlobalDynamics.error - ~GlobalDynamics.extract_message - ~GlobalDynamics.filter - ~GlobalDynamics.get_system_input_refs - ~GlobalDynamics.go_through_configurations - ~GlobalDynamics.info - ~GlobalDynamics.input_attrs - ~GlobalDynamics.input_fields - ~GlobalDynamics.installSTDLogger - ~GlobalDynamics.internal_components - ~GlobalDynamics.internal_configurations - ~GlobalDynamics.internal_references - ~GlobalDynamics.internal_systems - ~GlobalDynamics.internal_tabulations - ~GlobalDynamics.linear_output - ~GlobalDynamics.linear_step - ~GlobalDynamics.locate - ~GlobalDynamics.locate_ref - ~GlobalDynamics.message_with_identiy - ~GlobalDynamics.msg - ~GlobalDynamics.nonlinear_output - ~GlobalDynamics.nonlinear_step - ~GlobalDynamics.numeric_fields - ~GlobalDynamics.parent_configurations_cls - ~GlobalDynamics.parse_run_kwargs - ~GlobalDynamics.parse_simulation_input - ~GlobalDynamics.plot_attributes - ~GlobalDynamics.post_update - ~GlobalDynamics.pre_compile - ~GlobalDynamics.rate - ~GlobalDynamics.rate_linear - ~GlobalDynamics.rate_nonlinear - ~GlobalDynamics.ref_dXdt - ~GlobalDynamics.resetLog - ~GlobalDynamics.resetSystemLogs - ~GlobalDynamics.set_time - ~GlobalDynamics.setattrs - ~GlobalDynamics.setup_global_dynamics - ~GlobalDynamics.signals_attributes - ~GlobalDynamics.sim_matrix - ~GlobalDynamics.simulate - ~GlobalDynamics.slack_notification - ~GlobalDynamics.slot_refs - ~GlobalDynamics.slots_attributes - ~GlobalDynamics.solvers_attributes - ~GlobalDynamics.step - ~GlobalDynamics.subclasses - ~GlobalDynamics.subcls_compile - ~GlobalDynamics.system_references - ~GlobalDynamics.table_fields - ~GlobalDynamics.trace_attributes - ~GlobalDynamics.transients_attributes - ~GlobalDynamics.update - ~GlobalDynamics.update_dynamics - ~GlobalDynamics.update_feedthrough - ~GlobalDynamics.update_input - ~GlobalDynamics.update_output_constants - ~GlobalDynamics.update_output_matrix - ~GlobalDynamics.update_state - ~GlobalDynamics.update_state_constants - ~GlobalDynamics.validate_class - ~GlobalDynamics.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~GlobalDynamics.Ut_ref - ~GlobalDynamics.Xt_ref - ~GlobalDynamics.Yt_ref - ~GlobalDynamics.as_dict - ~GlobalDynamics.attrs_fields - ~GlobalDynamics.classname - ~GlobalDynamics.dXtdt_ref - ~GlobalDynamics.displayname - ~GlobalDynamics.dynamic_A - ~GlobalDynamics.dynamic_B - ~GlobalDynamics.dynamic_C - ~GlobalDynamics.dynamic_D - ~GlobalDynamics.dynamic_F - ~GlobalDynamics.dynamic_K - ~GlobalDynamics.dynamic_input - ~GlobalDynamics.dynamic_input_vars - ~GlobalDynamics.dynamic_output - ~GlobalDynamics.dynamic_output_vars - ~GlobalDynamics.dynamic_state - ~GlobalDynamics.dynamic_state_vars - ~GlobalDynamics.filename - ~GlobalDynamics.identity - ~GlobalDynamics.input_as_dict - ~GlobalDynamics.log_fmt - ~GlobalDynamics.log_level - ~GlobalDynamics.log_on - ~GlobalDynamics.log_silo - ~GlobalDynamics.logger - ~GlobalDynamics.nonlinear - ~GlobalDynamics.numeric_as_dict - ~GlobalDynamics.numeric_hash - ~GlobalDynamics.slack_webhook_url - ~GlobalDynamics.static_A - ~GlobalDynamics.static_B - ~GlobalDynamics.static_C - ~GlobalDynamics.static_D - ~GlobalDynamics.static_F - ~GlobalDynamics.static_K - ~GlobalDynamics.time - ~GlobalDynamics.unique_hash - ~GlobalDynamics.update_interval - ~GlobalDynamics.name - ~GlobalDynamics.parent - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.dynamics.INDEX_MAP.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.dynamics.INDEX_MAP.rst.txt deleted file mode 100644 index 9b9b2b1..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.dynamics.INDEX_MAP.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -engforge.dynamics.INDEX\_MAP -============================ - -.. currentmodule:: engforge.dynamics - -.. autoclass:: INDEX_MAP - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~INDEX_MAP.get - ~INDEX_MAP.indify - ~INDEX_MAP.remap_indexes_to - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~INDEX_MAP.oppo - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.dynamics.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.dynamics.rst.txt deleted file mode 100644 index 8d56ff7..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.dynamics.rst.txt +++ /dev/null @@ -1,42 +0,0 @@ -engforge.dynamics -================= - -.. automodule:: engforge.dynamics - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - valid_mtx - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - DynamicsMixin - GlobalDynamics - INDEX_MAP - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.dynamics.valid_mtx.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.dynamics.valid_mtx.rst.txt deleted file mode 100644 index 821ea9a..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.dynamics.valid_mtx.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.dynamics.valid\_mtx -============================ - -.. currentmodule:: engforge.dynamics - -.. autofunction:: valid_mtx \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.costs.CostLog.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.costs.CostLog.rst.txt deleted file mode 100644 index d7c3ea9..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.costs.CostLog.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.eng.costs.CostLog -========================== - -.. currentmodule:: engforge.eng.costs - -.. autoclass:: CostLog - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~CostLog.add_fields - ~CostLog.change_all_log_lvl - ~CostLog.critical - ~CostLog.debug - ~CostLog.error - ~CostLog.extract_message - ~CostLog.filter - ~CostLog.info - ~CostLog.installSTDLogger - ~CostLog.message_with_identiy - ~CostLog.msg - ~CostLog.resetLog - ~CostLog.resetSystemLogs - ~CostLog.slack_notification - ~CostLog.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~CostLog.identity - ~CostLog.log_fmt - ~CostLog.log_level - ~CostLog.log_on - ~CostLog.logger - ~CostLog.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.costs.CostModel.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.costs.CostModel.rst.txt deleted file mode 100644 index 74cab26..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.costs.CostModel.rst.txt +++ /dev/null @@ -1,144 +0,0 @@ -engforge.eng.costs.CostModel -============================ - -.. currentmodule:: engforge.eng.costs - -.. autoclass:: CostModel - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~CostModel.add_fields - ~CostModel.all_categories - ~CostModel.calculate_item_cost - ~CostModel.change_all_log_lvl - ~CostModel.check_ref_slot_type - ~CostModel.class_cost_properties - ~CostModel.cls_all_attrs_fields - ~CostModel.cls_all_property_keys - ~CostModel.cls_all_property_labels - ~CostModel.cls_compile - ~CostModel.collect_all_attributes - ~CostModel.collect_comp_refs - ~CostModel.collect_dynamic_refs - ~CostModel.collect_inst_attributes - ~CostModel.collect_post_update_refs - ~CostModel.collect_solver_refs - ~CostModel.collect_update_refs - ~CostModel.comp_references - ~CostModel.compile_classes - ~CostModel.copy_config_at_state - ~CostModel.cost_categories_at_term - ~CostModel.costs_at_term - ~CostModel.critical - ~CostModel.custom_cost - ~CostModel.debug - ~CostModel.default_cost - ~CostModel.dict_itemized_costs - ~CostModel.difference - ~CostModel.error - ~CostModel.extract_message - ~CostModel.filter - ~CostModel.format_columns - ~CostModel.get_system_input_refs - ~CostModel.go_through_configurations - ~CostModel.info - ~CostModel.input_attrs - ~CostModel.input_fields - ~CostModel.installSTDLogger - ~CostModel.internal_components - ~CostModel.internal_configurations - ~CostModel.internal_references - ~CostModel.internal_systems - ~CostModel.internal_tabulations - ~CostModel.locate - ~CostModel.locate_ref - ~CostModel.message_with_identiy - ~CostModel.msg - ~CostModel.numeric_fields - ~CostModel.parent_configurations_cls - ~CostModel.parse_run_kwargs - ~CostModel.parse_simulation_input - ~CostModel.plot_attributes - ~CostModel.post_update - ~CostModel.pre_compile - ~CostModel.print_info - ~CostModel.resetLog - ~CostModel.resetSystemLogs - ~CostModel.reset_cls_costs - ~CostModel.set_attr - ~CostModel.set_default_costs - ~CostModel.setattrs - ~CostModel.signals_attributes - ~CostModel.slack_notification - ~CostModel.slot_refs - ~CostModel.slots_attributes - ~CostModel.smart_split_dataframe - ~CostModel.solvers_attributes - ~CostModel.sub_costs - ~CostModel.subclasses - ~CostModel.subcls_compile - ~CostModel.sum_costs - ~CostModel.system_properties_classdef - ~CostModel.system_references - ~CostModel.table_fields - ~CostModel.trace_attributes - ~CostModel.transients_attributes - ~CostModel.update - ~CostModel.update_dflt_costs - ~CostModel.validate_class - ~CostModel.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~CostModel.anything_changed - ~CostModel.as_dict - ~CostModel.attrs_fields - ~CostModel.classname - ~CostModel.combine_cost - ~CostModel.cost_categories - ~CostModel.cost_properties - ~CostModel.data_dict - ~CostModel.dataframe_constants - ~CostModel.dataframe_variants - ~CostModel.displayname - ~CostModel.filename - ~CostModel.future_costs - ~CostModel.identity - ~CostModel.input_as_dict - ~CostModel.item_cost - ~CostModel.itemized_costs - ~CostModel.last_context - ~CostModel.log_fmt - ~CostModel.log_level - ~CostModel.log_on - ~CostModel.log_silo - ~CostModel.logger - ~CostModel.numeric_as_dict - ~CostModel.numeric_hash - ~CostModel.plotable_variables - ~CostModel.skip_plot_vars - ~CostModel.slack_webhook_url - ~CostModel.sub_items_cost - ~CostModel.system_id - ~CostModel.unique_hash - ~CostModel.cost_per_item - ~CostModel.name - ~CostModel.parent - ~CostModel.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.costs.Economics.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.costs.Economics.rst.txt deleted file mode 100644 index 301e025..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.costs.Economics.rst.txt +++ /dev/null @@ -1,190 +0,0 @@ -engforge.eng.costs.Economics -============================ - -.. currentmodule:: engforge.eng.costs - -.. autoclass:: Economics - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Economics.add_fields - ~Economics.calculate_costs - ~Economics.calculate_production - ~Economics.change_all_log_lvl - ~Economics.check_ref_slot_type - ~Economics.cls_all_attrs_fields - ~Economics.cls_all_property_keys - ~Economics.cls_all_property_labels - ~Economics.cls_compile - ~Economics.collect_all_attributes - ~Economics.collect_comp_refs - ~Economics.collect_dynamic_refs - ~Economics.collect_inst_attributes - ~Economics.collect_post_update_refs - ~Economics.collect_solver_refs - ~Economics.collect_update_refs - ~Economics.comp_references - ~Economics.compile_classes - ~Economics.copy_config_at_state - ~Economics.create_dynamic_matricies - ~Economics.create_feedthrough_matrix - ~Economics.create_input_matrix - ~Economics.create_output_constants - ~Economics.create_output_matrix - ~Economics.create_state_constants - ~Economics.create_state_matrix - ~Economics.critical - ~Economics.debug - ~Economics.determine_nearest_stationary_state - ~Economics.difference - ~Economics.error - ~Economics.extract_message - ~Economics.filter - ~Economics.format_columns - ~Economics.get_prop - ~Economics.get_system_input_refs - ~Economics.go_through_configurations - ~Economics.info - ~Economics.input_attrs - ~Economics.input_fields - ~Economics.installSTDLogger - ~Economics.internal_components - ~Economics.internal_configurations - ~Economics.internal_references - ~Economics.internal_systems - ~Economics.internal_tabulations - ~Economics.linear_output - ~Economics.linear_step - ~Economics.locate - ~Economics.locate_ref - ~Economics.message_with_identiy - ~Economics.msg - ~Economics.nonlinear_output - ~Economics.nonlinear_step - ~Economics.numeric_fields - ~Economics.parent_configurations_cls - ~Economics.parse_run_kwargs - ~Economics.parse_simulation_input - ~Economics.plot_attributes - ~Economics.post_update - ~Economics.pre_compile - ~Economics.print_info - ~Economics.rate - ~Economics.rate_linear - ~Economics.rate_nonlinear - ~Economics.ref_dXdt - ~Economics.resetLog - ~Economics.resetSystemLogs - ~Economics.set_attr - ~Economics.set_time - ~Economics.setattrs - ~Economics.signals_attributes - ~Economics.slack_notification - ~Economics.slot_refs - ~Economics.slots_attributes - ~Economics.smart_split_dataframe - ~Economics.solvers_attributes - ~Economics.step - ~Economics.subclasses - ~Economics.subcls_compile - ~Economics.sum_cost_references - ~Economics.sum_references - ~Economics.sum_term_fgen - ~Economics.system_properties_classdef - ~Economics.system_references - ~Economics.table_fields - ~Economics.term_fgen - ~Economics.trace_attributes - ~Economics.transients_attributes - ~Economics.update - ~Economics.update_dynamics - ~Economics.update_feedthrough - ~Economics.update_input - ~Economics.update_output_constants - ~Economics.update_output_matrix - ~Economics.update_state - ~Economics.update_state_constants - ~Economics.validate_class - ~Economics.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Economics.Ut_ref - ~Economics.Xt_ref - ~Economics.Yt_ref - ~Economics.anything_changed - ~Economics.as_dict - ~Economics.attrs_fields - ~Economics.classname - ~Economics.combine_cost - ~Economics.cost_references - ~Economics.dXtdt_ref - ~Economics.data_dict - ~Economics.dataframe_constants - ~Economics.dataframe_variants - ~Economics.displayname - ~Economics.dynamic_A - ~Economics.dynamic_B - ~Economics.dynamic_C - ~Economics.dynamic_D - ~Economics.dynamic_F - ~Economics.dynamic_K - ~Economics.dynamic_input - ~Economics.dynamic_input_vars - ~Economics.dynamic_output - ~Economics.dynamic_output_vars - ~Economics.dynamic_state - ~Economics.dynamic_state_vars - ~Economics.filename - ~Economics.identity - ~Economics.input_as_dict - ~Economics.last_context - ~Economics.lifecycle_dataframe - ~Economics.lifecycle_output - ~Economics.log_fmt - ~Economics.log_level - ~Economics.log_on - ~Economics.log_silo - ~Economics.logger - ~Economics.nonlinear - ~Economics.numeric_as_dict - ~Economics.numeric_hash - ~Economics.output - ~Economics.plotable_variables - ~Economics.skip_plot_vars - ~Economics.slack_webhook_url - ~Economics.static_A - ~Economics.static_B - ~Economics.static_C - ~Economics.static_D - ~Economics.static_F - ~Economics.static_K - ~Economics.system_id - ~Economics.time - ~Economics.unique_hash - ~Economics.update_interval - ~Economics.term_length - ~Economics.discount_rate - ~Economics.fixed_output - ~Economics.output_type - ~Economics.terms_per_year - ~Economics.parent - ~Economics.name - ~Economics.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.costs.cost_property.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.costs.cost_property.rst.txt deleted file mode 100644 index 0b0601c..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.costs.cost_property.rst.txt +++ /dev/null @@ -1,41 +0,0 @@ -engforge.eng.costs.cost\_property -================================= - -.. currentmodule:: engforge.eng.costs - -.. autoclass:: cost_property - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~cost_property.apply_at_term - ~cost_property.deleter - ~cost_property.get_func_return - ~cost_property.getter - ~cost_property.setter - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~cost_property.cost_categories - ~cost_property.desc - ~cost_property.label - ~cost_property.must_return - ~cost_property.return_type - ~cost_property.stochastic - ~cost_property.term_mode - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.costs.eval_slot_cost.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.costs.eval_slot_cost.rst.txt deleted file mode 100644 index da41421..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.costs.eval_slot_cost.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.eng.costs.eval\_slot\_cost -=================================== - -.. currentmodule:: engforge.eng.costs - -.. autofunction:: eval_slot_cost \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.costs.gend.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.costs.gend.rst.txt deleted file mode 100644 index 1bb3743..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.costs.gend.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.eng.costs.gend -======================= - -.. currentmodule:: engforge.eng.costs - -.. autofunction:: gend \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.costs.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.costs.rst.txt deleted file mode 100644 index 2eb2e2a..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.costs.rst.txt +++ /dev/null @@ -1,44 +0,0 @@ -engforge.eng.costs -================== - -.. automodule:: engforge.eng.costs - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - eval_slot_cost - gend - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - CostLog - CostModel - Economics - cost_property - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.Air.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.Air.rst.txt deleted file mode 100644 index 3252be5..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.Air.rst.txt +++ /dev/null @@ -1,183 +0,0 @@ -engforge.eng.fluid\_material.Air -================================ - -.. currentmodule:: engforge.eng.fluid_material - -.. autoclass:: Air - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Air.add_fields - ~Air.change_all_log_lvl - ~Air.check_ref_slot_type - ~Air.cls_all_attrs_fields - ~Air.cls_all_property_keys - ~Air.cls_all_property_labels - ~Air.cls_compile - ~Air.collect_all_attributes - ~Air.collect_comp_refs - ~Air.collect_dynamic_refs - ~Air.collect_inst_attributes - ~Air.collect_post_update_refs - ~Air.collect_solver_refs - ~Air.collect_update_refs - ~Air.comp_references - ~Air.compile_classes - ~Air.copy_config_at_state - ~Air.create_dynamic_matricies - ~Air.create_feedthrough_matrix - ~Air.create_input_matrix - ~Air.create_output_constants - ~Air.create_output_matrix - ~Air.create_state_constants - ~Air.create_state_matrix - ~Air.critical - ~Air.debug - ~Air.determine_nearest_stationary_state - ~Air.difference - ~Air.error - ~Air.extract_message - ~Air.filter - ~Air.format_columns - ~Air.get_system_input_refs - ~Air.go_through_configurations - ~Air.info - ~Air.input_attrs - ~Air.input_fields - ~Air.installSTDLogger - ~Air.internal_components - ~Air.internal_configurations - ~Air.internal_references - ~Air.internal_systems - ~Air.internal_tabulations - ~Air.linear_output - ~Air.linear_step - ~Air.locate - ~Air.locate_ref - ~Air.message_with_identiy - ~Air.msg - ~Air.nonlinear_output - ~Air.nonlinear_step - ~Air.numeric_fields - ~Air.parent_configurations_cls - ~Air.parse_run_kwargs - ~Air.parse_simulation_input - ~Air.plot_attributes - ~Air.post_update - ~Air.pre_compile - ~Air.print_info - ~Air.rate - ~Air.rate_linear - ~Air.rate_nonlinear - ~Air.ref_dXdt - ~Air.resetLog - ~Air.resetSystemLogs - ~Air.set_attr - ~Air.set_time - ~Air.setattrs - ~Air.signals_attributes - ~Air.slack_notification - ~Air.slot_refs - ~Air.slots_attributes - ~Air.smart_split_dataframe - ~Air.solvers_attributes - ~Air.step - ~Air.subclasses - ~Air.subcls_compile - ~Air.system_properties_classdef - ~Air.system_references - ~Air.table_fields - ~Air.trace_attributes - ~Air.transients_attributes - ~Air.update - ~Air.update_dynamics - ~Air.update_feedthrough - ~Air.update_input - ~Air.update_output_constants - ~Air.update_output_matrix - ~Air.update_state - ~Air.update_state_constants - ~Air.validate_class - ~Air.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Air.Psat - ~Air.Tsat - ~Air.Ut_ref - ~Air.Xt_ref - ~Air.Yt_ref - ~Air.anything_changed - ~Air.as_dict - ~Air.attrs_fields - ~Air.classname - ~Air.dXtdt_ref - ~Air.data_dict - ~Air.dataframe_constants - ~Air.dataframe_variants - ~Air.density - ~Air.displayname - ~Air.dynamic_A - ~Air.dynamic_B - ~Air.dynamic_C - ~Air.dynamic_D - ~Air.dynamic_F - ~Air.dynamic_K - ~Air.dynamic_input - ~Air.dynamic_input_vars - ~Air.dynamic_output - ~Air.dynamic_output_vars - ~Air.dynamic_state - ~Air.dynamic_state_vars - ~Air.enthalpy - ~Air.filename - ~Air.identity - ~Air.input_as_dict - ~Air.last_context - ~Air.log_fmt - ~Air.log_level - ~Air.log_on - ~Air.log_silo - ~Air.logger - ~Air.material - ~Air.nonlinear - ~Air.numeric_as_dict - ~Air.numeric_hash - ~Air.plotable_variables - ~Air.skip_plot_vars - ~Air.slack_webhook_url - ~Air.specific_heat - ~Air.state - ~Air.static_A - ~Air.static_B - ~Air.static_C - ~Air.static_D - ~Air.static_F - ~Air.static_K - ~Air.surface_tension - ~Air.system_id - ~Air.thermal_conductivity - ~Air.time - ~Air.unique_hash - ~Air.update_interval - ~Air.viscosity - ~Air.parent - ~Air.name - ~Air.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.AirWaterMix.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.AirWaterMix.rst.txt deleted file mode 100644 index d5210e6..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.AirWaterMix.rst.txt +++ /dev/null @@ -1,189 +0,0 @@ -engforge.eng.fluid\_material.AirWaterMix -======================================== - -.. currentmodule:: engforge.eng.fluid_material - -.. autoclass:: AirWaterMix - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~AirWaterMix.add_fields - ~AirWaterMix.change_all_log_lvl - ~AirWaterMix.check_ref_slot_type - ~AirWaterMix.cls_all_attrs_fields - ~AirWaterMix.cls_all_property_keys - ~AirWaterMix.cls_all_property_labels - ~AirWaterMix.cls_compile - ~AirWaterMix.collect_all_attributes - ~AirWaterMix.collect_comp_refs - ~AirWaterMix.collect_dynamic_refs - ~AirWaterMix.collect_inst_attributes - ~AirWaterMix.collect_post_update_refs - ~AirWaterMix.collect_solver_refs - ~AirWaterMix.collect_update_refs - ~AirWaterMix.comp_references - ~AirWaterMix.compile_classes - ~AirWaterMix.copy_config_at_state - ~AirWaterMix.create_dynamic_matricies - ~AirWaterMix.create_feedthrough_matrix - ~AirWaterMix.create_input_matrix - ~AirWaterMix.create_output_constants - ~AirWaterMix.create_output_matrix - ~AirWaterMix.create_state_constants - ~AirWaterMix.create_state_matrix - ~AirWaterMix.critical - ~AirWaterMix.debug - ~AirWaterMix.determine_nearest_stationary_state - ~AirWaterMix.difference - ~AirWaterMix.error - ~AirWaterMix.extract_message - ~AirWaterMix.filter - ~AirWaterMix.format_columns - ~AirWaterMix.get_system_input_refs - ~AirWaterMix.go_through_configurations - ~AirWaterMix.info - ~AirWaterMix.input_attrs - ~AirWaterMix.input_fields - ~AirWaterMix.installSTDLogger - ~AirWaterMix.internal_components - ~AirWaterMix.internal_configurations - ~AirWaterMix.internal_references - ~AirWaterMix.internal_systems - ~AirWaterMix.internal_tabulations - ~AirWaterMix.linear_output - ~AirWaterMix.linear_step - ~AirWaterMix.locate - ~AirWaterMix.locate_ref - ~AirWaterMix.message_with_identiy - ~AirWaterMix.msg - ~AirWaterMix.nonlinear_output - ~AirWaterMix.nonlinear_step - ~AirWaterMix.numeric_fields - ~AirWaterMix.parent_configurations_cls - ~AirWaterMix.parse_run_kwargs - ~AirWaterMix.parse_simulation_input - ~AirWaterMix.plot_attributes - ~AirWaterMix.post_update - ~AirWaterMix.pre_compile - ~AirWaterMix.print_info - ~AirWaterMix.rate - ~AirWaterMix.rate_linear - ~AirWaterMix.rate_nonlinear - ~AirWaterMix.ref_dXdt - ~AirWaterMix.resetLog - ~AirWaterMix.resetSystemLogs - ~AirWaterMix.set_attr - ~AirWaterMix.set_time - ~AirWaterMix.setattrs - ~AirWaterMix.setup - ~AirWaterMix.signals_attributes - ~AirWaterMix.slack_notification - ~AirWaterMix.slot_refs - ~AirWaterMix.slots_attributes - ~AirWaterMix.smart_split_dataframe - ~AirWaterMix.solvers_attributes - ~AirWaterMix.step - ~AirWaterMix.subclasses - ~AirWaterMix.subcls_compile - ~AirWaterMix.system_properties_classdef - ~AirWaterMix.system_references - ~AirWaterMix.table_fields - ~AirWaterMix.trace_attributes - ~AirWaterMix.transients_attributes - ~AirWaterMix.update - ~AirWaterMix.update_dynamics - ~AirWaterMix.update_feedthrough - ~AirWaterMix.update_input - ~AirWaterMix.update_mass_ratios - ~AirWaterMix.update_output_constants - ~AirWaterMix.update_output_matrix - ~AirWaterMix.update_state - ~AirWaterMix.update_state_constants - ~AirWaterMix.validate_class - ~AirWaterMix.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~AirWaterMix.Mmass1 - ~AirWaterMix.Mmass2 - ~AirWaterMix.Psat - ~AirWaterMix.Tsat - ~AirWaterMix.Ut_ref - ~AirWaterMix.Xt_ref - ~AirWaterMix.Yt_ref - ~AirWaterMix.anything_changed - ~AirWaterMix.as_dict - ~AirWaterMix.attrs_fields - ~AirWaterMix.classname - ~AirWaterMix.dXtdt_ref - ~AirWaterMix.data_dict - ~AirWaterMix.dataframe_constants - ~AirWaterMix.dataframe_variants - ~AirWaterMix.density - ~AirWaterMix.displayname - ~AirWaterMix.dynamic_A - ~AirWaterMix.dynamic_B - ~AirWaterMix.dynamic_C - ~AirWaterMix.dynamic_D - ~AirWaterMix.dynamic_F - ~AirWaterMix.dynamic_K - ~AirWaterMix.dynamic_input - ~AirWaterMix.dynamic_input_vars - ~AirWaterMix.dynamic_output - ~AirWaterMix.dynamic_output_vars - ~AirWaterMix.dynamic_state - ~AirWaterMix.dynamic_state_vars - ~AirWaterMix.enthalpy - ~AirWaterMix.filename - ~AirWaterMix.identity - ~AirWaterMix.input_as_dict - ~AirWaterMix.last_context - ~AirWaterMix.log_fmt - ~AirWaterMix.log_level - ~AirWaterMix.log_on - ~AirWaterMix.log_silo - ~AirWaterMix.logger - ~AirWaterMix.materail2 - ~AirWaterMix.material - ~AirWaterMix.material1 - ~AirWaterMix.nonlinear - ~AirWaterMix.numeric_as_dict - ~AirWaterMix.numeric_hash - ~AirWaterMix.plotable_variables - ~AirWaterMix.skip_plot_vars - ~AirWaterMix.slack_webhook_url - ~AirWaterMix.specific_heat - ~AirWaterMix.state - ~AirWaterMix.static_A - ~AirWaterMix.static_B - ~AirWaterMix.static_C - ~AirWaterMix.static_D - ~AirWaterMix.static_F - ~AirWaterMix.static_K - ~AirWaterMix.surface_tension - ~AirWaterMix.system_id - ~AirWaterMix.thermal_conductivity - ~AirWaterMix.time - ~AirWaterMix.unique_hash - ~AirWaterMix.update_interval - ~AirWaterMix.viscosity - ~AirWaterMix.parent - ~AirWaterMix.name - ~AirWaterMix.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.CoolPropMaterial.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.CoolPropMaterial.rst.txt deleted file mode 100644 index 637a56b..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.CoolPropMaterial.rst.txt +++ /dev/null @@ -1,183 +0,0 @@ -engforge.eng.fluid\_material.CoolPropMaterial -============================================= - -.. currentmodule:: engforge.eng.fluid_material - -.. autoclass:: CoolPropMaterial - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~CoolPropMaterial.add_fields - ~CoolPropMaterial.change_all_log_lvl - ~CoolPropMaterial.check_ref_slot_type - ~CoolPropMaterial.cls_all_attrs_fields - ~CoolPropMaterial.cls_all_property_keys - ~CoolPropMaterial.cls_all_property_labels - ~CoolPropMaterial.cls_compile - ~CoolPropMaterial.collect_all_attributes - ~CoolPropMaterial.collect_comp_refs - ~CoolPropMaterial.collect_dynamic_refs - ~CoolPropMaterial.collect_inst_attributes - ~CoolPropMaterial.collect_post_update_refs - ~CoolPropMaterial.collect_solver_refs - ~CoolPropMaterial.collect_update_refs - ~CoolPropMaterial.comp_references - ~CoolPropMaterial.compile_classes - ~CoolPropMaterial.copy_config_at_state - ~CoolPropMaterial.create_dynamic_matricies - ~CoolPropMaterial.create_feedthrough_matrix - ~CoolPropMaterial.create_input_matrix - ~CoolPropMaterial.create_output_constants - ~CoolPropMaterial.create_output_matrix - ~CoolPropMaterial.create_state_constants - ~CoolPropMaterial.create_state_matrix - ~CoolPropMaterial.critical - ~CoolPropMaterial.debug - ~CoolPropMaterial.determine_nearest_stationary_state - ~CoolPropMaterial.difference - ~CoolPropMaterial.error - ~CoolPropMaterial.extract_message - ~CoolPropMaterial.filter - ~CoolPropMaterial.format_columns - ~CoolPropMaterial.get_system_input_refs - ~CoolPropMaterial.go_through_configurations - ~CoolPropMaterial.info - ~CoolPropMaterial.input_attrs - ~CoolPropMaterial.input_fields - ~CoolPropMaterial.installSTDLogger - ~CoolPropMaterial.internal_components - ~CoolPropMaterial.internal_configurations - ~CoolPropMaterial.internal_references - ~CoolPropMaterial.internal_systems - ~CoolPropMaterial.internal_tabulations - ~CoolPropMaterial.linear_output - ~CoolPropMaterial.linear_step - ~CoolPropMaterial.locate - ~CoolPropMaterial.locate_ref - ~CoolPropMaterial.message_with_identiy - ~CoolPropMaterial.msg - ~CoolPropMaterial.nonlinear_output - ~CoolPropMaterial.nonlinear_step - ~CoolPropMaterial.numeric_fields - ~CoolPropMaterial.parent_configurations_cls - ~CoolPropMaterial.parse_run_kwargs - ~CoolPropMaterial.parse_simulation_input - ~CoolPropMaterial.plot_attributes - ~CoolPropMaterial.post_update - ~CoolPropMaterial.pre_compile - ~CoolPropMaterial.print_info - ~CoolPropMaterial.rate - ~CoolPropMaterial.rate_linear - ~CoolPropMaterial.rate_nonlinear - ~CoolPropMaterial.ref_dXdt - ~CoolPropMaterial.resetLog - ~CoolPropMaterial.resetSystemLogs - ~CoolPropMaterial.set_attr - ~CoolPropMaterial.set_time - ~CoolPropMaterial.setattrs - ~CoolPropMaterial.signals_attributes - ~CoolPropMaterial.slack_notification - ~CoolPropMaterial.slot_refs - ~CoolPropMaterial.slots_attributes - ~CoolPropMaterial.smart_split_dataframe - ~CoolPropMaterial.solvers_attributes - ~CoolPropMaterial.step - ~CoolPropMaterial.subclasses - ~CoolPropMaterial.subcls_compile - ~CoolPropMaterial.system_properties_classdef - ~CoolPropMaterial.system_references - ~CoolPropMaterial.table_fields - ~CoolPropMaterial.trace_attributes - ~CoolPropMaterial.transients_attributes - ~CoolPropMaterial.update - ~CoolPropMaterial.update_dynamics - ~CoolPropMaterial.update_feedthrough - ~CoolPropMaterial.update_input - ~CoolPropMaterial.update_output_constants - ~CoolPropMaterial.update_output_matrix - ~CoolPropMaterial.update_state - ~CoolPropMaterial.update_state_constants - ~CoolPropMaterial.validate_class - ~CoolPropMaterial.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~CoolPropMaterial.Psat - ~CoolPropMaterial.Tsat - ~CoolPropMaterial.Ut_ref - ~CoolPropMaterial.Xt_ref - ~CoolPropMaterial.Yt_ref - ~CoolPropMaterial.anything_changed - ~CoolPropMaterial.as_dict - ~CoolPropMaterial.attrs_fields - ~CoolPropMaterial.classname - ~CoolPropMaterial.dXtdt_ref - ~CoolPropMaterial.data_dict - ~CoolPropMaterial.dataframe_constants - ~CoolPropMaterial.dataframe_variants - ~CoolPropMaterial.density - ~CoolPropMaterial.displayname - ~CoolPropMaterial.dynamic_A - ~CoolPropMaterial.dynamic_B - ~CoolPropMaterial.dynamic_C - ~CoolPropMaterial.dynamic_D - ~CoolPropMaterial.dynamic_F - ~CoolPropMaterial.dynamic_K - ~CoolPropMaterial.dynamic_input - ~CoolPropMaterial.dynamic_input_vars - ~CoolPropMaterial.dynamic_output - ~CoolPropMaterial.dynamic_output_vars - ~CoolPropMaterial.dynamic_state - ~CoolPropMaterial.dynamic_state_vars - ~CoolPropMaterial.enthalpy - ~CoolPropMaterial.filename - ~CoolPropMaterial.identity - ~CoolPropMaterial.input_as_dict - ~CoolPropMaterial.last_context - ~CoolPropMaterial.log_fmt - ~CoolPropMaterial.log_level - ~CoolPropMaterial.log_on - ~CoolPropMaterial.log_silo - ~CoolPropMaterial.logger - ~CoolPropMaterial.nonlinear - ~CoolPropMaterial.numeric_as_dict - ~CoolPropMaterial.numeric_hash - ~CoolPropMaterial.plotable_variables - ~CoolPropMaterial.skip_plot_vars - ~CoolPropMaterial.slack_webhook_url - ~CoolPropMaterial.specific_heat - ~CoolPropMaterial.state - ~CoolPropMaterial.static_A - ~CoolPropMaterial.static_B - ~CoolPropMaterial.static_C - ~CoolPropMaterial.static_D - ~CoolPropMaterial.static_F - ~CoolPropMaterial.static_K - ~CoolPropMaterial.surface_tension - ~CoolPropMaterial.system_id - ~CoolPropMaterial.thermal_conductivity - ~CoolPropMaterial.time - ~CoolPropMaterial.unique_hash - ~CoolPropMaterial.update_interval - ~CoolPropMaterial.viscosity - ~CoolPropMaterial.material - ~CoolPropMaterial.parent - ~CoolPropMaterial.name - ~CoolPropMaterial.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.CoolPropMixture.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.CoolPropMixture.rst.txt deleted file mode 100644 index a8cfd8e..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.CoolPropMixture.rst.txt +++ /dev/null @@ -1,189 +0,0 @@ -engforge.eng.fluid\_material.CoolPropMixture -============================================ - -.. currentmodule:: engforge.eng.fluid_material - -.. autoclass:: CoolPropMixture - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~CoolPropMixture.add_fields - ~CoolPropMixture.change_all_log_lvl - ~CoolPropMixture.check_ref_slot_type - ~CoolPropMixture.cls_all_attrs_fields - ~CoolPropMixture.cls_all_property_keys - ~CoolPropMixture.cls_all_property_labels - ~CoolPropMixture.cls_compile - ~CoolPropMixture.collect_all_attributes - ~CoolPropMixture.collect_comp_refs - ~CoolPropMixture.collect_dynamic_refs - ~CoolPropMixture.collect_inst_attributes - ~CoolPropMixture.collect_post_update_refs - ~CoolPropMixture.collect_solver_refs - ~CoolPropMixture.collect_update_refs - ~CoolPropMixture.comp_references - ~CoolPropMixture.compile_classes - ~CoolPropMixture.copy_config_at_state - ~CoolPropMixture.create_dynamic_matricies - ~CoolPropMixture.create_feedthrough_matrix - ~CoolPropMixture.create_input_matrix - ~CoolPropMixture.create_output_constants - ~CoolPropMixture.create_output_matrix - ~CoolPropMixture.create_state_constants - ~CoolPropMixture.create_state_matrix - ~CoolPropMixture.critical - ~CoolPropMixture.debug - ~CoolPropMixture.determine_nearest_stationary_state - ~CoolPropMixture.difference - ~CoolPropMixture.error - ~CoolPropMixture.extract_message - ~CoolPropMixture.filter - ~CoolPropMixture.format_columns - ~CoolPropMixture.get_system_input_refs - ~CoolPropMixture.go_through_configurations - ~CoolPropMixture.info - ~CoolPropMixture.input_attrs - ~CoolPropMixture.input_fields - ~CoolPropMixture.installSTDLogger - ~CoolPropMixture.internal_components - ~CoolPropMixture.internal_configurations - ~CoolPropMixture.internal_references - ~CoolPropMixture.internal_systems - ~CoolPropMixture.internal_tabulations - ~CoolPropMixture.linear_output - ~CoolPropMixture.linear_step - ~CoolPropMixture.locate - ~CoolPropMixture.locate_ref - ~CoolPropMixture.message_with_identiy - ~CoolPropMixture.msg - ~CoolPropMixture.nonlinear_output - ~CoolPropMixture.nonlinear_step - ~CoolPropMixture.numeric_fields - ~CoolPropMixture.parent_configurations_cls - ~CoolPropMixture.parse_run_kwargs - ~CoolPropMixture.parse_simulation_input - ~CoolPropMixture.plot_attributes - ~CoolPropMixture.post_update - ~CoolPropMixture.pre_compile - ~CoolPropMixture.print_info - ~CoolPropMixture.rate - ~CoolPropMixture.rate_linear - ~CoolPropMixture.rate_nonlinear - ~CoolPropMixture.ref_dXdt - ~CoolPropMixture.resetLog - ~CoolPropMixture.resetSystemLogs - ~CoolPropMixture.set_attr - ~CoolPropMixture.set_time - ~CoolPropMixture.setattrs - ~CoolPropMixture.setup - ~CoolPropMixture.signals_attributes - ~CoolPropMixture.slack_notification - ~CoolPropMixture.slot_refs - ~CoolPropMixture.slots_attributes - ~CoolPropMixture.smart_split_dataframe - ~CoolPropMixture.solvers_attributes - ~CoolPropMixture.step - ~CoolPropMixture.subclasses - ~CoolPropMixture.subcls_compile - ~CoolPropMixture.system_properties_classdef - ~CoolPropMixture.system_references - ~CoolPropMixture.table_fields - ~CoolPropMixture.trace_attributes - ~CoolPropMixture.transients_attributes - ~CoolPropMixture.update - ~CoolPropMixture.update_dynamics - ~CoolPropMixture.update_feedthrough - ~CoolPropMixture.update_input - ~CoolPropMixture.update_mass_ratios - ~CoolPropMixture.update_output_constants - ~CoolPropMixture.update_output_matrix - ~CoolPropMixture.update_state - ~CoolPropMixture.update_state_constants - ~CoolPropMixture.validate_class - ~CoolPropMixture.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~CoolPropMixture.Mmass1 - ~CoolPropMixture.Mmass2 - ~CoolPropMixture.Psat - ~CoolPropMixture.Tsat - ~CoolPropMixture.Ut_ref - ~CoolPropMixture.Xt_ref - ~CoolPropMixture.Yt_ref - ~CoolPropMixture.anything_changed - ~CoolPropMixture.as_dict - ~CoolPropMixture.attrs_fields - ~CoolPropMixture.classname - ~CoolPropMixture.dXtdt_ref - ~CoolPropMixture.data_dict - ~CoolPropMixture.dataframe_constants - ~CoolPropMixture.dataframe_variants - ~CoolPropMixture.density - ~CoolPropMixture.displayname - ~CoolPropMixture.dynamic_A - ~CoolPropMixture.dynamic_B - ~CoolPropMixture.dynamic_C - ~CoolPropMixture.dynamic_D - ~CoolPropMixture.dynamic_F - ~CoolPropMixture.dynamic_K - ~CoolPropMixture.dynamic_input - ~CoolPropMixture.dynamic_input_vars - ~CoolPropMixture.dynamic_output - ~CoolPropMixture.dynamic_output_vars - ~CoolPropMixture.dynamic_state - ~CoolPropMixture.dynamic_state_vars - ~CoolPropMixture.enthalpy - ~CoolPropMixture.filename - ~CoolPropMixture.identity - ~CoolPropMixture.input_as_dict - ~CoolPropMixture.last_context - ~CoolPropMixture.log_fmt - ~CoolPropMixture.log_level - ~CoolPropMixture.log_on - ~CoolPropMixture.log_silo - ~CoolPropMixture.logger - ~CoolPropMixture.materail2 - ~CoolPropMixture.material - ~CoolPropMixture.material1 - ~CoolPropMixture.nonlinear - ~CoolPropMixture.numeric_as_dict - ~CoolPropMixture.numeric_hash - ~CoolPropMixture.plotable_variables - ~CoolPropMixture.skip_plot_vars - ~CoolPropMixture.slack_webhook_url - ~CoolPropMixture.specific_heat - ~CoolPropMixture.state - ~CoolPropMixture.static_A - ~CoolPropMixture.static_B - ~CoolPropMixture.static_C - ~CoolPropMixture.static_D - ~CoolPropMixture.static_F - ~CoolPropMixture.static_K - ~CoolPropMixture.surface_tension - ~CoolPropMixture.system_id - ~CoolPropMixture.thermal_conductivity - ~CoolPropMixture.time - ~CoolPropMixture.unique_hash - ~CoolPropMixture.update_interval - ~CoolPropMixture.viscosity - ~CoolPropMixture.parent - ~CoolPropMixture.name - ~CoolPropMixture.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.FluidMaterial.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.FluidMaterial.rst.txt deleted file mode 100644 index ab06b81..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.FluidMaterial.rst.txt +++ /dev/null @@ -1,176 +0,0 @@ -engforge.eng.fluid\_material.FluidMaterial -========================================== - -.. currentmodule:: engforge.eng.fluid_material - -.. autoclass:: FluidMaterial - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~FluidMaterial.add_fields - ~FluidMaterial.change_all_log_lvl - ~FluidMaterial.check_ref_slot_type - ~FluidMaterial.cls_all_attrs_fields - ~FluidMaterial.cls_all_property_keys - ~FluidMaterial.cls_all_property_labels - ~FluidMaterial.cls_compile - ~FluidMaterial.collect_all_attributes - ~FluidMaterial.collect_comp_refs - ~FluidMaterial.collect_dynamic_refs - ~FluidMaterial.collect_inst_attributes - ~FluidMaterial.collect_post_update_refs - ~FluidMaterial.collect_solver_refs - ~FluidMaterial.collect_update_refs - ~FluidMaterial.comp_references - ~FluidMaterial.compile_classes - ~FluidMaterial.copy_config_at_state - ~FluidMaterial.create_dynamic_matricies - ~FluidMaterial.create_feedthrough_matrix - ~FluidMaterial.create_input_matrix - ~FluidMaterial.create_output_constants - ~FluidMaterial.create_output_matrix - ~FluidMaterial.create_state_constants - ~FluidMaterial.create_state_matrix - ~FluidMaterial.critical - ~FluidMaterial.debug - ~FluidMaterial.determine_nearest_stationary_state - ~FluidMaterial.difference - ~FluidMaterial.error - ~FluidMaterial.extract_message - ~FluidMaterial.filter - ~FluidMaterial.format_columns - ~FluidMaterial.get_system_input_refs - ~FluidMaterial.go_through_configurations - ~FluidMaterial.info - ~FluidMaterial.input_attrs - ~FluidMaterial.input_fields - ~FluidMaterial.installSTDLogger - ~FluidMaterial.internal_components - ~FluidMaterial.internal_configurations - ~FluidMaterial.internal_references - ~FluidMaterial.internal_systems - ~FluidMaterial.internal_tabulations - ~FluidMaterial.linear_output - ~FluidMaterial.linear_step - ~FluidMaterial.locate - ~FluidMaterial.locate_ref - ~FluidMaterial.message_with_identiy - ~FluidMaterial.msg - ~FluidMaterial.nonlinear_output - ~FluidMaterial.nonlinear_step - ~FluidMaterial.numeric_fields - ~FluidMaterial.parent_configurations_cls - ~FluidMaterial.parse_run_kwargs - ~FluidMaterial.parse_simulation_input - ~FluidMaterial.plot_attributes - ~FluidMaterial.post_update - ~FluidMaterial.pre_compile - ~FluidMaterial.print_info - ~FluidMaterial.rate - ~FluidMaterial.rate_linear - ~FluidMaterial.rate_nonlinear - ~FluidMaterial.ref_dXdt - ~FluidMaterial.resetLog - ~FluidMaterial.resetSystemLogs - ~FluidMaterial.set_attr - ~FluidMaterial.set_time - ~FluidMaterial.setattrs - ~FluidMaterial.signals_attributes - ~FluidMaterial.slack_notification - ~FluidMaterial.slot_refs - ~FluidMaterial.slots_attributes - ~FluidMaterial.smart_split_dataframe - ~FluidMaterial.solvers_attributes - ~FluidMaterial.step - ~FluidMaterial.subclasses - ~FluidMaterial.subcls_compile - ~FluidMaterial.system_properties_classdef - ~FluidMaterial.system_references - ~FluidMaterial.table_fields - ~FluidMaterial.trace_attributes - ~FluidMaterial.transients_attributes - ~FluidMaterial.update - ~FluidMaterial.update_dynamics - ~FluidMaterial.update_feedthrough - ~FluidMaterial.update_input - ~FluidMaterial.update_output_constants - ~FluidMaterial.update_output_matrix - ~FluidMaterial.update_state - ~FluidMaterial.update_state_constants - ~FluidMaterial.validate_class - ~FluidMaterial.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FluidMaterial.Ut_ref - ~FluidMaterial.Xt_ref - ~FluidMaterial.Yt_ref - ~FluidMaterial.anything_changed - ~FluidMaterial.as_dict - ~FluidMaterial.attrs_fields - ~FluidMaterial.classname - ~FluidMaterial.dXtdt_ref - ~FluidMaterial.data_dict - ~FluidMaterial.dataframe_constants - ~FluidMaterial.dataframe_variants - ~FluidMaterial.density - ~FluidMaterial.displayname - ~FluidMaterial.dynamic_A - ~FluidMaterial.dynamic_B - ~FluidMaterial.dynamic_C - ~FluidMaterial.dynamic_D - ~FluidMaterial.dynamic_F - ~FluidMaterial.dynamic_K - ~FluidMaterial.dynamic_input - ~FluidMaterial.dynamic_input_vars - ~FluidMaterial.dynamic_output - ~FluidMaterial.dynamic_output_vars - ~FluidMaterial.dynamic_state - ~FluidMaterial.dynamic_state_vars - ~FluidMaterial.filename - ~FluidMaterial.identity - ~FluidMaterial.input_as_dict - ~FluidMaterial.last_context - ~FluidMaterial.log_fmt - ~FluidMaterial.log_level - ~FluidMaterial.log_on - ~FluidMaterial.log_silo - ~FluidMaterial.logger - ~FluidMaterial.nonlinear - ~FluidMaterial.numeric_as_dict - ~FluidMaterial.numeric_hash - ~FluidMaterial.plotable_variables - ~FluidMaterial.skip_plot_vars - ~FluidMaterial.slack_webhook_url - ~FluidMaterial.static_A - ~FluidMaterial.static_B - ~FluidMaterial.static_C - ~FluidMaterial.static_D - ~FluidMaterial.static_F - ~FluidMaterial.static_K - ~FluidMaterial.surface_tension - ~FluidMaterial.system_id - ~FluidMaterial.time - ~FluidMaterial.unique_hash - ~FluidMaterial.update_interval - ~FluidMaterial.viscosity - ~FluidMaterial.parent - ~FluidMaterial.name - ~FluidMaterial.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.Hydrogen.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.Hydrogen.rst.txt deleted file mode 100644 index 3d54340..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.Hydrogen.rst.txt +++ /dev/null @@ -1,183 +0,0 @@ -engforge.eng.fluid\_material.Hydrogen -===================================== - -.. currentmodule:: engforge.eng.fluid_material - -.. autoclass:: Hydrogen - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Hydrogen.add_fields - ~Hydrogen.change_all_log_lvl - ~Hydrogen.check_ref_slot_type - ~Hydrogen.cls_all_attrs_fields - ~Hydrogen.cls_all_property_keys - ~Hydrogen.cls_all_property_labels - ~Hydrogen.cls_compile - ~Hydrogen.collect_all_attributes - ~Hydrogen.collect_comp_refs - ~Hydrogen.collect_dynamic_refs - ~Hydrogen.collect_inst_attributes - ~Hydrogen.collect_post_update_refs - ~Hydrogen.collect_solver_refs - ~Hydrogen.collect_update_refs - ~Hydrogen.comp_references - ~Hydrogen.compile_classes - ~Hydrogen.copy_config_at_state - ~Hydrogen.create_dynamic_matricies - ~Hydrogen.create_feedthrough_matrix - ~Hydrogen.create_input_matrix - ~Hydrogen.create_output_constants - ~Hydrogen.create_output_matrix - ~Hydrogen.create_state_constants - ~Hydrogen.create_state_matrix - ~Hydrogen.critical - ~Hydrogen.debug - ~Hydrogen.determine_nearest_stationary_state - ~Hydrogen.difference - ~Hydrogen.error - ~Hydrogen.extract_message - ~Hydrogen.filter - ~Hydrogen.format_columns - ~Hydrogen.get_system_input_refs - ~Hydrogen.go_through_configurations - ~Hydrogen.info - ~Hydrogen.input_attrs - ~Hydrogen.input_fields - ~Hydrogen.installSTDLogger - ~Hydrogen.internal_components - ~Hydrogen.internal_configurations - ~Hydrogen.internal_references - ~Hydrogen.internal_systems - ~Hydrogen.internal_tabulations - ~Hydrogen.linear_output - ~Hydrogen.linear_step - ~Hydrogen.locate - ~Hydrogen.locate_ref - ~Hydrogen.message_with_identiy - ~Hydrogen.msg - ~Hydrogen.nonlinear_output - ~Hydrogen.nonlinear_step - ~Hydrogen.numeric_fields - ~Hydrogen.parent_configurations_cls - ~Hydrogen.parse_run_kwargs - ~Hydrogen.parse_simulation_input - ~Hydrogen.plot_attributes - ~Hydrogen.post_update - ~Hydrogen.pre_compile - ~Hydrogen.print_info - ~Hydrogen.rate - ~Hydrogen.rate_linear - ~Hydrogen.rate_nonlinear - ~Hydrogen.ref_dXdt - ~Hydrogen.resetLog - ~Hydrogen.resetSystemLogs - ~Hydrogen.set_attr - ~Hydrogen.set_time - ~Hydrogen.setattrs - ~Hydrogen.signals_attributes - ~Hydrogen.slack_notification - ~Hydrogen.slot_refs - ~Hydrogen.slots_attributes - ~Hydrogen.smart_split_dataframe - ~Hydrogen.solvers_attributes - ~Hydrogen.step - ~Hydrogen.subclasses - ~Hydrogen.subcls_compile - ~Hydrogen.system_properties_classdef - ~Hydrogen.system_references - ~Hydrogen.table_fields - ~Hydrogen.trace_attributes - ~Hydrogen.transients_attributes - ~Hydrogen.update - ~Hydrogen.update_dynamics - ~Hydrogen.update_feedthrough - ~Hydrogen.update_input - ~Hydrogen.update_output_constants - ~Hydrogen.update_output_matrix - ~Hydrogen.update_state - ~Hydrogen.update_state_constants - ~Hydrogen.validate_class - ~Hydrogen.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Hydrogen.Psat - ~Hydrogen.Tsat - ~Hydrogen.Ut_ref - ~Hydrogen.Xt_ref - ~Hydrogen.Yt_ref - ~Hydrogen.anything_changed - ~Hydrogen.as_dict - ~Hydrogen.attrs_fields - ~Hydrogen.classname - ~Hydrogen.dXtdt_ref - ~Hydrogen.data_dict - ~Hydrogen.dataframe_constants - ~Hydrogen.dataframe_variants - ~Hydrogen.density - ~Hydrogen.displayname - ~Hydrogen.dynamic_A - ~Hydrogen.dynamic_B - ~Hydrogen.dynamic_C - ~Hydrogen.dynamic_D - ~Hydrogen.dynamic_F - ~Hydrogen.dynamic_K - ~Hydrogen.dynamic_input - ~Hydrogen.dynamic_input_vars - ~Hydrogen.dynamic_output - ~Hydrogen.dynamic_output_vars - ~Hydrogen.dynamic_state - ~Hydrogen.dynamic_state_vars - ~Hydrogen.enthalpy - ~Hydrogen.filename - ~Hydrogen.identity - ~Hydrogen.input_as_dict - ~Hydrogen.last_context - ~Hydrogen.log_fmt - ~Hydrogen.log_level - ~Hydrogen.log_on - ~Hydrogen.log_silo - ~Hydrogen.logger - ~Hydrogen.material - ~Hydrogen.nonlinear - ~Hydrogen.numeric_as_dict - ~Hydrogen.numeric_hash - ~Hydrogen.plotable_variables - ~Hydrogen.skip_plot_vars - ~Hydrogen.slack_webhook_url - ~Hydrogen.specific_heat - ~Hydrogen.state - ~Hydrogen.static_A - ~Hydrogen.static_B - ~Hydrogen.static_C - ~Hydrogen.static_D - ~Hydrogen.static_F - ~Hydrogen.static_K - ~Hydrogen.surface_tension - ~Hydrogen.system_id - ~Hydrogen.thermal_conductivity - ~Hydrogen.time - ~Hydrogen.unique_hash - ~Hydrogen.update_interval - ~Hydrogen.viscosity - ~Hydrogen.parent - ~Hydrogen.name - ~Hydrogen.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.IdealAir.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.IdealAir.rst.txt deleted file mode 100644 index a2baf64..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.IdealAir.rst.txt +++ /dev/null @@ -1,177 +0,0 @@ -engforge.eng.fluid\_material.IdealAir -===================================== - -.. currentmodule:: engforge.eng.fluid_material - -.. autoclass:: IdealAir - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~IdealAir.add_fields - ~IdealAir.change_all_log_lvl - ~IdealAir.check_ref_slot_type - ~IdealAir.cls_all_attrs_fields - ~IdealAir.cls_all_property_keys - ~IdealAir.cls_all_property_labels - ~IdealAir.cls_compile - ~IdealAir.collect_all_attributes - ~IdealAir.collect_comp_refs - ~IdealAir.collect_dynamic_refs - ~IdealAir.collect_inst_attributes - ~IdealAir.collect_post_update_refs - ~IdealAir.collect_solver_refs - ~IdealAir.collect_update_refs - ~IdealAir.comp_references - ~IdealAir.compile_classes - ~IdealAir.copy_config_at_state - ~IdealAir.create_dynamic_matricies - ~IdealAir.create_feedthrough_matrix - ~IdealAir.create_input_matrix - ~IdealAir.create_output_constants - ~IdealAir.create_output_matrix - ~IdealAir.create_state_constants - ~IdealAir.create_state_matrix - ~IdealAir.critical - ~IdealAir.debug - ~IdealAir.determine_nearest_stationary_state - ~IdealAir.difference - ~IdealAir.error - ~IdealAir.extract_message - ~IdealAir.filter - ~IdealAir.format_columns - ~IdealAir.get_system_input_refs - ~IdealAir.go_through_configurations - ~IdealAir.info - ~IdealAir.input_attrs - ~IdealAir.input_fields - ~IdealAir.installSTDLogger - ~IdealAir.internal_components - ~IdealAir.internal_configurations - ~IdealAir.internal_references - ~IdealAir.internal_systems - ~IdealAir.internal_tabulations - ~IdealAir.linear_output - ~IdealAir.linear_step - ~IdealAir.locate - ~IdealAir.locate_ref - ~IdealAir.message_with_identiy - ~IdealAir.msg - ~IdealAir.nonlinear_output - ~IdealAir.nonlinear_step - ~IdealAir.numeric_fields - ~IdealAir.parent_configurations_cls - ~IdealAir.parse_run_kwargs - ~IdealAir.parse_simulation_input - ~IdealAir.plot_attributes - ~IdealAir.post_update - ~IdealAir.pre_compile - ~IdealAir.print_info - ~IdealAir.rate - ~IdealAir.rate_linear - ~IdealAir.rate_nonlinear - ~IdealAir.ref_dXdt - ~IdealAir.resetLog - ~IdealAir.resetSystemLogs - ~IdealAir.set_attr - ~IdealAir.set_time - ~IdealAir.setattrs - ~IdealAir.signals_attributes - ~IdealAir.slack_notification - ~IdealAir.slot_refs - ~IdealAir.slots_attributes - ~IdealAir.smart_split_dataframe - ~IdealAir.solvers_attributes - ~IdealAir.step - ~IdealAir.subclasses - ~IdealAir.subcls_compile - ~IdealAir.system_properties_classdef - ~IdealAir.system_references - ~IdealAir.table_fields - ~IdealAir.trace_attributes - ~IdealAir.transients_attributes - ~IdealAir.update - ~IdealAir.update_dynamics - ~IdealAir.update_feedthrough - ~IdealAir.update_input - ~IdealAir.update_output_constants - ~IdealAir.update_output_matrix - ~IdealAir.update_state - ~IdealAir.update_state_constants - ~IdealAir.validate_class - ~IdealAir.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~IdealAir.Ut_ref - ~IdealAir.Xt_ref - ~IdealAir.Yt_ref - ~IdealAir.anything_changed - ~IdealAir.as_dict - ~IdealAir.attrs_fields - ~IdealAir.classname - ~IdealAir.dXtdt_ref - ~IdealAir.data_dict - ~IdealAir.dataframe_constants - ~IdealAir.dataframe_variants - ~IdealAir.density - ~IdealAir.displayname - ~IdealAir.dynamic_A - ~IdealAir.dynamic_B - ~IdealAir.dynamic_C - ~IdealAir.dynamic_D - ~IdealAir.dynamic_F - ~IdealAir.dynamic_K - ~IdealAir.dynamic_input - ~IdealAir.dynamic_input_vars - ~IdealAir.dynamic_output - ~IdealAir.dynamic_output_vars - ~IdealAir.dynamic_state - ~IdealAir.dynamic_state_vars - ~IdealAir.filename - ~IdealAir.gas_constant - ~IdealAir.identity - ~IdealAir.input_as_dict - ~IdealAir.last_context - ~IdealAir.log_fmt - ~IdealAir.log_level - ~IdealAir.log_on - ~IdealAir.log_silo - ~IdealAir.logger - ~IdealAir.nonlinear - ~IdealAir.numeric_as_dict - ~IdealAir.numeric_hash - ~IdealAir.plotable_variables - ~IdealAir.skip_plot_vars - ~IdealAir.slack_webhook_url - ~IdealAir.static_A - ~IdealAir.static_B - ~IdealAir.static_C - ~IdealAir.static_D - ~IdealAir.static_F - ~IdealAir.static_K - ~IdealAir.surface_tension - ~IdealAir.system_id - ~IdealAir.time - ~IdealAir.unique_hash - ~IdealAir.update_interval - ~IdealAir.viscosity - ~IdealAir.parent - ~IdealAir.name - ~IdealAir.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.IdealGas.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.IdealGas.rst.txt deleted file mode 100644 index 84fec9f..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.IdealGas.rst.txt +++ /dev/null @@ -1,176 +0,0 @@ -engforge.eng.fluid\_material.IdealGas -===================================== - -.. currentmodule:: engforge.eng.fluid_material - -.. autoclass:: IdealGas - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~IdealGas.add_fields - ~IdealGas.change_all_log_lvl - ~IdealGas.check_ref_slot_type - ~IdealGas.cls_all_attrs_fields - ~IdealGas.cls_all_property_keys - ~IdealGas.cls_all_property_labels - ~IdealGas.cls_compile - ~IdealGas.collect_all_attributes - ~IdealGas.collect_comp_refs - ~IdealGas.collect_dynamic_refs - ~IdealGas.collect_inst_attributes - ~IdealGas.collect_post_update_refs - ~IdealGas.collect_solver_refs - ~IdealGas.collect_update_refs - ~IdealGas.comp_references - ~IdealGas.compile_classes - ~IdealGas.copy_config_at_state - ~IdealGas.create_dynamic_matricies - ~IdealGas.create_feedthrough_matrix - ~IdealGas.create_input_matrix - ~IdealGas.create_output_constants - ~IdealGas.create_output_matrix - ~IdealGas.create_state_constants - ~IdealGas.create_state_matrix - ~IdealGas.critical - ~IdealGas.debug - ~IdealGas.determine_nearest_stationary_state - ~IdealGas.difference - ~IdealGas.error - ~IdealGas.extract_message - ~IdealGas.filter - ~IdealGas.format_columns - ~IdealGas.get_system_input_refs - ~IdealGas.go_through_configurations - ~IdealGas.info - ~IdealGas.input_attrs - ~IdealGas.input_fields - ~IdealGas.installSTDLogger - ~IdealGas.internal_components - ~IdealGas.internal_configurations - ~IdealGas.internal_references - ~IdealGas.internal_systems - ~IdealGas.internal_tabulations - ~IdealGas.linear_output - ~IdealGas.linear_step - ~IdealGas.locate - ~IdealGas.locate_ref - ~IdealGas.message_with_identiy - ~IdealGas.msg - ~IdealGas.nonlinear_output - ~IdealGas.nonlinear_step - ~IdealGas.numeric_fields - ~IdealGas.parent_configurations_cls - ~IdealGas.parse_run_kwargs - ~IdealGas.parse_simulation_input - ~IdealGas.plot_attributes - ~IdealGas.post_update - ~IdealGas.pre_compile - ~IdealGas.print_info - ~IdealGas.rate - ~IdealGas.rate_linear - ~IdealGas.rate_nonlinear - ~IdealGas.ref_dXdt - ~IdealGas.resetLog - ~IdealGas.resetSystemLogs - ~IdealGas.set_attr - ~IdealGas.set_time - ~IdealGas.setattrs - ~IdealGas.signals_attributes - ~IdealGas.slack_notification - ~IdealGas.slot_refs - ~IdealGas.slots_attributes - ~IdealGas.smart_split_dataframe - ~IdealGas.solvers_attributes - ~IdealGas.step - ~IdealGas.subclasses - ~IdealGas.subcls_compile - ~IdealGas.system_properties_classdef - ~IdealGas.system_references - ~IdealGas.table_fields - ~IdealGas.trace_attributes - ~IdealGas.transients_attributes - ~IdealGas.update - ~IdealGas.update_dynamics - ~IdealGas.update_feedthrough - ~IdealGas.update_input - ~IdealGas.update_output_constants - ~IdealGas.update_output_matrix - ~IdealGas.update_state - ~IdealGas.update_state_constants - ~IdealGas.validate_class - ~IdealGas.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~IdealGas.Ut_ref - ~IdealGas.Xt_ref - ~IdealGas.Yt_ref - ~IdealGas.anything_changed - ~IdealGas.as_dict - ~IdealGas.attrs_fields - ~IdealGas.classname - ~IdealGas.dXtdt_ref - ~IdealGas.data_dict - ~IdealGas.dataframe_constants - ~IdealGas.dataframe_variants - ~IdealGas.density - ~IdealGas.displayname - ~IdealGas.dynamic_A - ~IdealGas.dynamic_B - ~IdealGas.dynamic_C - ~IdealGas.dynamic_D - ~IdealGas.dynamic_F - ~IdealGas.dynamic_K - ~IdealGas.dynamic_input - ~IdealGas.dynamic_input_vars - ~IdealGas.dynamic_output - ~IdealGas.dynamic_output_vars - ~IdealGas.dynamic_state - ~IdealGas.dynamic_state_vars - ~IdealGas.filename - ~IdealGas.identity - ~IdealGas.input_as_dict - ~IdealGas.last_context - ~IdealGas.log_fmt - ~IdealGas.log_level - ~IdealGas.log_on - ~IdealGas.log_silo - ~IdealGas.logger - ~IdealGas.nonlinear - ~IdealGas.numeric_as_dict - ~IdealGas.numeric_hash - ~IdealGas.plotable_variables - ~IdealGas.skip_plot_vars - ~IdealGas.slack_webhook_url - ~IdealGas.static_A - ~IdealGas.static_B - ~IdealGas.static_C - ~IdealGas.static_D - ~IdealGas.static_F - ~IdealGas.static_K - ~IdealGas.surface_tension - ~IdealGas.system_id - ~IdealGas.time - ~IdealGas.unique_hash - ~IdealGas.update_interval - ~IdealGas.viscosity - ~IdealGas.parent - ~IdealGas.name - ~IdealGas.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.IdealH2.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.IdealH2.rst.txt deleted file mode 100644 index 6a75679..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.IdealH2.rst.txt +++ /dev/null @@ -1,177 +0,0 @@ -engforge.eng.fluid\_material.IdealH2 -==================================== - -.. currentmodule:: engforge.eng.fluid_material - -.. autoclass:: IdealH2 - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~IdealH2.add_fields - ~IdealH2.change_all_log_lvl - ~IdealH2.check_ref_slot_type - ~IdealH2.cls_all_attrs_fields - ~IdealH2.cls_all_property_keys - ~IdealH2.cls_all_property_labels - ~IdealH2.cls_compile - ~IdealH2.collect_all_attributes - ~IdealH2.collect_comp_refs - ~IdealH2.collect_dynamic_refs - ~IdealH2.collect_inst_attributes - ~IdealH2.collect_post_update_refs - ~IdealH2.collect_solver_refs - ~IdealH2.collect_update_refs - ~IdealH2.comp_references - ~IdealH2.compile_classes - ~IdealH2.copy_config_at_state - ~IdealH2.create_dynamic_matricies - ~IdealH2.create_feedthrough_matrix - ~IdealH2.create_input_matrix - ~IdealH2.create_output_constants - ~IdealH2.create_output_matrix - ~IdealH2.create_state_constants - ~IdealH2.create_state_matrix - ~IdealH2.critical - ~IdealH2.debug - ~IdealH2.determine_nearest_stationary_state - ~IdealH2.difference - ~IdealH2.error - ~IdealH2.extract_message - ~IdealH2.filter - ~IdealH2.format_columns - ~IdealH2.get_system_input_refs - ~IdealH2.go_through_configurations - ~IdealH2.info - ~IdealH2.input_attrs - ~IdealH2.input_fields - ~IdealH2.installSTDLogger - ~IdealH2.internal_components - ~IdealH2.internal_configurations - ~IdealH2.internal_references - ~IdealH2.internal_systems - ~IdealH2.internal_tabulations - ~IdealH2.linear_output - ~IdealH2.linear_step - ~IdealH2.locate - ~IdealH2.locate_ref - ~IdealH2.message_with_identiy - ~IdealH2.msg - ~IdealH2.nonlinear_output - ~IdealH2.nonlinear_step - ~IdealH2.numeric_fields - ~IdealH2.parent_configurations_cls - ~IdealH2.parse_run_kwargs - ~IdealH2.parse_simulation_input - ~IdealH2.plot_attributes - ~IdealH2.post_update - ~IdealH2.pre_compile - ~IdealH2.print_info - ~IdealH2.rate - ~IdealH2.rate_linear - ~IdealH2.rate_nonlinear - ~IdealH2.ref_dXdt - ~IdealH2.resetLog - ~IdealH2.resetSystemLogs - ~IdealH2.set_attr - ~IdealH2.set_time - ~IdealH2.setattrs - ~IdealH2.signals_attributes - ~IdealH2.slack_notification - ~IdealH2.slot_refs - ~IdealH2.slots_attributes - ~IdealH2.smart_split_dataframe - ~IdealH2.solvers_attributes - ~IdealH2.step - ~IdealH2.subclasses - ~IdealH2.subcls_compile - ~IdealH2.system_properties_classdef - ~IdealH2.system_references - ~IdealH2.table_fields - ~IdealH2.trace_attributes - ~IdealH2.transients_attributes - ~IdealH2.update - ~IdealH2.update_dynamics - ~IdealH2.update_feedthrough - ~IdealH2.update_input - ~IdealH2.update_output_constants - ~IdealH2.update_output_matrix - ~IdealH2.update_state - ~IdealH2.update_state_constants - ~IdealH2.validate_class - ~IdealH2.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~IdealH2.Ut_ref - ~IdealH2.Xt_ref - ~IdealH2.Yt_ref - ~IdealH2.anything_changed - ~IdealH2.as_dict - ~IdealH2.attrs_fields - ~IdealH2.classname - ~IdealH2.dXtdt_ref - ~IdealH2.data_dict - ~IdealH2.dataframe_constants - ~IdealH2.dataframe_variants - ~IdealH2.density - ~IdealH2.displayname - ~IdealH2.dynamic_A - ~IdealH2.dynamic_B - ~IdealH2.dynamic_C - ~IdealH2.dynamic_D - ~IdealH2.dynamic_F - ~IdealH2.dynamic_K - ~IdealH2.dynamic_input - ~IdealH2.dynamic_input_vars - ~IdealH2.dynamic_output - ~IdealH2.dynamic_output_vars - ~IdealH2.dynamic_state - ~IdealH2.dynamic_state_vars - ~IdealH2.filename - ~IdealH2.gas_constant - ~IdealH2.identity - ~IdealH2.input_as_dict - ~IdealH2.last_context - ~IdealH2.log_fmt - ~IdealH2.log_level - ~IdealH2.log_on - ~IdealH2.log_silo - ~IdealH2.logger - ~IdealH2.nonlinear - ~IdealH2.numeric_as_dict - ~IdealH2.numeric_hash - ~IdealH2.plotable_variables - ~IdealH2.skip_plot_vars - ~IdealH2.slack_webhook_url - ~IdealH2.static_A - ~IdealH2.static_B - ~IdealH2.static_C - ~IdealH2.static_D - ~IdealH2.static_F - ~IdealH2.static_K - ~IdealH2.surface_tension - ~IdealH2.system_id - ~IdealH2.time - ~IdealH2.unique_hash - ~IdealH2.update_interval - ~IdealH2.viscosity - ~IdealH2.parent - ~IdealH2.name - ~IdealH2.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.IdealOxygen.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.IdealOxygen.rst.txt deleted file mode 100644 index 40e0755..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.IdealOxygen.rst.txt +++ /dev/null @@ -1,177 +0,0 @@ -engforge.eng.fluid\_material.IdealOxygen -======================================== - -.. currentmodule:: engforge.eng.fluid_material - -.. autoclass:: IdealOxygen - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~IdealOxygen.add_fields - ~IdealOxygen.change_all_log_lvl - ~IdealOxygen.check_ref_slot_type - ~IdealOxygen.cls_all_attrs_fields - ~IdealOxygen.cls_all_property_keys - ~IdealOxygen.cls_all_property_labels - ~IdealOxygen.cls_compile - ~IdealOxygen.collect_all_attributes - ~IdealOxygen.collect_comp_refs - ~IdealOxygen.collect_dynamic_refs - ~IdealOxygen.collect_inst_attributes - ~IdealOxygen.collect_post_update_refs - ~IdealOxygen.collect_solver_refs - ~IdealOxygen.collect_update_refs - ~IdealOxygen.comp_references - ~IdealOxygen.compile_classes - ~IdealOxygen.copy_config_at_state - ~IdealOxygen.create_dynamic_matricies - ~IdealOxygen.create_feedthrough_matrix - ~IdealOxygen.create_input_matrix - ~IdealOxygen.create_output_constants - ~IdealOxygen.create_output_matrix - ~IdealOxygen.create_state_constants - ~IdealOxygen.create_state_matrix - ~IdealOxygen.critical - ~IdealOxygen.debug - ~IdealOxygen.determine_nearest_stationary_state - ~IdealOxygen.difference - ~IdealOxygen.error - ~IdealOxygen.extract_message - ~IdealOxygen.filter - ~IdealOxygen.format_columns - ~IdealOxygen.get_system_input_refs - ~IdealOxygen.go_through_configurations - ~IdealOxygen.info - ~IdealOxygen.input_attrs - ~IdealOxygen.input_fields - ~IdealOxygen.installSTDLogger - ~IdealOxygen.internal_components - ~IdealOxygen.internal_configurations - ~IdealOxygen.internal_references - ~IdealOxygen.internal_systems - ~IdealOxygen.internal_tabulations - ~IdealOxygen.linear_output - ~IdealOxygen.linear_step - ~IdealOxygen.locate - ~IdealOxygen.locate_ref - ~IdealOxygen.message_with_identiy - ~IdealOxygen.msg - ~IdealOxygen.nonlinear_output - ~IdealOxygen.nonlinear_step - ~IdealOxygen.numeric_fields - ~IdealOxygen.parent_configurations_cls - ~IdealOxygen.parse_run_kwargs - ~IdealOxygen.parse_simulation_input - ~IdealOxygen.plot_attributes - ~IdealOxygen.post_update - ~IdealOxygen.pre_compile - ~IdealOxygen.print_info - ~IdealOxygen.rate - ~IdealOxygen.rate_linear - ~IdealOxygen.rate_nonlinear - ~IdealOxygen.ref_dXdt - ~IdealOxygen.resetLog - ~IdealOxygen.resetSystemLogs - ~IdealOxygen.set_attr - ~IdealOxygen.set_time - ~IdealOxygen.setattrs - ~IdealOxygen.signals_attributes - ~IdealOxygen.slack_notification - ~IdealOxygen.slot_refs - ~IdealOxygen.slots_attributes - ~IdealOxygen.smart_split_dataframe - ~IdealOxygen.solvers_attributes - ~IdealOxygen.step - ~IdealOxygen.subclasses - ~IdealOxygen.subcls_compile - ~IdealOxygen.system_properties_classdef - ~IdealOxygen.system_references - ~IdealOxygen.table_fields - ~IdealOxygen.trace_attributes - ~IdealOxygen.transients_attributes - ~IdealOxygen.update - ~IdealOxygen.update_dynamics - ~IdealOxygen.update_feedthrough - ~IdealOxygen.update_input - ~IdealOxygen.update_output_constants - ~IdealOxygen.update_output_matrix - ~IdealOxygen.update_state - ~IdealOxygen.update_state_constants - ~IdealOxygen.validate_class - ~IdealOxygen.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~IdealOxygen.Ut_ref - ~IdealOxygen.Xt_ref - ~IdealOxygen.Yt_ref - ~IdealOxygen.anything_changed - ~IdealOxygen.as_dict - ~IdealOxygen.attrs_fields - ~IdealOxygen.classname - ~IdealOxygen.dXtdt_ref - ~IdealOxygen.data_dict - ~IdealOxygen.dataframe_constants - ~IdealOxygen.dataframe_variants - ~IdealOxygen.density - ~IdealOxygen.displayname - ~IdealOxygen.dynamic_A - ~IdealOxygen.dynamic_B - ~IdealOxygen.dynamic_C - ~IdealOxygen.dynamic_D - ~IdealOxygen.dynamic_F - ~IdealOxygen.dynamic_K - ~IdealOxygen.dynamic_input - ~IdealOxygen.dynamic_input_vars - ~IdealOxygen.dynamic_output - ~IdealOxygen.dynamic_output_vars - ~IdealOxygen.dynamic_state - ~IdealOxygen.dynamic_state_vars - ~IdealOxygen.filename - ~IdealOxygen.gas_constant - ~IdealOxygen.identity - ~IdealOxygen.input_as_dict - ~IdealOxygen.last_context - ~IdealOxygen.log_fmt - ~IdealOxygen.log_level - ~IdealOxygen.log_on - ~IdealOxygen.log_silo - ~IdealOxygen.logger - ~IdealOxygen.nonlinear - ~IdealOxygen.numeric_as_dict - ~IdealOxygen.numeric_hash - ~IdealOxygen.plotable_variables - ~IdealOxygen.skip_plot_vars - ~IdealOxygen.slack_webhook_url - ~IdealOxygen.static_A - ~IdealOxygen.static_B - ~IdealOxygen.static_C - ~IdealOxygen.static_D - ~IdealOxygen.static_F - ~IdealOxygen.static_K - ~IdealOxygen.surface_tension - ~IdealOxygen.system_id - ~IdealOxygen.time - ~IdealOxygen.unique_hash - ~IdealOxygen.update_interval - ~IdealOxygen.viscosity - ~IdealOxygen.parent - ~IdealOxygen.name - ~IdealOxygen.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.IdealSteam.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.IdealSteam.rst.txt deleted file mode 100644 index 25daaa7..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.IdealSteam.rst.txt +++ /dev/null @@ -1,177 +0,0 @@ -engforge.eng.fluid\_material.IdealSteam -======================================= - -.. currentmodule:: engforge.eng.fluid_material - -.. autoclass:: IdealSteam - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~IdealSteam.add_fields - ~IdealSteam.change_all_log_lvl - ~IdealSteam.check_ref_slot_type - ~IdealSteam.cls_all_attrs_fields - ~IdealSteam.cls_all_property_keys - ~IdealSteam.cls_all_property_labels - ~IdealSteam.cls_compile - ~IdealSteam.collect_all_attributes - ~IdealSteam.collect_comp_refs - ~IdealSteam.collect_dynamic_refs - ~IdealSteam.collect_inst_attributes - ~IdealSteam.collect_post_update_refs - ~IdealSteam.collect_solver_refs - ~IdealSteam.collect_update_refs - ~IdealSteam.comp_references - ~IdealSteam.compile_classes - ~IdealSteam.copy_config_at_state - ~IdealSteam.create_dynamic_matricies - ~IdealSteam.create_feedthrough_matrix - ~IdealSteam.create_input_matrix - ~IdealSteam.create_output_constants - ~IdealSteam.create_output_matrix - ~IdealSteam.create_state_constants - ~IdealSteam.create_state_matrix - ~IdealSteam.critical - ~IdealSteam.debug - ~IdealSteam.determine_nearest_stationary_state - ~IdealSteam.difference - ~IdealSteam.error - ~IdealSteam.extract_message - ~IdealSteam.filter - ~IdealSteam.format_columns - ~IdealSteam.get_system_input_refs - ~IdealSteam.go_through_configurations - ~IdealSteam.info - ~IdealSteam.input_attrs - ~IdealSteam.input_fields - ~IdealSteam.installSTDLogger - ~IdealSteam.internal_components - ~IdealSteam.internal_configurations - ~IdealSteam.internal_references - ~IdealSteam.internal_systems - ~IdealSteam.internal_tabulations - ~IdealSteam.linear_output - ~IdealSteam.linear_step - ~IdealSteam.locate - ~IdealSteam.locate_ref - ~IdealSteam.message_with_identiy - ~IdealSteam.msg - ~IdealSteam.nonlinear_output - ~IdealSteam.nonlinear_step - ~IdealSteam.numeric_fields - ~IdealSteam.parent_configurations_cls - ~IdealSteam.parse_run_kwargs - ~IdealSteam.parse_simulation_input - ~IdealSteam.plot_attributes - ~IdealSteam.post_update - ~IdealSteam.pre_compile - ~IdealSteam.print_info - ~IdealSteam.rate - ~IdealSteam.rate_linear - ~IdealSteam.rate_nonlinear - ~IdealSteam.ref_dXdt - ~IdealSteam.resetLog - ~IdealSteam.resetSystemLogs - ~IdealSteam.set_attr - ~IdealSteam.set_time - ~IdealSteam.setattrs - ~IdealSteam.signals_attributes - ~IdealSteam.slack_notification - ~IdealSteam.slot_refs - ~IdealSteam.slots_attributes - ~IdealSteam.smart_split_dataframe - ~IdealSteam.solvers_attributes - ~IdealSteam.step - ~IdealSteam.subclasses - ~IdealSteam.subcls_compile - ~IdealSteam.system_properties_classdef - ~IdealSteam.system_references - ~IdealSteam.table_fields - ~IdealSteam.trace_attributes - ~IdealSteam.transients_attributes - ~IdealSteam.update - ~IdealSteam.update_dynamics - ~IdealSteam.update_feedthrough - ~IdealSteam.update_input - ~IdealSteam.update_output_constants - ~IdealSteam.update_output_matrix - ~IdealSteam.update_state - ~IdealSteam.update_state_constants - ~IdealSteam.validate_class - ~IdealSteam.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~IdealSteam.Ut_ref - ~IdealSteam.Xt_ref - ~IdealSteam.Yt_ref - ~IdealSteam.anything_changed - ~IdealSteam.as_dict - ~IdealSteam.attrs_fields - ~IdealSteam.classname - ~IdealSteam.dXtdt_ref - ~IdealSteam.data_dict - ~IdealSteam.dataframe_constants - ~IdealSteam.dataframe_variants - ~IdealSteam.density - ~IdealSteam.displayname - ~IdealSteam.dynamic_A - ~IdealSteam.dynamic_B - ~IdealSteam.dynamic_C - ~IdealSteam.dynamic_D - ~IdealSteam.dynamic_F - ~IdealSteam.dynamic_K - ~IdealSteam.dynamic_input - ~IdealSteam.dynamic_input_vars - ~IdealSteam.dynamic_output - ~IdealSteam.dynamic_output_vars - ~IdealSteam.dynamic_state - ~IdealSteam.dynamic_state_vars - ~IdealSteam.filename - ~IdealSteam.gas_constant - ~IdealSteam.identity - ~IdealSteam.input_as_dict - ~IdealSteam.last_context - ~IdealSteam.log_fmt - ~IdealSteam.log_level - ~IdealSteam.log_on - ~IdealSteam.log_silo - ~IdealSteam.logger - ~IdealSteam.nonlinear - ~IdealSteam.numeric_as_dict - ~IdealSteam.numeric_hash - ~IdealSteam.plotable_variables - ~IdealSteam.skip_plot_vars - ~IdealSteam.slack_webhook_url - ~IdealSteam.static_A - ~IdealSteam.static_B - ~IdealSteam.static_C - ~IdealSteam.static_D - ~IdealSteam.static_F - ~IdealSteam.static_K - ~IdealSteam.surface_tension - ~IdealSteam.system_id - ~IdealSteam.time - ~IdealSteam.unique_hash - ~IdealSteam.update_interval - ~IdealSteam.viscosity - ~IdealSteam.parent - ~IdealSteam.name - ~IdealSteam.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.Oxygen.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.Oxygen.rst.txt deleted file mode 100644 index 5380347..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.Oxygen.rst.txt +++ /dev/null @@ -1,183 +0,0 @@ -engforge.eng.fluid\_material.Oxygen -=================================== - -.. currentmodule:: engforge.eng.fluid_material - -.. autoclass:: Oxygen - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Oxygen.add_fields - ~Oxygen.change_all_log_lvl - ~Oxygen.check_ref_slot_type - ~Oxygen.cls_all_attrs_fields - ~Oxygen.cls_all_property_keys - ~Oxygen.cls_all_property_labels - ~Oxygen.cls_compile - ~Oxygen.collect_all_attributes - ~Oxygen.collect_comp_refs - ~Oxygen.collect_dynamic_refs - ~Oxygen.collect_inst_attributes - ~Oxygen.collect_post_update_refs - ~Oxygen.collect_solver_refs - ~Oxygen.collect_update_refs - ~Oxygen.comp_references - ~Oxygen.compile_classes - ~Oxygen.copy_config_at_state - ~Oxygen.create_dynamic_matricies - ~Oxygen.create_feedthrough_matrix - ~Oxygen.create_input_matrix - ~Oxygen.create_output_constants - ~Oxygen.create_output_matrix - ~Oxygen.create_state_constants - ~Oxygen.create_state_matrix - ~Oxygen.critical - ~Oxygen.debug - ~Oxygen.determine_nearest_stationary_state - ~Oxygen.difference - ~Oxygen.error - ~Oxygen.extract_message - ~Oxygen.filter - ~Oxygen.format_columns - ~Oxygen.get_system_input_refs - ~Oxygen.go_through_configurations - ~Oxygen.info - ~Oxygen.input_attrs - ~Oxygen.input_fields - ~Oxygen.installSTDLogger - ~Oxygen.internal_components - ~Oxygen.internal_configurations - ~Oxygen.internal_references - ~Oxygen.internal_systems - ~Oxygen.internal_tabulations - ~Oxygen.linear_output - ~Oxygen.linear_step - ~Oxygen.locate - ~Oxygen.locate_ref - ~Oxygen.message_with_identiy - ~Oxygen.msg - ~Oxygen.nonlinear_output - ~Oxygen.nonlinear_step - ~Oxygen.numeric_fields - ~Oxygen.parent_configurations_cls - ~Oxygen.parse_run_kwargs - ~Oxygen.parse_simulation_input - ~Oxygen.plot_attributes - ~Oxygen.post_update - ~Oxygen.pre_compile - ~Oxygen.print_info - ~Oxygen.rate - ~Oxygen.rate_linear - ~Oxygen.rate_nonlinear - ~Oxygen.ref_dXdt - ~Oxygen.resetLog - ~Oxygen.resetSystemLogs - ~Oxygen.set_attr - ~Oxygen.set_time - ~Oxygen.setattrs - ~Oxygen.signals_attributes - ~Oxygen.slack_notification - ~Oxygen.slot_refs - ~Oxygen.slots_attributes - ~Oxygen.smart_split_dataframe - ~Oxygen.solvers_attributes - ~Oxygen.step - ~Oxygen.subclasses - ~Oxygen.subcls_compile - ~Oxygen.system_properties_classdef - ~Oxygen.system_references - ~Oxygen.table_fields - ~Oxygen.trace_attributes - ~Oxygen.transients_attributes - ~Oxygen.update - ~Oxygen.update_dynamics - ~Oxygen.update_feedthrough - ~Oxygen.update_input - ~Oxygen.update_output_constants - ~Oxygen.update_output_matrix - ~Oxygen.update_state - ~Oxygen.update_state_constants - ~Oxygen.validate_class - ~Oxygen.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Oxygen.Psat - ~Oxygen.Tsat - ~Oxygen.Ut_ref - ~Oxygen.Xt_ref - ~Oxygen.Yt_ref - ~Oxygen.anything_changed - ~Oxygen.as_dict - ~Oxygen.attrs_fields - ~Oxygen.classname - ~Oxygen.dXtdt_ref - ~Oxygen.data_dict - ~Oxygen.dataframe_constants - ~Oxygen.dataframe_variants - ~Oxygen.density - ~Oxygen.displayname - ~Oxygen.dynamic_A - ~Oxygen.dynamic_B - ~Oxygen.dynamic_C - ~Oxygen.dynamic_D - ~Oxygen.dynamic_F - ~Oxygen.dynamic_K - ~Oxygen.dynamic_input - ~Oxygen.dynamic_input_vars - ~Oxygen.dynamic_output - ~Oxygen.dynamic_output_vars - ~Oxygen.dynamic_state - ~Oxygen.dynamic_state_vars - ~Oxygen.enthalpy - ~Oxygen.filename - ~Oxygen.identity - ~Oxygen.input_as_dict - ~Oxygen.last_context - ~Oxygen.log_fmt - ~Oxygen.log_level - ~Oxygen.log_on - ~Oxygen.log_silo - ~Oxygen.logger - ~Oxygen.material - ~Oxygen.nonlinear - ~Oxygen.numeric_as_dict - ~Oxygen.numeric_hash - ~Oxygen.plotable_variables - ~Oxygen.skip_plot_vars - ~Oxygen.slack_webhook_url - ~Oxygen.specific_heat - ~Oxygen.state - ~Oxygen.static_A - ~Oxygen.static_B - ~Oxygen.static_C - ~Oxygen.static_D - ~Oxygen.static_F - ~Oxygen.static_K - ~Oxygen.surface_tension - ~Oxygen.system_id - ~Oxygen.thermal_conductivity - ~Oxygen.time - ~Oxygen.unique_hash - ~Oxygen.update_interval - ~Oxygen.viscosity - ~Oxygen.parent - ~Oxygen.name - ~Oxygen.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.SeaWater.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.SeaWater.rst.txt deleted file mode 100644 index 27eb8f2..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.SeaWater.rst.txt +++ /dev/null @@ -1,183 +0,0 @@ -engforge.eng.fluid\_material.SeaWater -===================================== - -.. currentmodule:: engforge.eng.fluid_material - -.. autoclass:: SeaWater - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~SeaWater.add_fields - ~SeaWater.change_all_log_lvl - ~SeaWater.check_ref_slot_type - ~SeaWater.cls_all_attrs_fields - ~SeaWater.cls_all_property_keys - ~SeaWater.cls_all_property_labels - ~SeaWater.cls_compile - ~SeaWater.collect_all_attributes - ~SeaWater.collect_comp_refs - ~SeaWater.collect_dynamic_refs - ~SeaWater.collect_inst_attributes - ~SeaWater.collect_post_update_refs - ~SeaWater.collect_solver_refs - ~SeaWater.collect_update_refs - ~SeaWater.comp_references - ~SeaWater.compile_classes - ~SeaWater.copy_config_at_state - ~SeaWater.create_dynamic_matricies - ~SeaWater.create_feedthrough_matrix - ~SeaWater.create_input_matrix - ~SeaWater.create_output_constants - ~SeaWater.create_output_matrix - ~SeaWater.create_state_constants - ~SeaWater.create_state_matrix - ~SeaWater.critical - ~SeaWater.debug - ~SeaWater.determine_nearest_stationary_state - ~SeaWater.difference - ~SeaWater.error - ~SeaWater.extract_message - ~SeaWater.filter - ~SeaWater.format_columns - ~SeaWater.get_system_input_refs - ~SeaWater.go_through_configurations - ~SeaWater.info - ~SeaWater.input_attrs - ~SeaWater.input_fields - ~SeaWater.installSTDLogger - ~SeaWater.internal_components - ~SeaWater.internal_configurations - ~SeaWater.internal_references - ~SeaWater.internal_systems - ~SeaWater.internal_tabulations - ~SeaWater.linear_output - ~SeaWater.linear_step - ~SeaWater.locate - ~SeaWater.locate_ref - ~SeaWater.message_with_identiy - ~SeaWater.msg - ~SeaWater.nonlinear_output - ~SeaWater.nonlinear_step - ~SeaWater.numeric_fields - ~SeaWater.parent_configurations_cls - ~SeaWater.parse_run_kwargs - ~SeaWater.parse_simulation_input - ~SeaWater.plot_attributes - ~SeaWater.post_update - ~SeaWater.pre_compile - ~SeaWater.print_info - ~SeaWater.rate - ~SeaWater.rate_linear - ~SeaWater.rate_nonlinear - ~SeaWater.ref_dXdt - ~SeaWater.resetLog - ~SeaWater.resetSystemLogs - ~SeaWater.set_attr - ~SeaWater.set_time - ~SeaWater.setattrs - ~SeaWater.signals_attributes - ~SeaWater.slack_notification - ~SeaWater.slot_refs - ~SeaWater.slots_attributes - ~SeaWater.smart_split_dataframe - ~SeaWater.solvers_attributes - ~SeaWater.step - ~SeaWater.subclasses - ~SeaWater.subcls_compile - ~SeaWater.system_properties_classdef - ~SeaWater.system_references - ~SeaWater.table_fields - ~SeaWater.trace_attributes - ~SeaWater.transients_attributes - ~SeaWater.update - ~SeaWater.update_dynamics - ~SeaWater.update_feedthrough - ~SeaWater.update_input - ~SeaWater.update_output_constants - ~SeaWater.update_output_matrix - ~SeaWater.update_state - ~SeaWater.update_state_constants - ~SeaWater.validate_class - ~SeaWater.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~SeaWater.Psat - ~SeaWater.Tsat - ~SeaWater.Ut_ref - ~SeaWater.Xt_ref - ~SeaWater.Yt_ref - ~SeaWater.anything_changed - ~SeaWater.as_dict - ~SeaWater.attrs_fields - ~SeaWater.classname - ~SeaWater.dXtdt_ref - ~SeaWater.data_dict - ~SeaWater.dataframe_constants - ~SeaWater.dataframe_variants - ~SeaWater.density - ~SeaWater.displayname - ~SeaWater.dynamic_A - ~SeaWater.dynamic_B - ~SeaWater.dynamic_C - ~SeaWater.dynamic_D - ~SeaWater.dynamic_F - ~SeaWater.dynamic_K - ~SeaWater.dynamic_input - ~SeaWater.dynamic_input_vars - ~SeaWater.dynamic_output - ~SeaWater.dynamic_output_vars - ~SeaWater.dynamic_state - ~SeaWater.dynamic_state_vars - ~SeaWater.enthalpy - ~SeaWater.filename - ~SeaWater.identity - ~SeaWater.input_as_dict - ~SeaWater.last_context - ~SeaWater.log_fmt - ~SeaWater.log_level - ~SeaWater.log_on - ~SeaWater.log_silo - ~SeaWater.logger - ~SeaWater.material - ~SeaWater.nonlinear - ~SeaWater.numeric_as_dict - ~SeaWater.numeric_hash - ~SeaWater.plotable_variables - ~SeaWater.skip_plot_vars - ~SeaWater.slack_webhook_url - ~SeaWater.specific_heat - ~SeaWater.state - ~SeaWater.static_A - ~SeaWater.static_B - ~SeaWater.static_C - ~SeaWater.static_D - ~SeaWater.static_F - ~SeaWater.static_K - ~SeaWater.surface_tension - ~SeaWater.system_id - ~SeaWater.thermal_conductivity - ~SeaWater.time - ~SeaWater.unique_hash - ~SeaWater.update_interval - ~SeaWater.viscosity - ~SeaWater.parent - ~SeaWater.name - ~SeaWater.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.Steam.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.Steam.rst.txt deleted file mode 100644 index 66946b6..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.Steam.rst.txt +++ /dev/null @@ -1,183 +0,0 @@ -engforge.eng.fluid\_material.Steam -================================== - -.. currentmodule:: engforge.eng.fluid_material - -.. autoclass:: Steam - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Steam.add_fields - ~Steam.change_all_log_lvl - ~Steam.check_ref_slot_type - ~Steam.cls_all_attrs_fields - ~Steam.cls_all_property_keys - ~Steam.cls_all_property_labels - ~Steam.cls_compile - ~Steam.collect_all_attributes - ~Steam.collect_comp_refs - ~Steam.collect_dynamic_refs - ~Steam.collect_inst_attributes - ~Steam.collect_post_update_refs - ~Steam.collect_solver_refs - ~Steam.collect_update_refs - ~Steam.comp_references - ~Steam.compile_classes - ~Steam.copy_config_at_state - ~Steam.create_dynamic_matricies - ~Steam.create_feedthrough_matrix - ~Steam.create_input_matrix - ~Steam.create_output_constants - ~Steam.create_output_matrix - ~Steam.create_state_constants - ~Steam.create_state_matrix - ~Steam.critical - ~Steam.debug - ~Steam.determine_nearest_stationary_state - ~Steam.difference - ~Steam.error - ~Steam.extract_message - ~Steam.filter - ~Steam.format_columns - ~Steam.get_system_input_refs - ~Steam.go_through_configurations - ~Steam.info - ~Steam.input_attrs - ~Steam.input_fields - ~Steam.installSTDLogger - ~Steam.internal_components - ~Steam.internal_configurations - ~Steam.internal_references - ~Steam.internal_systems - ~Steam.internal_tabulations - ~Steam.linear_output - ~Steam.linear_step - ~Steam.locate - ~Steam.locate_ref - ~Steam.message_with_identiy - ~Steam.msg - ~Steam.nonlinear_output - ~Steam.nonlinear_step - ~Steam.numeric_fields - ~Steam.parent_configurations_cls - ~Steam.parse_run_kwargs - ~Steam.parse_simulation_input - ~Steam.plot_attributes - ~Steam.post_update - ~Steam.pre_compile - ~Steam.print_info - ~Steam.rate - ~Steam.rate_linear - ~Steam.rate_nonlinear - ~Steam.ref_dXdt - ~Steam.resetLog - ~Steam.resetSystemLogs - ~Steam.set_attr - ~Steam.set_time - ~Steam.setattrs - ~Steam.signals_attributes - ~Steam.slack_notification - ~Steam.slot_refs - ~Steam.slots_attributes - ~Steam.smart_split_dataframe - ~Steam.solvers_attributes - ~Steam.step - ~Steam.subclasses - ~Steam.subcls_compile - ~Steam.system_properties_classdef - ~Steam.system_references - ~Steam.table_fields - ~Steam.trace_attributes - ~Steam.transients_attributes - ~Steam.update - ~Steam.update_dynamics - ~Steam.update_feedthrough - ~Steam.update_input - ~Steam.update_output_constants - ~Steam.update_output_matrix - ~Steam.update_state - ~Steam.update_state_constants - ~Steam.validate_class - ~Steam.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Steam.Psat - ~Steam.Tsat - ~Steam.Ut_ref - ~Steam.Xt_ref - ~Steam.Yt_ref - ~Steam.anything_changed - ~Steam.as_dict - ~Steam.attrs_fields - ~Steam.classname - ~Steam.dXtdt_ref - ~Steam.data_dict - ~Steam.dataframe_constants - ~Steam.dataframe_variants - ~Steam.density - ~Steam.displayname - ~Steam.dynamic_A - ~Steam.dynamic_B - ~Steam.dynamic_C - ~Steam.dynamic_D - ~Steam.dynamic_F - ~Steam.dynamic_K - ~Steam.dynamic_input - ~Steam.dynamic_input_vars - ~Steam.dynamic_output - ~Steam.dynamic_output_vars - ~Steam.dynamic_state - ~Steam.dynamic_state_vars - ~Steam.enthalpy - ~Steam.filename - ~Steam.identity - ~Steam.input_as_dict - ~Steam.last_context - ~Steam.log_fmt - ~Steam.log_level - ~Steam.log_on - ~Steam.log_silo - ~Steam.logger - ~Steam.material - ~Steam.nonlinear - ~Steam.numeric_as_dict - ~Steam.numeric_hash - ~Steam.plotable_variables - ~Steam.skip_plot_vars - ~Steam.slack_webhook_url - ~Steam.specific_heat - ~Steam.state - ~Steam.static_A - ~Steam.static_B - ~Steam.static_C - ~Steam.static_D - ~Steam.static_F - ~Steam.static_K - ~Steam.surface_tension - ~Steam.system_id - ~Steam.thermal_conductivity - ~Steam.time - ~Steam.unique_hash - ~Steam.update_interval - ~Steam.viscosity - ~Steam.parent - ~Steam.name - ~Steam.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.Water.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.Water.rst.txt deleted file mode 100644 index 4b69caf..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.Water.rst.txt +++ /dev/null @@ -1,183 +0,0 @@ -engforge.eng.fluid\_material.Water -================================== - -.. currentmodule:: engforge.eng.fluid_material - -.. autoclass:: Water - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Water.add_fields - ~Water.change_all_log_lvl - ~Water.check_ref_slot_type - ~Water.cls_all_attrs_fields - ~Water.cls_all_property_keys - ~Water.cls_all_property_labels - ~Water.cls_compile - ~Water.collect_all_attributes - ~Water.collect_comp_refs - ~Water.collect_dynamic_refs - ~Water.collect_inst_attributes - ~Water.collect_post_update_refs - ~Water.collect_solver_refs - ~Water.collect_update_refs - ~Water.comp_references - ~Water.compile_classes - ~Water.copy_config_at_state - ~Water.create_dynamic_matricies - ~Water.create_feedthrough_matrix - ~Water.create_input_matrix - ~Water.create_output_constants - ~Water.create_output_matrix - ~Water.create_state_constants - ~Water.create_state_matrix - ~Water.critical - ~Water.debug - ~Water.determine_nearest_stationary_state - ~Water.difference - ~Water.error - ~Water.extract_message - ~Water.filter - ~Water.format_columns - ~Water.get_system_input_refs - ~Water.go_through_configurations - ~Water.info - ~Water.input_attrs - ~Water.input_fields - ~Water.installSTDLogger - ~Water.internal_components - ~Water.internal_configurations - ~Water.internal_references - ~Water.internal_systems - ~Water.internal_tabulations - ~Water.linear_output - ~Water.linear_step - ~Water.locate - ~Water.locate_ref - ~Water.message_with_identiy - ~Water.msg - ~Water.nonlinear_output - ~Water.nonlinear_step - ~Water.numeric_fields - ~Water.parent_configurations_cls - ~Water.parse_run_kwargs - ~Water.parse_simulation_input - ~Water.plot_attributes - ~Water.post_update - ~Water.pre_compile - ~Water.print_info - ~Water.rate - ~Water.rate_linear - ~Water.rate_nonlinear - ~Water.ref_dXdt - ~Water.resetLog - ~Water.resetSystemLogs - ~Water.set_attr - ~Water.set_time - ~Water.setattrs - ~Water.signals_attributes - ~Water.slack_notification - ~Water.slot_refs - ~Water.slots_attributes - ~Water.smart_split_dataframe - ~Water.solvers_attributes - ~Water.step - ~Water.subclasses - ~Water.subcls_compile - ~Water.system_properties_classdef - ~Water.system_references - ~Water.table_fields - ~Water.trace_attributes - ~Water.transients_attributes - ~Water.update - ~Water.update_dynamics - ~Water.update_feedthrough - ~Water.update_input - ~Water.update_output_constants - ~Water.update_output_matrix - ~Water.update_state - ~Water.update_state_constants - ~Water.validate_class - ~Water.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Water.Psat - ~Water.Tsat - ~Water.Ut_ref - ~Water.Xt_ref - ~Water.Yt_ref - ~Water.anything_changed - ~Water.as_dict - ~Water.attrs_fields - ~Water.classname - ~Water.dXtdt_ref - ~Water.data_dict - ~Water.dataframe_constants - ~Water.dataframe_variants - ~Water.density - ~Water.displayname - ~Water.dynamic_A - ~Water.dynamic_B - ~Water.dynamic_C - ~Water.dynamic_D - ~Water.dynamic_F - ~Water.dynamic_K - ~Water.dynamic_input - ~Water.dynamic_input_vars - ~Water.dynamic_output - ~Water.dynamic_output_vars - ~Water.dynamic_state - ~Water.dynamic_state_vars - ~Water.enthalpy - ~Water.filename - ~Water.identity - ~Water.input_as_dict - ~Water.last_context - ~Water.log_fmt - ~Water.log_level - ~Water.log_on - ~Water.log_silo - ~Water.logger - ~Water.material - ~Water.nonlinear - ~Water.numeric_as_dict - ~Water.numeric_hash - ~Water.plotable_variables - ~Water.skip_plot_vars - ~Water.slack_webhook_url - ~Water.specific_heat - ~Water.state - ~Water.static_A - ~Water.static_B - ~Water.static_C - ~Water.static_D - ~Water.static_F - ~Water.static_K - ~Water.surface_tension - ~Water.system_id - ~Water.thermal_conductivity - ~Water.time - ~Water.unique_hash - ~Water.update_interval - ~Water.viscosity - ~Water.parent - ~Water.name - ~Water.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.rst.txt deleted file mode 100644 index 9225d4b..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.fluid_material.rst.txt +++ /dev/null @@ -1,46 +0,0 @@ -engforge.eng.fluid\_material -============================ - -.. automodule:: engforge.eng.fluid_material - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - Air - AirWaterMix - CoolPropMaterial - CoolPropMixture - FluidMaterial - Hydrogen - IdealAir - IdealGas - IdealH2 - IdealOxygen - IdealSteam - Oxygen - SeaWater - Steam - Water - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.Circle.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.Circle.rst.txt deleted file mode 100644 index 1d682f5..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.Circle.rst.txt +++ /dev/null @@ -1,113 +0,0 @@ -engforge.eng.geometry.Circle -============================ - -.. currentmodule:: engforge.eng.geometry - -.. autoclass:: Circle - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Circle.add_fields - ~Circle.add_prediction_record - ~Circle.calculate_stress - ~Circle.change_all_log_lvl - ~Circle.check_and_retrain - ~Circle.check_out_of_domain - ~Circle.check_ref_slot_type - ~Circle.cls_compile - ~Circle.collect_all_attributes - ~Circle.collect_inst_attributes - ~Circle.compile_classes - ~Circle.copy_config_at_state - ~Circle.critical - ~Circle.debug - ~Circle.difference - ~Circle.display_results - ~Circle.error - ~Circle.estimate_stress - ~Circle.extract_message - ~Circle.filter - ~Circle.go_through_configurations - ~Circle.info - ~Circle.input_attrs - ~Circle.input_fields - ~Circle.installSTDLogger - ~Circle.internal_configurations - ~Circle.message_with_identiy - ~Circle.msg - ~Circle.numeric_fields - ~Circle.observe_and_predict - ~Circle.parent_configurations_cls - ~Circle.plot_attributes - ~Circle.plot_mesh - ~Circle.pre_compile - ~Circle.prediction_dataframe - ~Circle.prediction_weights - ~Circle.resetLog - ~Circle.resetSystemLogs - ~Circle.score_data - ~Circle.setattrs - ~Circle.signals_attributes - ~Circle.slack_notification - ~Circle.slot_refs - ~Circle.slots_attributes - ~Circle.solvers_attributes - ~Circle.subclasses - ~Circle.subcls_compile - ~Circle.table_fields - ~Circle.trace_attributes - ~Circle.train_compare - ~Circle.training_callback - ~Circle.transients_attributes - ~Circle.validate_class - ~Circle.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Circle.A - ~Circle.Ao - ~Circle.Ixx - ~Circle.Iyy - ~Circle.J - ~Circle.as_dict - ~Circle.attrs_fields - ~Circle.basis - ~Circle.classname - ~Circle.displayname - ~Circle.filename - ~Circle.identity - ~Circle.input_as_dict - ~Circle.log_fmt - ~Circle.log_level - ~Circle.log_on - ~Circle.log_silo - ~Circle.logger - ~Circle.numeric_as_dict - ~Circle.numeric_hash - ~Circle.prediction_goal_error - ~Circle.prediction_records - ~Circle.slack_webhook_url - ~Circle.train_window - ~Circle.trained - ~Circle.unique_hash - ~Circle.x_bounds - ~Circle.y_bounds - ~Circle.d - ~Circle.name - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.GeometryLog.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.GeometryLog.rst.txt deleted file mode 100644 index e6dd0d6..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.GeometryLog.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.eng.geometry.GeometryLog -================================= - -.. currentmodule:: engforge.eng.geometry - -.. autoclass:: GeometryLog - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~GeometryLog.add_fields - ~GeometryLog.change_all_log_lvl - ~GeometryLog.critical - ~GeometryLog.debug - ~GeometryLog.error - ~GeometryLog.extract_message - ~GeometryLog.filter - ~GeometryLog.info - ~GeometryLog.installSTDLogger - ~GeometryLog.message_with_identiy - ~GeometryLog.msg - ~GeometryLog.resetLog - ~GeometryLog.resetSystemLogs - ~GeometryLog.slack_notification - ~GeometryLog.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~GeometryLog.identity - ~GeometryLog.log_fmt - ~GeometryLog.log_level - ~GeometryLog.log_on - ~GeometryLog.logger - ~GeometryLog.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.HollowCircle.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.HollowCircle.rst.txt deleted file mode 100644 index a2482f6..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.HollowCircle.rst.txt +++ /dev/null @@ -1,115 +0,0 @@ -engforge.eng.geometry.HollowCircle -================================== - -.. currentmodule:: engforge.eng.geometry - -.. autoclass:: HollowCircle - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~HollowCircle.add_fields - ~HollowCircle.add_prediction_record - ~HollowCircle.calculate_stress - ~HollowCircle.change_all_log_lvl - ~HollowCircle.check_and_retrain - ~HollowCircle.check_out_of_domain - ~HollowCircle.check_ref_slot_type - ~HollowCircle.cls_compile - ~HollowCircle.collect_all_attributes - ~HollowCircle.collect_inst_attributes - ~HollowCircle.compile_classes - ~HollowCircle.copy_config_at_state - ~HollowCircle.critical - ~HollowCircle.debug - ~HollowCircle.difference - ~HollowCircle.display_results - ~HollowCircle.error - ~HollowCircle.estimate_stress - ~HollowCircle.extract_message - ~HollowCircle.filter - ~HollowCircle.go_through_configurations - ~HollowCircle.info - ~HollowCircle.input_attrs - ~HollowCircle.input_fields - ~HollowCircle.installSTDLogger - ~HollowCircle.internal_configurations - ~HollowCircle.message_with_identiy - ~HollowCircle.msg - ~HollowCircle.numeric_fields - ~HollowCircle.observe_and_predict - ~HollowCircle.parent_configurations_cls - ~HollowCircle.plot_attributes - ~HollowCircle.plot_mesh - ~HollowCircle.pre_compile - ~HollowCircle.prediction_dataframe - ~HollowCircle.prediction_weights - ~HollowCircle.resetLog - ~HollowCircle.resetSystemLogs - ~HollowCircle.score_data - ~HollowCircle.setattrs - ~HollowCircle.signals_attributes - ~HollowCircle.slack_notification - ~HollowCircle.slot_refs - ~HollowCircle.slots_attributes - ~HollowCircle.solvers_attributes - ~HollowCircle.subclasses - ~HollowCircle.subcls_compile - ~HollowCircle.table_fields - ~HollowCircle.trace_attributes - ~HollowCircle.train_compare - ~HollowCircle.training_callback - ~HollowCircle.transients_attributes - ~HollowCircle.validate_class - ~HollowCircle.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~HollowCircle.A - ~HollowCircle.Ao - ~HollowCircle.Ixx - ~HollowCircle.Iyy - ~HollowCircle.J - ~HollowCircle.as_dict - ~HollowCircle.attrs_fields - ~HollowCircle.basis - ~HollowCircle.classname - ~HollowCircle.di - ~HollowCircle.displayname - ~HollowCircle.filename - ~HollowCircle.identity - ~HollowCircle.input_as_dict - ~HollowCircle.log_fmt - ~HollowCircle.log_level - ~HollowCircle.log_on - ~HollowCircle.log_silo - ~HollowCircle.logger - ~HollowCircle.numeric_as_dict - ~HollowCircle.numeric_hash - ~HollowCircle.prediction_goal_error - ~HollowCircle.prediction_records - ~HollowCircle.slack_webhook_url - ~HollowCircle.train_window - ~HollowCircle.trained - ~HollowCircle.unique_hash - ~HollowCircle.x_bounds - ~HollowCircle.y_bounds - ~HollowCircle.d - ~HollowCircle.t - ~HollowCircle.name - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.ParametricSpline.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.ParametricSpline.rst.txt deleted file mode 100644 index 8d6bc5d..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.ParametricSpline.rst.txt +++ /dev/null @@ -1,34 +0,0 @@ -engforge.eng.geometry.ParametricSpline -====================================== - -.. currentmodule:: engforge.eng.geometry - -.. autoclass:: ParametricSpline - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~ParametricSpline.coords - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ParametricSpline.a0 - ~ParametricSpline.a1 - ~ParametricSpline.a2 - ~ParametricSpline.a3 - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.Profile2D.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.Profile2D.rst.txt deleted file mode 100644 index 57234c0..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.Profile2D.rst.txt +++ /dev/null @@ -1,112 +0,0 @@ -engforge.eng.geometry.Profile2D -=============================== - -.. currentmodule:: engforge.eng.geometry - -.. autoclass:: Profile2D - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Profile2D.add_fields - ~Profile2D.add_prediction_record - ~Profile2D.calculate_stress - ~Profile2D.change_all_log_lvl - ~Profile2D.check_and_retrain - ~Profile2D.check_out_of_domain - ~Profile2D.check_ref_slot_type - ~Profile2D.cls_compile - ~Profile2D.collect_all_attributes - ~Profile2D.collect_inst_attributes - ~Profile2D.compile_classes - ~Profile2D.copy_config_at_state - ~Profile2D.critical - ~Profile2D.debug - ~Profile2D.difference - ~Profile2D.display_results - ~Profile2D.error - ~Profile2D.estimate_stress - ~Profile2D.extract_message - ~Profile2D.filter - ~Profile2D.go_through_configurations - ~Profile2D.info - ~Profile2D.input_attrs - ~Profile2D.input_fields - ~Profile2D.installSTDLogger - ~Profile2D.internal_configurations - ~Profile2D.message_with_identiy - ~Profile2D.msg - ~Profile2D.numeric_fields - ~Profile2D.observe_and_predict - ~Profile2D.parent_configurations_cls - ~Profile2D.plot_attributes - ~Profile2D.plot_mesh - ~Profile2D.pre_compile - ~Profile2D.prediction_dataframe - ~Profile2D.prediction_weights - ~Profile2D.resetLog - ~Profile2D.resetSystemLogs - ~Profile2D.score_data - ~Profile2D.setattrs - ~Profile2D.signals_attributes - ~Profile2D.slack_notification - ~Profile2D.slot_refs - ~Profile2D.slots_attributes - ~Profile2D.solvers_attributes - ~Profile2D.subclasses - ~Profile2D.subcls_compile - ~Profile2D.table_fields - ~Profile2D.trace_attributes - ~Profile2D.train_compare - ~Profile2D.training_callback - ~Profile2D.transients_attributes - ~Profile2D.validate_class - ~Profile2D.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Profile2D.A - ~Profile2D.Ao - ~Profile2D.Ixx - ~Profile2D.Iyy - ~Profile2D.J - ~Profile2D.as_dict - ~Profile2D.attrs_fields - ~Profile2D.basis - ~Profile2D.classname - ~Profile2D.displayname - ~Profile2D.filename - ~Profile2D.identity - ~Profile2D.input_as_dict - ~Profile2D.log_fmt - ~Profile2D.log_level - ~Profile2D.log_on - ~Profile2D.log_silo - ~Profile2D.logger - ~Profile2D.numeric_as_dict - ~Profile2D.numeric_hash - ~Profile2D.prediction_goal_error - ~Profile2D.prediction_records - ~Profile2D.slack_webhook_url - ~Profile2D.train_window - ~Profile2D.trained - ~Profile2D.unique_hash - ~Profile2D.x_bounds - ~Profile2D.y_bounds - ~Profile2D.name - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.Rectangle.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.Rectangle.rst.txt deleted file mode 100644 index 1ae1fb2..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.Rectangle.rst.txt +++ /dev/null @@ -1,114 +0,0 @@ -engforge.eng.geometry.Rectangle -=============================== - -.. currentmodule:: engforge.eng.geometry - -.. autoclass:: Rectangle - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Rectangle.add_fields - ~Rectangle.add_prediction_record - ~Rectangle.calculate_stress - ~Rectangle.change_all_log_lvl - ~Rectangle.check_and_retrain - ~Rectangle.check_out_of_domain - ~Rectangle.check_ref_slot_type - ~Rectangle.cls_compile - ~Rectangle.collect_all_attributes - ~Rectangle.collect_inst_attributes - ~Rectangle.compile_classes - ~Rectangle.copy_config_at_state - ~Rectangle.critical - ~Rectangle.debug - ~Rectangle.difference - ~Rectangle.display_results - ~Rectangle.error - ~Rectangle.estimate_stress - ~Rectangle.extract_message - ~Rectangle.filter - ~Rectangle.go_through_configurations - ~Rectangle.info - ~Rectangle.input_attrs - ~Rectangle.input_fields - ~Rectangle.installSTDLogger - ~Rectangle.internal_configurations - ~Rectangle.message_with_identiy - ~Rectangle.msg - ~Rectangle.numeric_fields - ~Rectangle.observe_and_predict - ~Rectangle.parent_configurations_cls - ~Rectangle.plot_attributes - ~Rectangle.plot_mesh - ~Rectangle.pre_compile - ~Rectangle.prediction_dataframe - ~Rectangle.prediction_weights - ~Rectangle.resetLog - ~Rectangle.resetSystemLogs - ~Rectangle.score_data - ~Rectangle.setattrs - ~Rectangle.signals_attributes - ~Rectangle.slack_notification - ~Rectangle.slot_refs - ~Rectangle.slots_attributes - ~Rectangle.solvers_attributes - ~Rectangle.subclasses - ~Rectangle.subcls_compile - ~Rectangle.table_fields - ~Rectangle.trace_attributes - ~Rectangle.train_compare - ~Rectangle.training_callback - ~Rectangle.transients_attributes - ~Rectangle.validate_class - ~Rectangle.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Rectangle.A - ~Rectangle.Ao - ~Rectangle.Ixx - ~Rectangle.Iyy - ~Rectangle.J - ~Rectangle.as_dict - ~Rectangle.attrs_fields - ~Rectangle.basis - ~Rectangle.classname - ~Rectangle.displayname - ~Rectangle.filename - ~Rectangle.identity - ~Rectangle.input_as_dict - ~Rectangle.log_fmt - ~Rectangle.log_level - ~Rectangle.log_on - ~Rectangle.log_silo - ~Rectangle.logger - ~Rectangle.numeric_as_dict - ~Rectangle.numeric_hash - ~Rectangle.prediction_goal_error - ~Rectangle.prediction_records - ~Rectangle.slack_webhook_url - ~Rectangle.train_window - ~Rectangle.trained - ~Rectangle.unique_hash - ~Rectangle.x_bounds - ~Rectangle.y_bounds - ~Rectangle.b - ~Rectangle.h - ~Rectangle.name - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.ShapelySection.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.ShapelySection.rst.txt deleted file mode 100644 index 8111462..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.ShapelySection.rst.txt +++ /dev/null @@ -1,150 +0,0 @@ -engforge.eng.geometry.ShapelySection -==================================== - -.. currentmodule:: engforge.eng.geometry - -.. autoclass:: ShapelySection - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~ShapelySection.add_fields - ~ShapelySection.add_prediction_record - ~ShapelySection.basis_expand - ~ShapelySection.calculate_bounds - ~ShapelySection.calculate_mesh_size - ~ShapelySection.calculate_stress - ~ShapelySection.change_all_log_lvl - ~ShapelySection.check_and_retrain - ~ShapelySection.check_out_of_domain - ~ShapelySection.check_ref_slot_type - ~ShapelySection.check_symmetric - ~ShapelySection.cls_compile - ~ShapelySection.collect_all_attributes - ~ShapelySection.collect_inst_attributes - ~ShapelySection.compile_classes - ~ShapelySection.copy_config_at_state - ~ShapelySection.critical - ~ShapelySection.debug - ~ShapelySection.determine_failure_front - ~ShapelySection.determine_failure_stress - ~ShapelySection.difference - ~ShapelySection.display_results - ~ShapelySection.error - ~ShapelySection.estimate_failure - ~ShapelySection.estimate_stress - ~ShapelySection.extract_message - ~ShapelySection.fail_frac_criteria - ~ShapelySection.fail_learning - ~ShapelySection.filter - ~ShapelySection.from_cache - ~ShapelySection.go_through_configurations - ~ShapelySection.hash_id - ~ShapelySection.info - ~ShapelySection.init_with_material - ~ShapelySection.input_attrs - ~ShapelySection.input_fields - ~ShapelySection.installSTDLogger - ~ShapelySection.internal_configurations - ~ShapelySection.mesh_section - ~ShapelySection.message_with_identiy - ~ShapelySection.msg - ~ShapelySection.numeric_fields - ~ShapelySection.observe_and_predict - ~ShapelySection.parent_configurations_cls - ~ShapelySection.plot_attributes - ~ShapelySection.plot_mesh - ~ShapelySection.pre_compile - ~ShapelySection.prediction_dataframe - ~ShapelySection.prediction_weights - ~ShapelySection.random_force_input - ~ShapelySection.record_stress - ~ShapelySection.resetLog - ~ShapelySection.resetSystemLogs - ~ShapelySection.reset_prediction - ~ShapelySection.score_data - ~ShapelySection.setattrs - ~ShapelySection.signals_attributes - ~ShapelySection.slack_notification - ~ShapelySection.slot_refs - ~ShapelySection.slots_attributes - ~ShapelySection.solve_fail - ~ShapelySection.solvers_attributes - ~ShapelySection.subclasses - ~ShapelySection.subcls_compile - ~ShapelySection.table_fields - ~ShapelySection.trace_attributes - ~ShapelySection.train_compare - ~ShapelySection.train_until_valid - ~ShapelySection.training_callback - ~ShapelySection.transients_attributes - ~ShapelySection.validate_class - ~ShapelySection.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ShapelySection.A - ~ShapelySection.Ao - ~ShapelySection.Ixx - ~ShapelySection.Ixy - ~ShapelySection.Iyy - ~ShapelySection.J - ~ShapelySection.as_dict - ~ShapelySection.attrs_fields - ~ShapelySection.basis - ~ShapelySection.cache_name - ~ShapelySection.cache_path - ~ShapelySection.classname - ~ShapelySection.displayname - ~ShapelySection.filename - ~ShapelySection.identity - ~ShapelySection.input_as_dict - ~ShapelySection.log_fmt - ~ShapelySection.log_level - ~ShapelySection.log_on - ~ShapelySection.log_silo - ~ShapelySection.logger - ~ShapelySection.max_margin - ~ShapelySection.max_rec_parm - ~ShapelySection.mesh_size - ~ShapelySection.meta_name - ~ShapelySection.meta_path - ~ShapelySection.min_mesh_area - ~ShapelySection.near_margin - ~ShapelySection.numeric_as_dict - ~ShapelySection.numeric_hash - ~ShapelySection.prediction_goal_error - ~ShapelySection.prediction_records - ~ShapelySection.save_threshold - ~ShapelySection.section_cache - ~ShapelySection.slack_webhook_url - ~ShapelySection.train_window - ~ShapelySection.trained - ~ShapelySection.unique_hash - ~ShapelySection.x_bounds - ~ShapelySection.y_bounds - ~ShapelySection.name - ~ShapelySection.shape - ~ShapelySection.coarse - ~ShapelySection.min_mesh_angle - ~ShapelySection.min_mesh_size - ~ShapelySection.goal_elements - ~ShapelySection.material - ~ShapelySection.prediction - ~ShapelySection.max_records - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.Triangle.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.Triangle.rst.txt deleted file mode 100644 index 2274da2..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.Triangle.rst.txt +++ /dev/null @@ -1,114 +0,0 @@ -engforge.eng.geometry.Triangle -============================== - -.. currentmodule:: engforge.eng.geometry - -.. autoclass:: Triangle - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Triangle.add_fields - ~Triangle.add_prediction_record - ~Triangle.calculate_stress - ~Triangle.change_all_log_lvl - ~Triangle.check_and_retrain - ~Triangle.check_out_of_domain - ~Triangle.check_ref_slot_type - ~Triangle.cls_compile - ~Triangle.collect_all_attributes - ~Triangle.collect_inst_attributes - ~Triangle.compile_classes - ~Triangle.copy_config_at_state - ~Triangle.critical - ~Triangle.debug - ~Triangle.difference - ~Triangle.display_results - ~Triangle.error - ~Triangle.estimate_stress - ~Triangle.extract_message - ~Triangle.filter - ~Triangle.go_through_configurations - ~Triangle.info - ~Triangle.input_attrs - ~Triangle.input_fields - ~Triangle.installSTDLogger - ~Triangle.internal_configurations - ~Triangle.message_with_identiy - ~Triangle.msg - ~Triangle.numeric_fields - ~Triangle.observe_and_predict - ~Triangle.parent_configurations_cls - ~Triangle.plot_attributes - ~Triangle.plot_mesh - ~Triangle.pre_compile - ~Triangle.prediction_dataframe - ~Triangle.prediction_weights - ~Triangle.resetLog - ~Triangle.resetSystemLogs - ~Triangle.score_data - ~Triangle.setattrs - ~Triangle.signals_attributes - ~Triangle.slack_notification - ~Triangle.slot_refs - ~Triangle.slots_attributes - ~Triangle.solvers_attributes - ~Triangle.subclasses - ~Triangle.subcls_compile - ~Triangle.table_fields - ~Triangle.trace_attributes - ~Triangle.train_compare - ~Triangle.training_callback - ~Triangle.transients_attributes - ~Triangle.validate_class - ~Triangle.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Triangle.A - ~Triangle.Ao - ~Triangle.Ixx - ~Triangle.Iyy - ~Triangle.J - ~Triangle.as_dict - ~Triangle.attrs_fields - ~Triangle.basis - ~Triangle.classname - ~Triangle.displayname - ~Triangle.filename - ~Triangle.identity - ~Triangle.input_as_dict - ~Triangle.log_fmt - ~Triangle.log_level - ~Triangle.log_on - ~Triangle.log_silo - ~Triangle.logger - ~Triangle.numeric_as_dict - ~Triangle.numeric_hash - ~Triangle.prediction_goal_error - ~Triangle.prediction_records - ~Triangle.slack_webhook_url - ~Triangle.train_window - ~Triangle.trained - ~Triangle.unique_hash - ~Triangle.x_bounds - ~Triangle.y_bounds - ~Triangle.b - ~Triangle.h - ~Triangle.name - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.calculate_stress.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.calculate_stress.rst.txt deleted file mode 100644 index 4a468e2..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.calculate_stress.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.eng.geometry.calculate\_stress -======================================= - -.. currentmodule:: engforge.eng.geometry - -.. autofunction:: calculate_stress \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.conver_np.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.conver_np.rst.txt deleted file mode 100644 index 2c49994..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.conver_np.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.eng.geometry.conver\_np -================================ - -.. currentmodule:: engforge.eng.geometry - -.. autofunction:: conver_np \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.get_mesh_size.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.get_mesh_size.rst.txt deleted file mode 100644 index 8621f43..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.get_mesh_size.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.eng.geometry.get\_mesh\_size -===================================== - -.. currentmodule:: engforge.eng.geometry - -.. autofunction:: get_mesh_size \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.rst.txt deleted file mode 100644 index 4368835..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.geometry.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -engforge.eng.geometry -===================== - -.. automodule:: engforge.eng.geometry - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - calculate_stress - conver_np - get_mesh_size - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - Circle - GeometryLog - HollowCircle - ParametricSpline - Profile2D - Rectangle - ShapelySection - Triangle - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.FlowInput.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.FlowInput.rst.txt deleted file mode 100644 index 786777b..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.FlowInput.rst.txt +++ /dev/null @@ -1,183 +0,0 @@ -engforge.eng.pipes.FlowInput -============================ - -.. currentmodule:: engforge.eng.pipes - -.. autoclass:: FlowInput - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~FlowInput.add_fields - ~FlowInput.add_segment - ~FlowInput.change_all_log_lvl - ~FlowInput.check_ref_slot_type - ~FlowInput.cls_all_attrs_fields - ~FlowInput.cls_all_property_keys - ~FlowInput.cls_all_property_labels - ~FlowInput.cls_compile - ~FlowInput.collect_all_attributes - ~FlowInput.collect_comp_refs - ~FlowInput.collect_dynamic_refs - ~FlowInput.collect_inst_attributes - ~FlowInput.collect_post_update_refs - ~FlowInput.collect_solver_refs - ~FlowInput.collect_update_refs - ~FlowInput.comp_references - ~FlowInput.compile_classes - ~FlowInput.copy_config_at_state - ~FlowInput.create_dynamic_matricies - ~FlowInput.create_feedthrough_matrix - ~FlowInput.create_input_matrix - ~FlowInput.create_output_constants - ~FlowInput.create_output_matrix - ~FlowInput.create_state_constants - ~FlowInput.create_state_matrix - ~FlowInput.critical - ~FlowInput.debug - ~FlowInput.determine_nearest_stationary_state - ~FlowInput.difference - ~FlowInput.error - ~FlowInput.extract_message - ~FlowInput.filter - ~FlowInput.format_columns - ~FlowInput.get_system_input_refs - ~FlowInput.go_through_configurations - ~FlowInput.info - ~FlowInput.input_attrs - ~FlowInput.input_fields - ~FlowInput.installSTDLogger - ~FlowInput.internal_components - ~FlowInput.internal_configurations - ~FlowInput.internal_references - ~FlowInput.internal_systems - ~FlowInput.internal_tabulations - ~FlowInput.linear_output - ~FlowInput.linear_step - ~FlowInput.locate - ~FlowInput.locate_ref - ~FlowInput.message_with_identiy - ~FlowInput.msg - ~FlowInput.nonlinear_output - ~FlowInput.nonlinear_step - ~FlowInput.numeric_fields - ~FlowInput.parent_configurations_cls - ~FlowInput.parse_run_kwargs - ~FlowInput.parse_simulation_input - ~FlowInput.plot_attributes - ~FlowInput.post_update - ~FlowInput.pre_compile - ~FlowInput.print_info - ~FlowInput.rate - ~FlowInput.rate_linear - ~FlowInput.rate_nonlinear - ~FlowInput.ref_dXdt - ~FlowInput.resetLog - ~FlowInput.resetSystemLogs - ~FlowInput.set_attr - ~FlowInput.set_time - ~FlowInput.setattrs - ~FlowInput.signals_attributes - ~FlowInput.slack_notification - ~FlowInput.slot_refs - ~FlowInput.slots_attributes - ~FlowInput.smart_split_dataframe - ~FlowInput.solvers_attributes - ~FlowInput.step - ~FlowInput.subclasses - ~FlowInput.subcls_compile - ~FlowInput.system_properties_classdef - ~FlowInput.system_references - ~FlowInput.table_fields - ~FlowInput.trace_attributes - ~FlowInput.transients_attributes - ~FlowInput.update - ~FlowInput.update_dynamics - ~FlowInput.update_feedthrough - ~FlowInput.update_input - ~FlowInput.update_output_constants - ~FlowInput.update_output_matrix - ~FlowInput.update_state - ~FlowInput.update_state_constants - ~FlowInput.validate_class - ~FlowInput.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FlowInput.Ut_ref - ~FlowInput.Xt_ref - ~FlowInput.Yt_ref - ~FlowInput.anything_changed - ~FlowInput.as_dict - ~FlowInput.attrs_fields - ~FlowInput.classname - ~FlowInput.dP_f - ~FlowInput.dP_p - ~FlowInput.dP_tot - ~FlowInput.dXtdt_ref - ~FlowInput.data_dict - ~FlowInput.dataframe_constants - ~FlowInput.dataframe_variants - ~FlowInput.displayname - ~FlowInput.dynamic_A - ~FlowInput.dynamic_B - ~FlowInput.dynamic_C - ~FlowInput.dynamic_D - ~FlowInput.dynamic_F - ~FlowInput.dynamic_K - ~FlowInput.dynamic_input - ~FlowInput.dynamic_input_vars - ~FlowInput.dynamic_output - ~FlowInput.dynamic_output_vars - ~FlowInput.dynamic_state - ~FlowInput.dynamic_state_vars - ~FlowInput.filename - ~FlowInput.identity - ~FlowInput.input_as_dict - ~FlowInput.last_context - ~FlowInput.log_fmt - ~FlowInput.log_level - ~FlowInput.log_on - ~FlowInput.log_silo - ~FlowInput.logger - ~FlowInput.nonlinear - ~FlowInput.numeric_as_dict - ~FlowInput.numeric_hash - ~FlowInput.plotable_variables - ~FlowInput.segments - ~FlowInput.skip_plot_vars - ~FlowInput.slack_webhook_url - ~FlowInput.static_A - ~FlowInput.static_B - ~FlowInput.static_C - ~FlowInput.static_D - ~FlowInput.static_F - ~FlowInput.static_K - ~FlowInput.sum_of_flows - ~FlowInput.system_id - ~FlowInput.time - ~FlowInput.unique_hash - ~FlowInput.update_interval - ~FlowInput.flow_in - ~FlowInput.x - ~FlowInput.y - ~FlowInput.z - ~FlowInput.parent - ~FlowInput.name - ~FlowInput.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.FlowNode.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.FlowNode.rst.txt deleted file mode 100644 index 39dd850..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.FlowNode.rst.txt +++ /dev/null @@ -1,182 +0,0 @@ -engforge.eng.pipes.FlowNode -=========================== - -.. currentmodule:: engforge.eng.pipes - -.. autoclass:: FlowNode - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~FlowNode.add_fields - ~FlowNode.add_segment - ~FlowNode.change_all_log_lvl - ~FlowNode.check_ref_slot_type - ~FlowNode.cls_all_attrs_fields - ~FlowNode.cls_all_property_keys - ~FlowNode.cls_all_property_labels - ~FlowNode.cls_compile - ~FlowNode.collect_all_attributes - ~FlowNode.collect_comp_refs - ~FlowNode.collect_dynamic_refs - ~FlowNode.collect_inst_attributes - ~FlowNode.collect_post_update_refs - ~FlowNode.collect_solver_refs - ~FlowNode.collect_update_refs - ~FlowNode.comp_references - ~FlowNode.compile_classes - ~FlowNode.copy_config_at_state - ~FlowNode.create_dynamic_matricies - ~FlowNode.create_feedthrough_matrix - ~FlowNode.create_input_matrix - ~FlowNode.create_output_constants - ~FlowNode.create_output_matrix - ~FlowNode.create_state_constants - ~FlowNode.create_state_matrix - ~FlowNode.critical - ~FlowNode.debug - ~FlowNode.determine_nearest_stationary_state - ~FlowNode.difference - ~FlowNode.error - ~FlowNode.extract_message - ~FlowNode.filter - ~FlowNode.format_columns - ~FlowNode.get_system_input_refs - ~FlowNode.go_through_configurations - ~FlowNode.info - ~FlowNode.input_attrs - ~FlowNode.input_fields - ~FlowNode.installSTDLogger - ~FlowNode.internal_components - ~FlowNode.internal_configurations - ~FlowNode.internal_references - ~FlowNode.internal_systems - ~FlowNode.internal_tabulations - ~FlowNode.linear_output - ~FlowNode.linear_step - ~FlowNode.locate - ~FlowNode.locate_ref - ~FlowNode.message_with_identiy - ~FlowNode.msg - ~FlowNode.nonlinear_output - ~FlowNode.nonlinear_step - ~FlowNode.numeric_fields - ~FlowNode.parent_configurations_cls - ~FlowNode.parse_run_kwargs - ~FlowNode.parse_simulation_input - ~FlowNode.plot_attributes - ~FlowNode.post_update - ~FlowNode.pre_compile - ~FlowNode.print_info - ~FlowNode.rate - ~FlowNode.rate_linear - ~FlowNode.rate_nonlinear - ~FlowNode.ref_dXdt - ~FlowNode.resetLog - ~FlowNode.resetSystemLogs - ~FlowNode.set_attr - ~FlowNode.set_time - ~FlowNode.setattrs - ~FlowNode.signals_attributes - ~FlowNode.slack_notification - ~FlowNode.slot_refs - ~FlowNode.slots_attributes - ~FlowNode.smart_split_dataframe - ~FlowNode.solvers_attributes - ~FlowNode.step - ~FlowNode.subclasses - ~FlowNode.subcls_compile - ~FlowNode.system_properties_classdef - ~FlowNode.system_references - ~FlowNode.table_fields - ~FlowNode.trace_attributes - ~FlowNode.transients_attributes - ~FlowNode.update - ~FlowNode.update_dynamics - ~FlowNode.update_feedthrough - ~FlowNode.update_input - ~FlowNode.update_output_constants - ~FlowNode.update_output_matrix - ~FlowNode.update_state - ~FlowNode.update_state_constants - ~FlowNode.validate_class - ~FlowNode.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~FlowNode.Ut_ref - ~FlowNode.Xt_ref - ~FlowNode.Yt_ref - ~FlowNode.anything_changed - ~FlowNode.as_dict - ~FlowNode.attrs_fields - ~FlowNode.classname - ~FlowNode.dP_f - ~FlowNode.dP_p - ~FlowNode.dP_tot - ~FlowNode.dXtdt_ref - ~FlowNode.data_dict - ~FlowNode.dataframe_constants - ~FlowNode.dataframe_variants - ~FlowNode.displayname - ~FlowNode.dynamic_A - ~FlowNode.dynamic_B - ~FlowNode.dynamic_C - ~FlowNode.dynamic_D - ~FlowNode.dynamic_F - ~FlowNode.dynamic_K - ~FlowNode.dynamic_input - ~FlowNode.dynamic_input_vars - ~FlowNode.dynamic_output - ~FlowNode.dynamic_output_vars - ~FlowNode.dynamic_state - ~FlowNode.dynamic_state_vars - ~FlowNode.filename - ~FlowNode.identity - ~FlowNode.input_as_dict - ~FlowNode.last_context - ~FlowNode.log_fmt - ~FlowNode.log_level - ~FlowNode.log_on - ~FlowNode.log_silo - ~FlowNode.logger - ~FlowNode.nonlinear - ~FlowNode.numeric_as_dict - ~FlowNode.numeric_hash - ~FlowNode.plotable_variables - ~FlowNode.segments - ~FlowNode.skip_plot_vars - ~FlowNode.slack_webhook_url - ~FlowNode.static_A - ~FlowNode.static_B - ~FlowNode.static_C - ~FlowNode.static_D - ~FlowNode.static_F - ~FlowNode.static_K - ~FlowNode.sum_of_flows - ~FlowNode.system_id - ~FlowNode.time - ~FlowNode.unique_hash - ~FlowNode.update_interval - ~FlowNode.x - ~FlowNode.y - ~FlowNode.z - ~FlowNode.parent - ~FlowNode.name - ~FlowNode.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.Pipe.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.Pipe.rst.txt deleted file mode 100644 index 56e8ff1..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.Pipe.rst.txt +++ /dev/null @@ -1,204 +0,0 @@ -engforge.eng.pipes.Pipe -======================= - -.. currentmodule:: engforge.eng.pipes - -.. autoclass:: Pipe - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Pipe.add_fields - ~Pipe.change_all_log_lvl - ~Pipe.check_ref_slot_type - ~Pipe.cls_all_attrs_fields - ~Pipe.cls_all_property_keys - ~Pipe.cls_all_property_labels - ~Pipe.cls_compile - ~Pipe.collect_all_attributes - ~Pipe.collect_comp_refs - ~Pipe.collect_dynamic_refs - ~Pipe.collect_inst_attributes - ~Pipe.collect_post_update_refs - ~Pipe.collect_solver_refs - ~Pipe.collect_update_refs - ~Pipe.comp_references - ~Pipe.compile_classes - ~Pipe.copy_config_at_state - ~Pipe.create_dynamic_matricies - ~Pipe.create_feedthrough_matrix - ~Pipe.create_input_matrix - ~Pipe.create_output_constants - ~Pipe.create_output_matrix - ~Pipe.create_state_constants - ~Pipe.create_state_matrix - ~Pipe.critical - ~Pipe.debug - ~Pipe.determine_nearest_stationary_state - ~Pipe.difference - ~Pipe.error - ~Pipe.extract_message - ~Pipe.filter - ~Pipe.format_columns - ~Pipe.get_system_input_refs - ~Pipe.go_through_configurations - ~Pipe.info - ~Pipe.input_attrs - ~Pipe.input_fields - ~Pipe.installSTDLogger - ~Pipe.internal_components - ~Pipe.internal_configurations - ~Pipe.internal_references - ~Pipe.internal_systems - ~Pipe.internal_tabulations - ~Pipe.linear_output - ~Pipe.linear_step - ~Pipe.locate - ~Pipe.locate_ref - ~Pipe.message_with_identiy - ~Pipe.msg - ~Pipe.nonlinear_output - ~Pipe.nonlinear_step - ~Pipe.numeric_fields - ~Pipe.parent_configurations_cls - ~Pipe.parse_run_kwargs - ~Pipe.parse_simulation_input - ~Pipe.plot_attributes - ~Pipe.post_update - ~Pipe.pre_compile - ~Pipe.print_info - ~Pipe.rate - ~Pipe.rate_linear - ~Pipe.rate_nonlinear - ~Pipe.ref_dXdt - ~Pipe.resetLog - ~Pipe.resetSystemLogs - ~Pipe.set_attr - ~Pipe.set_flow - ~Pipe.set_time - ~Pipe.setattrs - ~Pipe.signals_attributes - ~Pipe.slack_notification - ~Pipe.slot_refs - ~Pipe.slots_attributes - ~Pipe.smart_split_dataframe - ~Pipe.solvers_attributes - ~Pipe.step - ~Pipe.subclasses - ~Pipe.subcls_compile - ~Pipe.system_properties_classdef - ~Pipe.system_references - ~Pipe.table_fields - ~Pipe.trace_attributes - ~Pipe.transients_attributes - ~Pipe.update - ~Pipe.update_dynamics - ~Pipe.update_feedthrough - ~Pipe.update_input - ~Pipe.update_output_constants - ~Pipe.update_output_matrix - ~Pipe.update_state - ~Pipe.update_state_constants - ~Pipe.validate_class - ~Pipe.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Pipe.A - ~Pipe.C - ~Pipe.Fvec - ~Pipe.Kpipe - ~Pipe.L - ~Pipe.Lhz - ~Pipe.Lx - ~Pipe.Ly - ~Pipe.Lz - ~Pipe.Mf - ~Pipe.P - ~Pipe.Q - ~Pipe.T - ~Pipe.Ut_ref - ~Pipe.Xt_ref - ~Pipe.Yt_ref - ~Pipe.anything_changed - ~Pipe.as_dict - ~Pipe.attrs_fields - ~Pipe.classname - ~Pipe.dP_f - ~Pipe.dP_p - ~Pipe.dP_tot - ~Pipe.dXtdt_ref - ~Pipe.data_dict - ~Pipe.dataframe_constants - ~Pipe.dataframe_variants - ~Pipe.density - ~Pipe.displayname - ~Pipe.dynamic_A - ~Pipe.dynamic_B - ~Pipe.dynamic_C - ~Pipe.dynamic_D - ~Pipe.dynamic_F - ~Pipe.dynamic_K - ~Pipe.dynamic_input - ~Pipe.dynamic_input_vars - ~Pipe.dynamic_output - ~Pipe.dynamic_output_vars - ~Pipe.dynamic_state - ~Pipe.dynamic_state_vars - ~Pipe.enthalpy - ~Pipe.filename - ~Pipe.friction_factor - ~Pipe.identity - ~Pipe.inclination - ~Pipe.input_as_dict - ~Pipe.laminar_method - ~Pipe.last_context - ~Pipe.log_fmt - ~Pipe.log_level - ~Pipe.log_on - ~Pipe.log_silo - ~Pipe.logger - ~Pipe.nonlinear - ~Pipe.numeric_as_dict - ~Pipe.numeric_hash - ~Pipe.plotable_variables - ~Pipe.reynoldsNumber - ~Pipe.sign - ~Pipe.skip_plot_vars - ~Pipe.slack_webhook_url - ~Pipe.static_A - ~Pipe.static_B - ~Pipe.static_C - ~Pipe.static_D - ~Pipe.static_F - ~Pipe.static_K - ~Pipe.straight_method - ~Pipe.system_id - ~Pipe.time - ~Pipe.turbulent_method - ~Pipe.unique_hash - ~Pipe.update_interval - ~Pipe.viscosity - ~Pipe.roughness - ~Pipe.bend_radius - ~Pipe.D - ~Pipe.v - ~Pipe.parent - ~Pipe.name - ~Pipe.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.PipeFitting.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.PipeFitting.rst.txt deleted file mode 100644 index 3e94418..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.PipeFitting.rst.txt +++ /dev/null @@ -1,196 +0,0 @@ -engforge.eng.pipes.PipeFitting -============================== - -.. currentmodule:: engforge.eng.pipes - -.. autoclass:: PipeFitting - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~PipeFitting.add_fields - ~PipeFitting.add_segment - ~PipeFitting.change_all_log_lvl - ~PipeFitting.check_ref_slot_type - ~PipeFitting.cls_all_attrs_fields - ~PipeFitting.cls_all_property_keys - ~PipeFitting.cls_all_property_labels - ~PipeFitting.cls_compile - ~PipeFitting.collect_all_attributes - ~PipeFitting.collect_comp_refs - ~PipeFitting.collect_dynamic_refs - ~PipeFitting.collect_inst_attributes - ~PipeFitting.collect_post_update_refs - ~PipeFitting.collect_solver_refs - ~PipeFitting.collect_update_refs - ~PipeFitting.comp_references - ~PipeFitting.compile_classes - ~PipeFitting.copy_config_at_state - ~PipeFitting.create_dynamic_matricies - ~PipeFitting.create_feedthrough_matrix - ~PipeFitting.create_input_matrix - ~PipeFitting.create_output_constants - ~PipeFitting.create_output_matrix - ~PipeFitting.create_state_constants - ~PipeFitting.create_state_matrix - ~PipeFitting.critical - ~PipeFitting.debug - ~PipeFitting.determine_nearest_stationary_state - ~PipeFitting.difference - ~PipeFitting.error - ~PipeFitting.extract_message - ~PipeFitting.filter - ~PipeFitting.format_columns - ~PipeFitting.get_system_input_refs - ~PipeFitting.go_through_configurations - ~PipeFitting.info - ~PipeFitting.input_attrs - ~PipeFitting.input_fields - ~PipeFitting.installSTDLogger - ~PipeFitting.internal_components - ~PipeFitting.internal_configurations - ~PipeFitting.internal_references - ~PipeFitting.internal_systems - ~PipeFitting.internal_tabulations - ~PipeFitting.linear_output - ~PipeFitting.linear_step - ~PipeFitting.locate - ~PipeFitting.locate_ref - ~PipeFitting.message_with_identiy - ~PipeFitting.msg - ~PipeFitting.nonlinear_output - ~PipeFitting.nonlinear_step - ~PipeFitting.numeric_fields - ~PipeFitting.parent_configurations_cls - ~PipeFitting.parse_run_kwargs - ~PipeFitting.parse_simulation_input - ~PipeFitting.plot_attributes - ~PipeFitting.post_update - ~PipeFitting.pre_compile - ~PipeFitting.print_info - ~PipeFitting.rate - ~PipeFitting.rate_linear - ~PipeFitting.rate_nonlinear - ~PipeFitting.ref_dXdt - ~PipeFitting.resetLog - ~PipeFitting.resetSystemLogs - ~PipeFitting.set_attr - ~PipeFitting.set_flow - ~PipeFitting.set_time - ~PipeFitting.setattrs - ~PipeFitting.signals_attributes - ~PipeFitting.slack_notification - ~PipeFitting.slot_refs - ~PipeFitting.slots_attributes - ~PipeFitting.smart_split_dataframe - ~PipeFitting.solvers_attributes - ~PipeFitting.step - ~PipeFitting.subclasses - ~PipeFitting.subcls_compile - ~PipeFitting.system_properties_classdef - ~PipeFitting.system_references - ~PipeFitting.table_fields - ~PipeFitting.trace_attributes - ~PipeFitting.transients_attributes - ~PipeFitting.update - ~PipeFitting.update_dynamics - ~PipeFitting.update_feedthrough - ~PipeFitting.update_input - ~PipeFitting.update_output_constants - ~PipeFitting.update_output_matrix - ~PipeFitting.update_state - ~PipeFitting.update_state_constants - ~PipeFitting.validate_class - ~PipeFitting.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~PipeFitting.A - ~PipeFitting.C - ~PipeFitting.Fvec - ~PipeFitting.Mf - ~PipeFitting.P - ~PipeFitting.Q - ~PipeFitting.T - ~PipeFitting.Ut_ref - ~PipeFitting.Xt_ref - ~PipeFitting.Yt_ref - ~PipeFitting.anything_changed - ~PipeFitting.as_dict - ~PipeFitting.attrs_fields - ~PipeFitting.classname - ~PipeFitting.dP_f - ~PipeFitting.dP_p - ~PipeFitting.dP_tot - ~PipeFitting.dXtdt_ref - ~PipeFitting.data_dict - ~PipeFitting.dataframe_constants - ~PipeFitting.dataframe_variants - ~PipeFitting.density - ~PipeFitting.displayname - ~PipeFitting.dynamic_A - ~PipeFitting.dynamic_B - ~PipeFitting.dynamic_C - ~PipeFitting.dynamic_D - ~PipeFitting.dynamic_F - ~PipeFitting.dynamic_K - ~PipeFitting.dynamic_input - ~PipeFitting.dynamic_input_vars - ~PipeFitting.dynamic_output - ~PipeFitting.dynamic_output_vars - ~PipeFitting.dynamic_state - ~PipeFitting.dynamic_state_vars - ~PipeFitting.enthalpy - ~PipeFitting.filename - ~PipeFitting.identity - ~PipeFitting.input_as_dict - ~PipeFitting.last_context - ~PipeFitting.log_fmt - ~PipeFitting.log_level - ~PipeFitting.log_on - ~PipeFitting.log_silo - ~PipeFitting.logger - ~PipeFitting.nonlinear - ~PipeFitting.numeric_as_dict - ~PipeFitting.numeric_hash - ~PipeFitting.plotable_variables - ~PipeFitting.reynoldsNumber - ~PipeFitting.segments - ~PipeFitting.skip_plot_vars - ~PipeFitting.slack_webhook_url - ~PipeFitting.static_A - ~PipeFitting.static_B - ~PipeFitting.static_C - ~PipeFitting.static_D - ~PipeFitting.static_F - ~PipeFitting.static_K - ~PipeFitting.sum_of_flows - ~PipeFitting.system_id - ~PipeFitting.time - ~PipeFitting.unique_hash - ~PipeFitting.update_interval - ~PipeFitting.viscosity - ~PipeFitting.x - ~PipeFitting.y - ~PipeFitting.z - ~PipeFitting.D - ~PipeFitting.v - ~PipeFitting.parent - ~PipeFitting.name - ~PipeFitting.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.PipeFlow.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.PipeFlow.rst.txt deleted file mode 100644 index 3ce035b..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.PipeFlow.rst.txt +++ /dev/null @@ -1,190 +0,0 @@ -engforge.eng.pipes.PipeFlow -=========================== - -.. currentmodule:: engforge.eng.pipes - -.. autoclass:: PipeFlow - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~PipeFlow.add_fields - ~PipeFlow.change_all_log_lvl - ~PipeFlow.check_ref_slot_type - ~PipeFlow.cls_all_attrs_fields - ~PipeFlow.cls_all_property_keys - ~PipeFlow.cls_all_property_labels - ~PipeFlow.cls_compile - ~PipeFlow.collect_all_attributes - ~PipeFlow.collect_comp_refs - ~PipeFlow.collect_dynamic_refs - ~PipeFlow.collect_inst_attributes - ~PipeFlow.collect_post_update_refs - ~PipeFlow.collect_solver_refs - ~PipeFlow.collect_update_refs - ~PipeFlow.comp_references - ~PipeFlow.compile_classes - ~PipeFlow.copy_config_at_state - ~PipeFlow.create_dynamic_matricies - ~PipeFlow.create_feedthrough_matrix - ~PipeFlow.create_input_matrix - ~PipeFlow.create_output_constants - ~PipeFlow.create_output_matrix - ~PipeFlow.create_state_constants - ~PipeFlow.create_state_matrix - ~PipeFlow.critical - ~PipeFlow.debug - ~PipeFlow.determine_nearest_stationary_state - ~PipeFlow.difference - ~PipeFlow.error - ~PipeFlow.extract_message - ~PipeFlow.filter - ~PipeFlow.format_columns - ~PipeFlow.get_system_input_refs - ~PipeFlow.go_through_configurations - ~PipeFlow.info - ~PipeFlow.input_attrs - ~PipeFlow.input_fields - ~PipeFlow.installSTDLogger - ~PipeFlow.internal_components - ~PipeFlow.internal_configurations - ~PipeFlow.internal_references - ~PipeFlow.internal_systems - ~PipeFlow.internal_tabulations - ~PipeFlow.linear_output - ~PipeFlow.linear_step - ~PipeFlow.locate - ~PipeFlow.locate_ref - ~PipeFlow.message_with_identiy - ~PipeFlow.msg - ~PipeFlow.nonlinear_output - ~PipeFlow.nonlinear_step - ~PipeFlow.numeric_fields - ~PipeFlow.parent_configurations_cls - ~PipeFlow.parse_run_kwargs - ~PipeFlow.parse_simulation_input - ~PipeFlow.plot_attributes - ~PipeFlow.post_update - ~PipeFlow.pre_compile - ~PipeFlow.print_info - ~PipeFlow.rate - ~PipeFlow.rate_linear - ~PipeFlow.rate_nonlinear - ~PipeFlow.ref_dXdt - ~PipeFlow.resetLog - ~PipeFlow.resetSystemLogs - ~PipeFlow.set_attr - ~PipeFlow.set_flow - ~PipeFlow.set_time - ~PipeFlow.setattrs - ~PipeFlow.signals_attributes - ~PipeFlow.slack_notification - ~PipeFlow.slot_refs - ~PipeFlow.slots_attributes - ~PipeFlow.smart_split_dataframe - ~PipeFlow.solvers_attributes - ~PipeFlow.step - ~PipeFlow.subclasses - ~PipeFlow.subcls_compile - ~PipeFlow.system_properties_classdef - ~PipeFlow.system_references - ~PipeFlow.table_fields - ~PipeFlow.trace_attributes - ~PipeFlow.transients_attributes - ~PipeFlow.update - ~PipeFlow.update_dynamics - ~PipeFlow.update_feedthrough - ~PipeFlow.update_input - ~PipeFlow.update_output_constants - ~PipeFlow.update_output_matrix - ~PipeFlow.update_state - ~PipeFlow.update_state_constants - ~PipeFlow.validate_class - ~PipeFlow.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~PipeFlow.A - ~PipeFlow.C - ~PipeFlow.Fvec - ~PipeFlow.Mf - ~PipeFlow.P - ~PipeFlow.Q - ~PipeFlow.T - ~PipeFlow.Ut_ref - ~PipeFlow.Xt_ref - ~PipeFlow.Yt_ref - ~PipeFlow.anything_changed - ~PipeFlow.as_dict - ~PipeFlow.attrs_fields - ~PipeFlow.classname - ~PipeFlow.dP_f - ~PipeFlow.dP_p - ~PipeFlow.dP_tot - ~PipeFlow.dXtdt_ref - ~PipeFlow.data_dict - ~PipeFlow.dataframe_constants - ~PipeFlow.dataframe_variants - ~PipeFlow.density - ~PipeFlow.displayname - ~PipeFlow.dynamic_A - ~PipeFlow.dynamic_B - ~PipeFlow.dynamic_C - ~PipeFlow.dynamic_D - ~PipeFlow.dynamic_F - ~PipeFlow.dynamic_K - ~PipeFlow.dynamic_input - ~PipeFlow.dynamic_input_vars - ~PipeFlow.dynamic_output - ~PipeFlow.dynamic_output_vars - ~PipeFlow.dynamic_state - ~PipeFlow.dynamic_state_vars - ~PipeFlow.enthalpy - ~PipeFlow.filename - ~PipeFlow.identity - ~PipeFlow.input_as_dict - ~PipeFlow.last_context - ~PipeFlow.log_fmt - ~PipeFlow.log_level - ~PipeFlow.log_on - ~PipeFlow.log_silo - ~PipeFlow.logger - ~PipeFlow.nonlinear - ~PipeFlow.numeric_as_dict - ~PipeFlow.numeric_hash - ~PipeFlow.plotable_variables - ~PipeFlow.reynoldsNumber - ~PipeFlow.skip_plot_vars - ~PipeFlow.slack_webhook_url - ~PipeFlow.static_A - ~PipeFlow.static_B - ~PipeFlow.static_C - ~PipeFlow.static_D - ~PipeFlow.static_F - ~PipeFlow.static_K - ~PipeFlow.system_id - ~PipeFlow.time - ~PipeFlow.unique_hash - ~PipeFlow.update_interval - ~PipeFlow.viscosity - ~PipeFlow.D - ~PipeFlow.v - ~PipeFlow.parent - ~PipeFlow.name - ~PipeFlow.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.PipeLog.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.PipeLog.rst.txt deleted file mode 100644 index 999a8c3..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.PipeLog.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.eng.pipes.PipeLog -========================== - -.. currentmodule:: engforge.eng.pipes - -.. autoclass:: PipeLog - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~PipeLog.add_fields - ~PipeLog.change_all_log_lvl - ~PipeLog.critical - ~PipeLog.debug - ~PipeLog.error - ~PipeLog.extract_message - ~PipeLog.filter - ~PipeLog.info - ~PipeLog.installSTDLogger - ~PipeLog.message_with_identiy - ~PipeLog.msg - ~PipeLog.resetLog - ~PipeLog.resetSystemLogs - ~PipeLog.slack_notification - ~PipeLog.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~PipeLog.identity - ~PipeLog.log_fmt - ~PipeLog.log_level - ~PipeLog.log_on - ~PipeLog.logger - ~PipeLog.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.PipeNode.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.PipeNode.rst.txt deleted file mode 100644 index 1a5e8cf..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.PipeNode.rst.txt +++ /dev/null @@ -1,179 +0,0 @@ -engforge.eng.pipes.PipeNode -=========================== - -.. currentmodule:: engforge.eng.pipes - -.. autoclass:: PipeNode - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~PipeNode.add_fields - ~PipeNode.add_segment - ~PipeNode.change_all_log_lvl - ~PipeNode.check_ref_slot_type - ~PipeNode.cls_all_attrs_fields - ~PipeNode.cls_all_property_keys - ~PipeNode.cls_all_property_labels - ~PipeNode.cls_compile - ~PipeNode.collect_all_attributes - ~PipeNode.collect_comp_refs - ~PipeNode.collect_dynamic_refs - ~PipeNode.collect_inst_attributes - ~PipeNode.collect_post_update_refs - ~PipeNode.collect_solver_refs - ~PipeNode.collect_update_refs - ~PipeNode.comp_references - ~PipeNode.compile_classes - ~PipeNode.copy_config_at_state - ~PipeNode.create_dynamic_matricies - ~PipeNode.create_feedthrough_matrix - ~PipeNode.create_input_matrix - ~PipeNode.create_output_constants - ~PipeNode.create_output_matrix - ~PipeNode.create_state_constants - ~PipeNode.create_state_matrix - ~PipeNode.critical - ~PipeNode.debug - ~PipeNode.determine_nearest_stationary_state - ~PipeNode.difference - ~PipeNode.error - ~PipeNode.extract_message - ~PipeNode.filter - ~PipeNode.format_columns - ~PipeNode.get_system_input_refs - ~PipeNode.go_through_configurations - ~PipeNode.info - ~PipeNode.input_attrs - ~PipeNode.input_fields - ~PipeNode.installSTDLogger - ~PipeNode.internal_components - ~PipeNode.internal_configurations - ~PipeNode.internal_references - ~PipeNode.internal_systems - ~PipeNode.internal_tabulations - ~PipeNode.linear_output - ~PipeNode.linear_step - ~PipeNode.locate - ~PipeNode.locate_ref - ~PipeNode.message_with_identiy - ~PipeNode.msg - ~PipeNode.nonlinear_output - ~PipeNode.nonlinear_step - ~PipeNode.numeric_fields - ~PipeNode.parent_configurations_cls - ~PipeNode.parse_run_kwargs - ~PipeNode.parse_simulation_input - ~PipeNode.plot_attributes - ~PipeNode.post_update - ~PipeNode.pre_compile - ~PipeNode.print_info - ~PipeNode.rate - ~PipeNode.rate_linear - ~PipeNode.rate_nonlinear - ~PipeNode.ref_dXdt - ~PipeNode.resetLog - ~PipeNode.resetSystemLogs - ~PipeNode.set_attr - ~PipeNode.set_time - ~PipeNode.setattrs - ~PipeNode.signals_attributes - ~PipeNode.slack_notification - ~PipeNode.slot_refs - ~PipeNode.slots_attributes - ~PipeNode.smart_split_dataframe - ~PipeNode.solvers_attributes - ~PipeNode.step - ~PipeNode.subclasses - ~PipeNode.subcls_compile - ~PipeNode.system_properties_classdef - ~PipeNode.system_references - ~PipeNode.table_fields - ~PipeNode.trace_attributes - ~PipeNode.transients_attributes - ~PipeNode.update - ~PipeNode.update_dynamics - ~PipeNode.update_feedthrough - ~PipeNode.update_input - ~PipeNode.update_output_constants - ~PipeNode.update_output_matrix - ~PipeNode.update_state - ~PipeNode.update_state_constants - ~PipeNode.validate_class - ~PipeNode.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~PipeNode.Ut_ref - ~PipeNode.Xt_ref - ~PipeNode.Yt_ref - ~PipeNode.anything_changed - ~PipeNode.as_dict - ~PipeNode.attrs_fields - ~PipeNode.classname - ~PipeNode.dXtdt_ref - ~PipeNode.data_dict - ~PipeNode.dataframe_constants - ~PipeNode.dataframe_variants - ~PipeNode.displayname - ~PipeNode.dynamic_A - ~PipeNode.dynamic_B - ~PipeNode.dynamic_C - ~PipeNode.dynamic_D - ~PipeNode.dynamic_F - ~PipeNode.dynamic_K - ~PipeNode.dynamic_input - ~PipeNode.dynamic_input_vars - ~PipeNode.dynamic_output - ~PipeNode.dynamic_output_vars - ~PipeNode.dynamic_state - ~PipeNode.dynamic_state_vars - ~PipeNode.filename - ~PipeNode.identity - ~PipeNode.input_as_dict - ~PipeNode.last_context - ~PipeNode.log_fmt - ~PipeNode.log_level - ~PipeNode.log_on - ~PipeNode.log_silo - ~PipeNode.logger - ~PipeNode.nonlinear - ~PipeNode.numeric_as_dict - ~PipeNode.numeric_hash - ~PipeNode.plotable_variables - ~PipeNode.segments - ~PipeNode.skip_plot_vars - ~PipeNode.slack_webhook_url - ~PipeNode.static_A - ~PipeNode.static_B - ~PipeNode.static_C - ~PipeNode.static_D - ~PipeNode.static_F - ~PipeNode.static_K - ~PipeNode.sum_of_flows - ~PipeNode.system_id - ~PipeNode.time - ~PipeNode.unique_hash - ~PipeNode.update_interval - ~PipeNode.x - ~PipeNode.y - ~PipeNode.z - ~PipeNode.parent - ~PipeNode.name - ~PipeNode.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.PipeSystem.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.PipeSystem.rst.txt deleted file mode 100644 index 6563532..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.PipeSystem.rst.txt +++ /dev/null @@ -1,199 +0,0 @@ -engforge.eng.pipes.PipeSystem -============================= - -.. currentmodule:: engforge.eng.pipes - -.. autoclass:: PipeSystem - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~PipeSystem.add_fields - ~PipeSystem.add_to_graph - ~PipeSystem.assemble_solvers - ~PipeSystem.change_all_log_lvl - ~PipeSystem.check_ref_slot_type - ~PipeSystem.clone - ~PipeSystem.cls_all_attrs_fields - ~PipeSystem.cls_all_property_keys - ~PipeSystem.cls_all_property_labels - ~PipeSystem.cls_compile - ~PipeSystem.collect_all_attributes - ~PipeSystem.collect_comp_refs - ~PipeSystem.collect_dynamic_refs - ~PipeSystem.collect_inst_attributes - ~PipeSystem.collect_post_update_refs - ~PipeSystem.collect_solver_refs - ~PipeSystem.collect_update_refs - ~PipeSystem.comp_references - ~PipeSystem.compile_classes - ~PipeSystem.copy_config_at_state - ~PipeSystem.create_dynamic_matricies - ~PipeSystem.create_feedthrough_matrix - ~PipeSystem.create_graph_from_pipe_or_node - ~PipeSystem.create_input_matrix - ~PipeSystem.create_output_constants - ~PipeSystem.create_output_matrix - ~PipeSystem.create_state_constants - ~PipeSystem.create_state_matrix - ~PipeSystem.critical - ~PipeSystem.debug - ~PipeSystem.determine_nearest_stationary_state - ~PipeSystem.difference - ~PipeSystem.draw - ~PipeSystem.error - ~PipeSystem.eval - ~PipeSystem.execute - ~PipeSystem.extract_message - ~PipeSystem.filter - ~PipeSystem.format_columns - ~PipeSystem.get_system_input_refs - ~PipeSystem.go_through_configurations - ~PipeSystem.info - ~PipeSystem.input_attrs - ~PipeSystem.input_fields - ~PipeSystem.installSTDLogger - ~PipeSystem.internal_components - ~PipeSystem.internal_configurations - ~PipeSystem.internal_references - ~PipeSystem.internal_systems - ~PipeSystem.internal_tabulations - ~PipeSystem.linear_output - ~PipeSystem.linear_step - ~PipeSystem.locate - ~PipeSystem.locate_ref - ~PipeSystem.make_plots - ~PipeSystem.mark_all_comps_changed - ~PipeSystem.message_with_identiy - ~PipeSystem.msg - ~PipeSystem.nonlinear_output - ~PipeSystem.nonlinear_step - ~PipeSystem.numeric_fields - ~PipeSystem.parent_configurations_cls - ~PipeSystem.parse_run_kwargs - ~PipeSystem.parse_simulation_input - ~PipeSystem.plot_attributes - ~PipeSystem.post_run_callback - ~PipeSystem.post_update - ~PipeSystem.pre_compile - ~PipeSystem.pre_run_callback - ~PipeSystem.print_info - ~PipeSystem.rate - ~PipeSystem.rate_linear - ~PipeSystem.rate_nonlinear - ~PipeSystem.ref_dXdt - ~PipeSystem.resetLog - ~PipeSystem.resetSystemLogs - ~PipeSystem.run - ~PipeSystem.run_internal_systems - ~PipeSystem.set_attr - ~PipeSystem.set_time - ~PipeSystem.setattrs - ~PipeSystem.setup_global_dynamics - ~PipeSystem.signals_attributes - ~PipeSystem.sim_matrix - ~PipeSystem.simulate - ~PipeSystem.slack_notification - ~PipeSystem.slot_refs - ~PipeSystem.slots_attributes - ~PipeSystem.smart_split_dataframe - ~PipeSystem.solver - ~PipeSystem.solver_vars - ~PipeSystem.solvers_attributes - ~PipeSystem.step - ~PipeSystem.subclasses - ~PipeSystem.subcls_compile - ~PipeSystem.system_properties_classdef - ~PipeSystem.system_references - ~PipeSystem.table_fields - ~PipeSystem.trace_attributes - ~PipeSystem.transients_attributes - ~PipeSystem.update - ~PipeSystem.update_dynamics - ~PipeSystem.update_feedthrough - ~PipeSystem.update_input - ~PipeSystem.update_output_constants - ~PipeSystem.update_output_matrix - ~PipeSystem.update_state - ~PipeSystem.update_state_constants - ~PipeSystem.validate_class - ~PipeSystem.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~PipeSystem.F_keyword_order - ~PipeSystem.Ut_ref - ~PipeSystem.Xt_ref - ~PipeSystem.Yt_ref - ~PipeSystem.anything_changed - ~PipeSystem.as_dict - ~PipeSystem.attrs_fields - ~PipeSystem.classname - ~PipeSystem.converged - ~PipeSystem.dXtdt_ref - ~PipeSystem.dataframe_constants - ~PipeSystem.dataframe_variants - ~PipeSystem.displayname - ~PipeSystem.dynamic_A - ~PipeSystem.dynamic_B - ~PipeSystem.dynamic_C - ~PipeSystem.dynamic_D - ~PipeSystem.dynamic_F - ~PipeSystem.dynamic_K - ~PipeSystem.dynamic_input - ~PipeSystem.dynamic_input_vars - ~PipeSystem.dynamic_output - ~PipeSystem.dynamic_output_vars - ~PipeSystem.dynamic_state - ~PipeSystem.dynamic_state_vars - ~PipeSystem.filename - ~PipeSystem.identity - ~PipeSystem.input_as_dict - ~PipeSystem.last_context - ~PipeSystem.log_fmt - ~PipeSystem.log_level - ~PipeSystem.log_on - ~PipeSystem.log_silo - ~PipeSystem.logger - ~PipeSystem.nodes - ~PipeSystem.nonlinear - ~PipeSystem.numeric_as_dict - ~PipeSystem.numeric_hash - ~PipeSystem.pipes - ~PipeSystem.plotable_variables - ~PipeSystem.run_id - ~PipeSystem.skip_plot_vars - ~PipeSystem.slack_webhook_url - ~PipeSystem.solved - ~PipeSystem.static_A - ~PipeSystem.static_B - ~PipeSystem.static_C - ~PipeSystem.static_D - ~PipeSystem.static_F - ~PipeSystem.static_K - ~PipeSystem.stored_plots - ~PipeSystem.system_id - ~PipeSystem.time - ~PipeSystem.unique_hash - ~PipeSystem.update_interval - ~PipeSystem.graph - ~PipeSystem.items - ~PipeSystem.parent - ~PipeSystem.name - ~PipeSystem.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.Pump.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.Pump.rst.txt deleted file mode 100644 index e56af55..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.Pump.rst.txt +++ /dev/null @@ -1,178 +0,0 @@ -engforge.eng.pipes.Pump -======================= - -.. currentmodule:: engforge.eng.pipes - -.. autoclass:: Pump - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Pump.add_fields - ~Pump.change_all_log_lvl - ~Pump.check_ref_slot_type - ~Pump.cls_all_attrs_fields - ~Pump.cls_all_property_keys - ~Pump.cls_all_property_labels - ~Pump.cls_compile - ~Pump.collect_all_attributes - ~Pump.collect_comp_refs - ~Pump.collect_dynamic_refs - ~Pump.collect_inst_attributes - ~Pump.collect_post_update_refs - ~Pump.collect_solver_refs - ~Pump.collect_update_refs - ~Pump.comp_references - ~Pump.compile_classes - ~Pump.copy_config_at_state - ~Pump.create_dynamic_matricies - ~Pump.create_feedthrough_matrix - ~Pump.create_input_matrix - ~Pump.create_output_constants - ~Pump.create_output_matrix - ~Pump.create_state_constants - ~Pump.create_state_matrix - ~Pump.critical - ~Pump.dPressure - ~Pump.debug - ~Pump.determine_nearest_stationary_state - ~Pump.difference - ~Pump.error - ~Pump.extract_message - ~Pump.filter - ~Pump.format_columns - ~Pump.get_system_input_refs - ~Pump.go_through_configurations - ~Pump.info - ~Pump.input_attrs - ~Pump.input_fields - ~Pump.installSTDLogger - ~Pump.internal_components - ~Pump.internal_configurations - ~Pump.internal_references - ~Pump.internal_systems - ~Pump.internal_tabulations - ~Pump.linear_output - ~Pump.linear_step - ~Pump.locate - ~Pump.locate_ref - ~Pump.message_with_identiy - ~Pump.msg - ~Pump.nonlinear_output - ~Pump.nonlinear_step - ~Pump.numeric_fields - ~Pump.parent_configurations_cls - ~Pump.parse_run_kwargs - ~Pump.parse_simulation_input - ~Pump.plot_attributes - ~Pump.post_update - ~Pump.power - ~Pump.pre_compile - ~Pump.print_info - ~Pump.rate - ~Pump.rate_linear - ~Pump.rate_nonlinear - ~Pump.ref_dXdt - ~Pump.resetLog - ~Pump.resetSystemLogs - ~Pump.set_attr - ~Pump.set_time - ~Pump.setattrs - ~Pump.signals_attributes - ~Pump.slack_notification - ~Pump.slot_refs - ~Pump.slots_attributes - ~Pump.smart_split_dataframe - ~Pump.solvers_attributes - ~Pump.step - ~Pump.subclasses - ~Pump.subcls_compile - ~Pump.system_properties_classdef - ~Pump.system_references - ~Pump.table_fields - ~Pump.trace_attributes - ~Pump.transients_attributes - ~Pump.update - ~Pump.update_dynamics - ~Pump.update_feedthrough - ~Pump.update_input - ~Pump.update_output_constants - ~Pump.update_output_matrix - ~Pump.update_state - ~Pump.update_state_constants - ~Pump.validate_class - ~Pump.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Pump.Ut_ref - ~Pump.Xt_ref - ~Pump.Yt_ref - ~Pump.anything_changed - ~Pump.as_dict - ~Pump.attrs_fields - ~Pump.classname - ~Pump.dXtdt_ref - ~Pump.data_dict - ~Pump.dataframe_constants - ~Pump.dataframe_variants - ~Pump.design_flow_curve - ~Pump.displayname - ~Pump.dynamic_A - ~Pump.dynamic_B - ~Pump.dynamic_C - ~Pump.dynamic_D - ~Pump.dynamic_F - ~Pump.dynamic_K - ~Pump.dynamic_input - ~Pump.dynamic_input_vars - ~Pump.dynamic_output - ~Pump.dynamic_output_vars - ~Pump.dynamic_state - ~Pump.dynamic_state_vars - ~Pump.filename - ~Pump.identity - ~Pump.input_as_dict - ~Pump.last_context - ~Pump.log_fmt - ~Pump.log_level - ~Pump.log_on - ~Pump.log_silo - ~Pump.logger - ~Pump.nonlinear - ~Pump.numeric_as_dict - ~Pump.numeric_hash - ~Pump.plotable_variables - ~Pump.skip_plot_vars - ~Pump.slack_webhook_url - ~Pump.static_A - ~Pump.static_B - ~Pump.static_C - ~Pump.static_D - ~Pump.static_F - ~Pump.static_K - ~Pump.system_id - ~Pump.time - ~Pump.unique_hash - ~Pump.update_interval - ~Pump.max_flow - ~Pump.max_pressure - ~Pump.parent - ~Pump.name - ~Pump.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.rst.txt deleted file mode 100644 index 45182b4..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.pipes.rst.txt +++ /dev/null @@ -1,40 +0,0 @@ -engforge.eng.pipes -================== - -.. automodule:: engforge.eng.pipes - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - FlowInput - FlowNode - Pipe - PipeFitting - PipeFlow - PipeLog - PipeNode - PipeSystem - Pump - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.prediction.PredictionMixin.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.prediction.PredictionMixin.rst.txt deleted file mode 100644 index 2943bfd..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.prediction.PredictionMixin.rst.txt +++ /dev/null @@ -1,43 +0,0 @@ -engforge.eng.prediction.PredictionMixin -======================================= - -.. currentmodule:: engforge.eng.prediction - -.. autoclass:: PredictionMixin - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~PredictionMixin.add_prediction_record - ~PredictionMixin.check_and_retrain - ~PredictionMixin.check_out_of_domain - ~PredictionMixin.observe_and_predict - ~PredictionMixin.prediction_dataframe - ~PredictionMixin.prediction_weights - ~PredictionMixin.score_data - ~PredictionMixin.train_compare - ~PredictionMixin.training_callback - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~PredictionMixin.basis - ~PredictionMixin.prediction_goal_error - ~PredictionMixin.prediction_records - ~PredictionMixin.train_window - ~PredictionMixin.trained - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.prediction.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.prediction.rst.txt deleted file mode 100644 index 55c6878..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.prediction.rst.txt +++ /dev/null @@ -1,32 +0,0 @@ -engforge.eng.prediction -======================= - -.. automodule:: engforge.eng.prediction - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - PredictionMixin - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.rst.txt deleted file mode 100644 index 5f7fc09..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.rst.txt +++ /dev/null @@ -1,38 +0,0 @@ -engforge.eng -============ - -.. automodule:: engforge.eng - - - - - - - - - - - - - - - - - - - -.. autosummary:: - :toctree: - :template: custom-module-template.rst - :recursive: - - costs - fluid_material - geometry - pipes - prediction - solid_materials - structure - structure_beams - thermodynamics - diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.ANSI_4130.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.ANSI_4130.rst.txt deleted file mode 100644 index ffd7b7d..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.ANSI_4130.rst.txt +++ /dev/null @@ -1,114 +0,0 @@ -engforge.eng.solid\_materials.ANSI\_4130 -======================================== - -.. currentmodule:: engforge.eng.solid_materials - -.. autoclass:: ANSI_4130 - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~ANSI_4130.add_fields - ~ANSI_4130.change_all_log_lvl - ~ANSI_4130.check_ref_slot_type - ~ANSI_4130.cls_compile - ~ANSI_4130.collect_all_attributes - ~ANSI_4130.collect_inst_attributes - ~ANSI_4130.compile_classes - ~ANSI_4130.copy_config_at_state - ~ANSI_4130.critical - ~ANSI_4130.debug - ~ANSI_4130.difference - ~ANSI_4130.error - ~ANSI_4130.extract_message - ~ANSI_4130.filter - ~ANSI_4130.go_through_configurations - ~ANSI_4130.info - ~ANSI_4130.input_attrs - ~ANSI_4130.input_fields - ~ANSI_4130.installSTDLogger - ~ANSI_4130.internal_configurations - ~ANSI_4130.message_with_identiy - ~ANSI_4130.msg - ~ANSI_4130.numeric_fields - ~ANSI_4130.parent_configurations_cls - ~ANSI_4130.plot_attributes - ~ANSI_4130.pre_compile - ~ANSI_4130.resetLog - ~ANSI_4130.resetSystemLogs - ~ANSI_4130.setattrs - ~ANSI_4130.signals_attributes - ~ANSI_4130.slack_notification - ~ANSI_4130.slot_refs - ~ANSI_4130.slots_attributes - ~ANSI_4130.solvers_attributes - ~ANSI_4130.subclasses - ~ANSI_4130.subcls_compile - ~ANSI_4130.table_fields - ~ANSI_4130.trace_attributes - ~ANSI_4130.transients_attributes - ~ANSI_4130.validate_class - ~ANSI_4130.von_mises_stress_max - ~ANSI_4130.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ANSI_4130.E - ~ANSI_4130.G - ~ANSI_4130.allowable_stress - ~ANSI_4130.as_dict - ~ANSI_4130.attrs_fields - ~ANSI_4130.classname - ~ANSI_4130.color - ~ANSI_4130.displayname - ~ANSI_4130.filename - ~ANSI_4130.identity - ~ANSI_4130.input_as_dict - ~ANSI_4130.log_fmt - ~ANSI_4130.log_level - ~ANSI_4130.log_on - ~ANSI_4130.log_silo - ~ANSI_4130.logger - ~ANSI_4130.nu - ~ANSI_4130.numeric_as_dict - ~ANSI_4130.numeric_hash - ~ANSI_4130.rho - ~ANSI_4130.shear_modulus - ~ANSI_4130.slack_webhook_url - ~ANSI_4130.ultimate_stress - ~ANSI_4130.unique_hash - ~ANSI_4130.unique_id - ~ANSI_4130.yield_stress - ~ANSI_4130.name - ~ANSI_4130.density - ~ANSI_4130.elastic_modulus - ~ANSI_4130.yield_strength - ~ANSI_4130.tensile_strength_ultimate - ~ANSI_4130.poissons_ratio - ~ANSI_4130.melting_point - ~ANSI_4130.maxium_service_temp - ~ANSI_4130.thermal_conductivity - ~ANSI_4130.specific_heat - ~ANSI_4130.thermal_expansion - ~ANSI_4130.electrical_resistitivity - ~ANSI_4130.cost_per_kg - ~ANSI_4130.in_shear_modulus - ~ANSI_4130.hardness - ~ANSI_4130.izod - ~ANSI_4130.factor_of_saftey - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.ANSI_4340.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.ANSI_4340.rst.txt deleted file mode 100644 index 3fb91ab..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.ANSI_4340.rst.txt +++ /dev/null @@ -1,114 +0,0 @@ -engforge.eng.solid\_materials.ANSI\_4340 -======================================== - -.. currentmodule:: engforge.eng.solid_materials - -.. autoclass:: ANSI_4340 - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~ANSI_4340.add_fields - ~ANSI_4340.change_all_log_lvl - ~ANSI_4340.check_ref_slot_type - ~ANSI_4340.cls_compile - ~ANSI_4340.collect_all_attributes - ~ANSI_4340.collect_inst_attributes - ~ANSI_4340.compile_classes - ~ANSI_4340.copy_config_at_state - ~ANSI_4340.critical - ~ANSI_4340.debug - ~ANSI_4340.difference - ~ANSI_4340.error - ~ANSI_4340.extract_message - ~ANSI_4340.filter - ~ANSI_4340.go_through_configurations - ~ANSI_4340.info - ~ANSI_4340.input_attrs - ~ANSI_4340.input_fields - ~ANSI_4340.installSTDLogger - ~ANSI_4340.internal_configurations - ~ANSI_4340.message_with_identiy - ~ANSI_4340.msg - ~ANSI_4340.numeric_fields - ~ANSI_4340.parent_configurations_cls - ~ANSI_4340.plot_attributes - ~ANSI_4340.pre_compile - ~ANSI_4340.resetLog - ~ANSI_4340.resetSystemLogs - ~ANSI_4340.setattrs - ~ANSI_4340.signals_attributes - ~ANSI_4340.slack_notification - ~ANSI_4340.slot_refs - ~ANSI_4340.slots_attributes - ~ANSI_4340.solvers_attributes - ~ANSI_4340.subclasses - ~ANSI_4340.subcls_compile - ~ANSI_4340.table_fields - ~ANSI_4340.trace_attributes - ~ANSI_4340.transients_attributes - ~ANSI_4340.validate_class - ~ANSI_4340.von_mises_stress_max - ~ANSI_4340.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ANSI_4340.E - ~ANSI_4340.G - ~ANSI_4340.allowable_stress - ~ANSI_4340.as_dict - ~ANSI_4340.attrs_fields - ~ANSI_4340.classname - ~ANSI_4340.color - ~ANSI_4340.displayname - ~ANSI_4340.filename - ~ANSI_4340.identity - ~ANSI_4340.input_as_dict - ~ANSI_4340.log_fmt - ~ANSI_4340.log_level - ~ANSI_4340.log_on - ~ANSI_4340.log_silo - ~ANSI_4340.logger - ~ANSI_4340.nu - ~ANSI_4340.numeric_as_dict - ~ANSI_4340.numeric_hash - ~ANSI_4340.rho - ~ANSI_4340.shear_modulus - ~ANSI_4340.slack_webhook_url - ~ANSI_4340.ultimate_stress - ~ANSI_4340.unique_hash - ~ANSI_4340.unique_id - ~ANSI_4340.yield_stress - ~ANSI_4340.name - ~ANSI_4340.density - ~ANSI_4340.elastic_modulus - ~ANSI_4340.yield_strength - ~ANSI_4340.tensile_strength_ultimate - ~ANSI_4340.poissons_ratio - ~ANSI_4340.melting_point - ~ANSI_4340.maxium_service_temp - ~ANSI_4340.thermal_conductivity - ~ANSI_4340.specific_heat - ~ANSI_4340.thermal_expansion - ~ANSI_4340.electrical_resistitivity - ~ANSI_4340.cost_per_kg - ~ANSI_4340.in_shear_modulus - ~ANSI_4340.hardness - ~ANSI_4340.izod - ~ANSI_4340.factor_of_saftey - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.Aluminum.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.Aluminum.rst.txt deleted file mode 100644 index fc80f75..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.Aluminum.rst.txt +++ /dev/null @@ -1,114 +0,0 @@ -engforge.eng.solid\_materials.Aluminum -====================================== - -.. currentmodule:: engforge.eng.solid_materials - -.. autoclass:: Aluminum - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Aluminum.add_fields - ~Aluminum.change_all_log_lvl - ~Aluminum.check_ref_slot_type - ~Aluminum.cls_compile - ~Aluminum.collect_all_attributes - ~Aluminum.collect_inst_attributes - ~Aluminum.compile_classes - ~Aluminum.copy_config_at_state - ~Aluminum.critical - ~Aluminum.debug - ~Aluminum.difference - ~Aluminum.error - ~Aluminum.extract_message - ~Aluminum.filter - ~Aluminum.go_through_configurations - ~Aluminum.info - ~Aluminum.input_attrs - ~Aluminum.input_fields - ~Aluminum.installSTDLogger - ~Aluminum.internal_configurations - ~Aluminum.message_with_identiy - ~Aluminum.msg - ~Aluminum.numeric_fields - ~Aluminum.parent_configurations_cls - ~Aluminum.plot_attributes - ~Aluminum.pre_compile - ~Aluminum.resetLog - ~Aluminum.resetSystemLogs - ~Aluminum.setattrs - ~Aluminum.signals_attributes - ~Aluminum.slack_notification - ~Aluminum.slot_refs - ~Aluminum.slots_attributes - ~Aluminum.solvers_attributes - ~Aluminum.subclasses - ~Aluminum.subcls_compile - ~Aluminum.table_fields - ~Aluminum.trace_attributes - ~Aluminum.transients_attributes - ~Aluminum.validate_class - ~Aluminum.von_mises_stress_max - ~Aluminum.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Aluminum.E - ~Aluminum.G - ~Aluminum.allowable_stress - ~Aluminum.as_dict - ~Aluminum.attrs_fields - ~Aluminum.classname - ~Aluminum.color - ~Aluminum.displayname - ~Aluminum.filename - ~Aluminum.identity - ~Aluminum.input_as_dict - ~Aluminum.log_fmt - ~Aluminum.log_level - ~Aluminum.log_on - ~Aluminum.log_silo - ~Aluminum.logger - ~Aluminum.nu - ~Aluminum.numeric_as_dict - ~Aluminum.numeric_hash - ~Aluminum.rho - ~Aluminum.shear_modulus - ~Aluminum.slack_webhook_url - ~Aluminum.ultimate_stress - ~Aluminum.unique_hash - ~Aluminum.unique_id - ~Aluminum.yield_stress - ~Aluminum.name - ~Aluminum.density - ~Aluminum.elastic_modulus - ~Aluminum.yield_strength - ~Aluminum.tensile_strength_ultimate - ~Aluminum.poissons_ratio - ~Aluminum.melting_point - ~Aluminum.maxium_service_temp - ~Aluminum.thermal_conductivity - ~Aluminum.specific_heat - ~Aluminum.thermal_expansion - ~Aluminum.electrical_resistitivity - ~Aluminum.cost_per_kg - ~Aluminum.in_shear_modulus - ~Aluminum.hardness - ~Aluminum.izod - ~Aluminum.factor_of_saftey - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.CarbonFiber.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.CarbonFiber.rst.txt deleted file mode 100644 index ea79d90..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.CarbonFiber.rst.txt +++ /dev/null @@ -1,114 +0,0 @@ -engforge.eng.solid\_materials.CarbonFiber -========================================= - -.. currentmodule:: engforge.eng.solid_materials - -.. autoclass:: CarbonFiber - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~CarbonFiber.add_fields - ~CarbonFiber.change_all_log_lvl - ~CarbonFiber.check_ref_slot_type - ~CarbonFiber.cls_compile - ~CarbonFiber.collect_all_attributes - ~CarbonFiber.collect_inst_attributes - ~CarbonFiber.compile_classes - ~CarbonFiber.copy_config_at_state - ~CarbonFiber.critical - ~CarbonFiber.debug - ~CarbonFiber.difference - ~CarbonFiber.error - ~CarbonFiber.extract_message - ~CarbonFiber.filter - ~CarbonFiber.go_through_configurations - ~CarbonFiber.info - ~CarbonFiber.input_attrs - ~CarbonFiber.input_fields - ~CarbonFiber.installSTDLogger - ~CarbonFiber.internal_configurations - ~CarbonFiber.message_with_identiy - ~CarbonFiber.msg - ~CarbonFiber.numeric_fields - ~CarbonFiber.parent_configurations_cls - ~CarbonFiber.plot_attributes - ~CarbonFiber.pre_compile - ~CarbonFiber.resetLog - ~CarbonFiber.resetSystemLogs - ~CarbonFiber.setattrs - ~CarbonFiber.signals_attributes - ~CarbonFiber.slack_notification - ~CarbonFiber.slot_refs - ~CarbonFiber.slots_attributes - ~CarbonFiber.solvers_attributes - ~CarbonFiber.subclasses - ~CarbonFiber.subcls_compile - ~CarbonFiber.table_fields - ~CarbonFiber.trace_attributes - ~CarbonFiber.transients_attributes - ~CarbonFiber.validate_class - ~CarbonFiber.von_mises_stress_max - ~CarbonFiber.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~CarbonFiber.E - ~CarbonFiber.G - ~CarbonFiber.allowable_stress - ~CarbonFiber.as_dict - ~CarbonFiber.attrs_fields - ~CarbonFiber.classname - ~CarbonFiber.color - ~CarbonFiber.displayname - ~CarbonFiber.filename - ~CarbonFiber.identity - ~CarbonFiber.input_as_dict - ~CarbonFiber.log_fmt - ~CarbonFiber.log_level - ~CarbonFiber.log_on - ~CarbonFiber.log_silo - ~CarbonFiber.logger - ~CarbonFiber.nu - ~CarbonFiber.numeric_as_dict - ~CarbonFiber.numeric_hash - ~CarbonFiber.rho - ~CarbonFiber.shear_modulus - ~CarbonFiber.slack_webhook_url - ~CarbonFiber.ultimate_stress - ~CarbonFiber.unique_hash - ~CarbonFiber.unique_id - ~CarbonFiber.yield_stress - ~CarbonFiber.name - ~CarbonFiber.density - ~CarbonFiber.elastic_modulus - ~CarbonFiber.yield_strength - ~CarbonFiber.tensile_strength_ultimate - ~CarbonFiber.poissons_ratio - ~CarbonFiber.melting_point - ~CarbonFiber.maxium_service_temp - ~CarbonFiber.thermal_conductivity - ~CarbonFiber.specific_heat - ~CarbonFiber.thermal_expansion - ~CarbonFiber.electrical_resistitivity - ~CarbonFiber.cost_per_kg - ~CarbonFiber.in_shear_modulus - ~CarbonFiber.hardness - ~CarbonFiber.izod - ~CarbonFiber.factor_of_saftey - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.Concrete.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.Concrete.rst.txt deleted file mode 100644 index 2099d65..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.Concrete.rst.txt +++ /dev/null @@ -1,114 +0,0 @@ -engforge.eng.solid\_materials.Concrete -====================================== - -.. currentmodule:: engforge.eng.solid_materials - -.. autoclass:: Concrete - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Concrete.add_fields - ~Concrete.change_all_log_lvl - ~Concrete.check_ref_slot_type - ~Concrete.cls_compile - ~Concrete.collect_all_attributes - ~Concrete.collect_inst_attributes - ~Concrete.compile_classes - ~Concrete.copy_config_at_state - ~Concrete.critical - ~Concrete.debug - ~Concrete.difference - ~Concrete.error - ~Concrete.extract_message - ~Concrete.filter - ~Concrete.go_through_configurations - ~Concrete.info - ~Concrete.input_attrs - ~Concrete.input_fields - ~Concrete.installSTDLogger - ~Concrete.internal_configurations - ~Concrete.message_with_identiy - ~Concrete.msg - ~Concrete.numeric_fields - ~Concrete.parent_configurations_cls - ~Concrete.plot_attributes - ~Concrete.pre_compile - ~Concrete.resetLog - ~Concrete.resetSystemLogs - ~Concrete.setattrs - ~Concrete.signals_attributes - ~Concrete.slack_notification - ~Concrete.slot_refs - ~Concrete.slots_attributes - ~Concrete.solvers_attributes - ~Concrete.subclasses - ~Concrete.subcls_compile - ~Concrete.table_fields - ~Concrete.trace_attributes - ~Concrete.transients_attributes - ~Concrete.validate_class - ~Concrete.von_mises_stress_max - ~Concrete.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Concrete.E - ~Concrete.G - ~Concrete.allowable_stress - ~Concrete.as_dict - ~Concrete.attrs_fields - ~Concrete.classname - ~Concrete.color - ~Concrete.displayname - ~Concrete.filename - ~Concrete.identity - ~Concrete.input_as_dict - ~Concrete.log_fmt - ~Concrete.log_level - ~Concrete.log_on - ~Concrete.log_silo - ~Concrete.logger - ~Concrete.nu - ~Concrete.numeric_as_dict - ~Concrete.numeric_hash - ~Concrete.rho - ~Concrete.shear_modulus - ~Concrete.slack_webhook_url - ~Concrete.ultimate_stress - ~Concrete.unique_hash - ~Concrete.unique_id - ~Concrete.yield_stress - ~Concrete.name - ~Concrete.density - ~Concrete.elastic_modulus - ~Concrete.yield_strength - ~Concrete.tensile_strength_ultimate - ~Concrete.poissons_ratio - ~Concrete.melting_point - ~Concrete.maxium_service_temp - ~Concrete.thermal_conductivity - ~Concrete.specific_heat - ~Concrete.thermal_expansion - ~Concrete.electrical_resistitivity - ~Concrete.cost_per_kg - ~Concrete.in_shear_modulus - ~Concrete.hardness - ~Concrete.izod - ~Concrete.factor_of_saftey - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.DrySoil.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.DrySoil.rst.txt deleted file mode 100644 index 14726fa..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.DrySoil.rst.txt +++ /dev/null @@ -1,114 +0,0 @@ -engforge.eng.solid\_materials.DrySoil -===================================== - -.. currentmodule:: engforge.eng.solid_materials - -.. autoclass:: DrySoil - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~DrySoil.add_fields - ~DrySoil.change_all_log_lvl - ~DrySoil.check_ref_slot_type - ~DrySoil.cls_compile - ~DrySoil.collect_all_attributes - ~DrySoil.collect_inst_attributes - ~DrySoil.compile_classes - ~DrySoil.copy_config_at_state - ~DrySoil.critical - ~DrySoil.debug - ~DrySoil.difference - ~DrySoil.error - ~DrySoil.extract_message - ~DrySoil.filter - ~DrySoil.go_through_configurations - ~DrySoil.info - ~DrySoil.input_attrs - ~DrySoil.input_fields - ~DrySoil.installSTDLogger - ~DrySoil.internal_configurations - ~DrySoil.message_with_identiy - ~DrySoil.msg - ~DrySoil.numeric_fields - ~DrySoil.parent_configurations_cls - ~DrySoil.plot_attributes - ~DrySoil.pre_compile - ~DrySoil.resetLog - ~DrySoil.resetSystemLogs - ~DrySoil.setattrs - ~DrySoil.signals_attributes - ~DrySoil.slack_notification - ~DrySoil.slot_refs - ~DrySoil.slots_attributes - ~DrySoil.solvers_attributes - ~DrySoil.subclasses - ~DrySoil.subcls_compile - ~DrySoil.table_fields - ~DrySoil.trace_attributes - ~DrySoil.transients_attributes - ~DrySoil.validate_class - ~DrySoil.von_mises_stress_max - ~DrySoil.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~DrySoil.E - ~DrySoil.G - ~DrySoil.allowable_stress - ~DrySoil.as_dict - ~DrySoil.attrs_fields - ~DrySoil.classname - ~DrySoil.color - ~DrySoil.displayname - ~DrySoil.filename - ~DrySoil.identity - ~DrySoil.input_as_dict - ~DrySoil.log_fmt - ~DrySoil.log_level - ~DrySoil.log_on - ~DrySoil.log_silo - ~DrySoil.logger - ~DrySoil.nu - ~DrySoil.numeric_as_dict - ~DrySoil.numeric_hash - ~DrySoil.rho - ~DrySoil.shear_modulus - ~DrySoil.slack_webhook_url - ~DrySoil.ultimate_stress - ~DrySoil.unique_hash - ~DrySoil.unique_id - ~DrySoil.yield_stress - ~DrySoil.name - ~DrySoil.density - ~DrySoil.elastic_modulus - ~DrySoil.yield_strength - ~DrySoil.tensile_strength_ultimate - ~DrySoil.poissons_ratio - ~DrySoil.melting_point - ~DrySoil.maxium_service_temp - ~DrySoil.thermal_conductivity - ~DrySoil.specific_heat - ~DrySoil.thermal_expansion - ~DrySoil.electrical_resistitivity - ~DrySoil.cost_per_kg - ~DrySoil.in_shear_modulus - ~DrySoil.hardness - ~DrySoil.izod - ~DrySoil.factor_of_saftey - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.Rock.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.Rock.rst.txt deleted file mode 100644 index 99337be..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.Rock.rst.txt +++ /dev/null @@ -1,114 +0,0 @@ -engforge.eng.solid\_materials.Rock -================================== - -.. currentmodule:: engforge.eng.solid_materials - -.. autoclass:: Rock - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Rock.add_fields - ~Rock.change_all_log_lvl - ~Rock.check_ref_slot_type - ~Rock.cls_compile - ~Rock.collect_all_attributes - ~Rock.collect_inst_attributes - ~Rock.compile_classes - ~Rock.copy_config_at_state - ~Rock.critical - ~Rock.debug - ~Rock.difference - ~Rock.error - ~Rock.extract_message - ~Rock.filter - ~Rock.go_through_configurations - ~Rock.info - ~Rock.input_attrs - ~Rock.input_fields - ~Rock.installSTDLogger - ~Rock.internal_configurations - ~Rock.message_with_identiy - ~Rock.msg - ~Rock.numeric_fields - ~Rock.parent_configurations_cls - ~Rock.plot_attributes - ~Rock.pre_compile - ~Rock.resetLog - ~Rock.resetSystemLogs - ~Rock.setattrs - ~Rock.signals_attributes - ~Rock.slack_notification - ~Rock.slot_refs - ~Rock.slots_attributes - ~Rock.solvers_attributes - ~Rock.subclasses - ~Rock.subcls_compile - ~Rock.table_fields - ~Rock.trace_attributes - ~Rock.transients_attributes - ~Rock.validate_class - ~Rock.von_mises_stress_max - ~Rock.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Rock.E - ~Rock.G - ~Rock.allowable_stress - ~Rock.as_dict - ~Rock.attrs_fields - ~Rock.classname - ~Rock.color - ~Rock.displayname - ~Rock.filename - ~Rock.identity - ~Rock.input_as_dict - ~Rock.log_fmt - ~Rock.log_level - ~Rock.log_on - ~Rock.log_silo - ~Rock.logger - ~Rock.nu - ~Rock.numeric_as_dict - ~Rock.numeric_hash - ~Rock.rho - ~Rock.shear_modulus - ~Rock.slack_webhook_url - ~Rock.ultimate_stress - ~Rock.unique_hash - ~Rock.unique_id - ~Rock.yield_stress - ~Rock.name - ~Rock.density - ~Rock.elastic_modulus - ~Rock.yield_strength - ~Rock.tensile_strength_ultimate - ~Rock.poissons_ratio - ~Rock.melting_point - ~Rock.maxium_service_temp - ~Rock.thermal_conductivity - ~Rock.specific_heat - ~Rock.thermal_expansion - ~Rock.electrical_resistitivity - ~Rock.cost_per_kg - ~Rock.in_shear_modulus - ~Rock.hardness - ~Rock.izod - ~Rock.factor_of_saftey - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.Rubber.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.Rubber.rst.txt deleted file mode 100644 index 55bf48b..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.Rubber.rst.txt +++ /dev/null @@ -1,114 +0,0 @@ -engforge.eng.solid\_materials.Rubber -==================================== - -.. currentmodule:: engforge.eng.solid_materials - -.. autoclass:: Rubber - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Rubber.add_fields - ~Rubber.change_all_log_lvl - ~Rubber.check_ref_slot_type - ~Rubber.cls_compile - ~Rubber.collect_all_attributes - ~Rubber.collect_inst_attributes - ~Rubber.compile_classes - ~Rubber.copy_config_at_state - ~Rubber.critical - ~Rubber.debug - ~Rubber.difference - ~Rubber.error - ~Rubber.extract_message - ~Rubber.filter - ~Rubber.go_through_configurations - ~Rubber.info - ~Rubber.input_attrs - ~Rubber.input_fields - ~Rubber.installSTDLogger - ~Rubber.internal_configurations - ~Rubber.message_with_identiy - ~Rubber.msg - ~Rubber.numeric_fields - ~Rubber.parent_configurations_cls - ~Rubber.plot_attributes - ~Rubber.pre_compile - ~Rubber.resetLog - ~Rubber.resetSystemLogs - ~Rubber.setattrs - ~Rubber.signals_attributes - ~Rubber.slack_notification - ~Rubber.slot_refs - ~Rubber.slots_attributes - ~Rubber.solvers_attributes - ~Rubber.subclasses - ~Rubber.subcls_compile - ~Rubber.table_fields - ~Rubber.trace_attributes - ~Rubber.transients_attributes - ~Rubber.validate_class - ~Rubber.von_mises_stress_max - ~Rubber.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Rubber.E - ~Rubber.G - ~Rubber.allowable_stress - ~Rubber.as_dict - ~Rubber.attrs_fields - ~Rubber.classname - ~Rubber.color - ~Rubber.displayname - ~Rubber.filename - ~Rubber.identity - ~Rubber.input_as_dict - ~Rubber.log_fmt - ~Rubber.log_level - ~Rubber.log_on - ~Rubber.log_silo - ~Rubber.logger - ~Rubber.nu - ~Rubber.numeric_as_dict - ~Rubber.numeric_hash - ~Rubber.rho - ~Rubber.shear_modulus - ~Rubber.slack_webhook_url - ~Rubber.ultimate_stress - ~Rubber.unique_hash - ~Rubber.unique_id - ~Rubber.yield_stress - ~Rubber.name - ~Rubber.density - ~Rubber.elastic_modulus - ~Rubber.yield_strength - ~Rubber.tensile_strength_ultimate - ~Rubber.poissons_ratio - ~Rubber.melting_point - ~Rubber.maxium_service_temp - ~Rubber.thermal_conductivity - ~Rubber.specific_heat - ~Rubber.thermal_expansion - ~Rubber.electrical_resistitivity - ~Rubber.cost_per_kg - ~Rubber.in_shear_modulus - ~Rubber.hardness - ~Rubber.izod - ~Rubber.factor_of_saftey - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.SS_316.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.SS_316.rst.txt deleted file mode 100644 index 73996fc..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.SS_316.rst.txt +++ /dev/null @@ -1,114 +0,0 @@ -engforge.eng.solid\_materials.SS\_316 -===================================== - -.. currentmodule:: engforge.eng.solid_materials - -.. autoclass:: SS_316 - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~SS_316.add_fields - ~SS_316.change_all_log_lvl - ~SS_316.check_ref_slot_type - ~SS_316.cls_compile - ~SS_316.collect_all_attributes - ~SS_316.collect_inst_attributes - ~SS_316.compile_classes - ~SS_316.copy_config_at_state - ~SS_316.critical - ~SS_316.debug - ~SS_316.difference - ~SS_316.error - ~SS_316.extract_message - ~SS_316.filter - ~SS_316.go_through_configurations - ~SS_316.info - ~SS_316.input_attrs - ~SS_316.input_fields - ~SS_316.installSTDLogger - ~SS_316.internal_configurations - ~SS_316.message_with_identiy - ~SS_316.msg - ~SS_316.numeric_fields - ~SS_316.parent_configurations_cls - ~SS_316.plot_attributes - ~SS_316.pre_compile - ~SS_316.resetLog - ~SS_316.resetSystemLogs - ~SS_316.setattrs - ~SS_316.signals_attributes - ~SS_316.slack_notification - ~SS_316.slot_refs - ~SS_316.slots_attributes - ~SS_316.solvers_attributes - ~SS_316.subclasses - ~SS_316.subcls_compile - ~SS_316.table_fields - ~SS_316.trace_attributes - ~SS_316.transients_attributes - ~SS_316.validate_class - ~SS_316.von_mises_stress_max - ~SS_316.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~SS_316.E - ~SS_316.G - ~SS_316.allowable_stress - ~SS_316.as_dict - ~SS_316.attrs_fields - ~SS_316.classname - ~SS_316.color - ~SS_316.displayname - ~SS_316.filename - ~SS_316.identity - ~SS_316.input_as_dict - ~SS_316.log_fmt - ~SS_316.log_level - ~SS_316.log_on - ~SS_316.log_silo - ~SS_316.logger - ~SS_316.nu - ~SS_316.numeric_as_dict - ~SS_316.numeric_hash - ~SS_316.rho - ~SS_316.shear_modulus - ~SS_316.slack_webhook_url - ~SS_316.ultimate_stress - ~SS_316.unique_hash - ~SS_316.unique_id - ~SS_316.yield_stress - ~SS_316.name - ~SS_316.density - ~SS_316.elastic_modulus - ~SS_316.yield_strength - ~SS_316.tensile_strength_ultimate - ~SS_316.poissons_ratio - ~SS_316.melting_point - ~SS_316.maxium_service_temp - ~SS_316.thermal_conductivity - ~SS_316.specific_heat - ~SS_316.thermal_expansion - ~SS_316.electrical_resistitivity - ~SS_316.cost_per_kg - ~SS_316.in_shear_modulus - ~SS_316.hardness - ~SS_316.izod - ~SS_316.factor_of_saftey - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.SolidMaterial.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.SolidMaterial.rst.txt deleted file mode 100644 index fe93233..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.SolidMaterial.rst.txt +++ /dev/null @@ -1,114 +0,0 @@ -engforge.eng.solid\_materials.SolidMaterial -=========================================== - -.. currentmodule:: engforge.eng.solid_materials - -.. autoclass:: SolidMaterial - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~SolidMaterial.add_fields - ~SolidMaterial.change_all_log_lvl - ~SolidMaterial.check_ref_slot_type - ~SolidMaterial.cls_compile - ~SolidMaterial.collect_all_attributes - ~SolidMaterial.collect_inst_attributes - ~SolidMaterial.compile_classes - ~SolidMaterial.copy_config_at_state - ~SolidMaterial.critical - ~SolidMaterial.debug - ~SolidMaterial.difference - ~SolidMaterial.error - ~SolidMaterial.extract_message - ~SolidMaterial.filter - ~SolidMaterial.go_through_configurations - ~SolidMaterial.info - ~SolidMaterial.input_attrs - ~SolidMaterial.input_fields - ~SolidMaterial.installSTDLogger - ~SolidMaterial.internal_configurations - ~SolidMaterial.message_with_identiy - ~SolidMaterial.msg - ~SolidMaterial.numeric_fields - ~SolidMaterial.parent_configurations_cls - ~SolidMaterial.plot_attributes - ~SolidMaterial.pre_compile - ~SolidMaterial.resetLog - ~SolidMaterial.resetSystemLogs - ~SolidMaterial.setattrs - ~SolidMaterial.signals_attributes - ~SolidMaterial.slack_notification - ~SolidMaterial.slot_refs - ~SolidMaterial.slots_attributes - ~SolidMaterial.solvers_attributes - ~SolidMaterial.subclasses - ~SolidMaterial.subcls_compile - ~SolidMaterial.table_fields - ~SolidMaterial.trace_attributes - ~SolidMaterial.transients_attributes - ~SolidMaterial.validate_class - ~SolidMaterial.von_mises_stress_max - ~SolidMaterial.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~SolidMaterial.E - ~SolidMaterial.G - ~SolidMaterial.allowable_stress - ~SolidMaterial.as_dict - ~SolidMaterial.attrs_fields - ~SolidMaterial.classname - ~SolidMaterial.color - ~SolidMaterial.displayname - ~SolidMaterial.filename - ~SolidMaterial.identity - ~SolidMaterial.input_as_dict - ~SolidMaterial.log_fmt - ~SolidMaterial.log_level - ~SolidMaterial.log_on - ~SolidMaterial.log_silo - ~SolidMaterial.logger - ~SolidMaterial.nu - ~SolidMaterial.numeric_as_dict - ~SolidMaterial.numeric_hash - ~SolidMaterial.rho - ~SolidMaterial.shear_modulus - ~SolidMaterial.slack_webhook_url - ~SolidMaterial.ultimate_stress - ~SolidMaterial.unique_hash - ~SolidMaterial.unique_id - ~SolidMaterial.yield_stress - ~SolidMaterial.name - ~SolidMaterial.density - ~SolidMaterial.elastic_modulus - ~SolidMaterial.in_shear_modulus - ~SolidMaterial.yield_strength - ~SolidMaterial.tensile_strength_ultimate - ~SolidMaterial.hardness - ~SolidMaterial.izod - ~SolidMaterial.poissons_ratio - ~SolidMaterial.melting_point - ~SolidMaterial.maxium_service_temp - ~SolidMaterial.thermal_conductivity - ~SolidMaterial.specific_heat - ~SolidMaterial.thermal_expansion - ~SolidMaterial.electrical_resistitivity - ~SolidMaterial.cost_per_kg - ~SolidMaterial.factor_of_saftey - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.WetSoil.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.WetSoil.rst.txt deleted file mode 100644 index 8d4d6b8..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.WetSoil.rst.txt +++ /dev/null @@ -1,114 +0,0 @@ -engforge.eng.solid\_materials.WetSoil -===================================== - -.. currentmodule:: engforge.eng.solid_materials - -.. autoclass:: WetSoil - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~WetSoil.add_fields - ~WetSoil.change_all_log_lvl - ~WetSoil.check_ref_slot_type - ~WetSoil.cls_compile - ~WetSoil.collect_all_attributes - ~WetSoil.collect_inst_attributes - ~WetSoil.compile_classes - ~WetSoil.copy_config_at_state - ~WetSoil.critical - ~WetSoil.debug - ~WetSoil.difference - ~WetSoil.error - ~WetSoil.extract_message - ~WetSoil.filter - ~WetSoil.go_through_configurations - ~WetSoil.info - ~WetSoil.input_attrs - ~WetSoil.input_fields - ~WetSoil.installSTDLogger - ~WetSoil.internal_configurations - ~WetSoil.message_with_identiy - ~WetSoil.msg - ~WetSoil.numeric_fields - ~WetSoil.parent_configurations_cls - ~WetSoil.plot_attributes - ~WetSoil.pre_compile - ~WetSoil.resetLog - ~WetSoil.resetSystemLogs - ~WetSoil.setattrs - ~WetSoil.signals_attributes - ~WetSoil.slack_notification - ~WetSoil.slot_refs - ~WetSoil.slots_attributes - ~WetSoil.solvers_attributes - ~WetSoil.subclasses - ~WetSoil.subcls_compile - ~WetSoil.table_fields - ~WetSoil.trace_attributes - ~WetSoil.transients_attributes - ~WetSoil.validate_class - ~WetSoil.von_mises_stress_max - ~WetSoil.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~WetSoil.E - ~WetSoil.G - ~WetSoil.allowable_stress - ~WetSoil.as_dict - ~WetSoil.attrs_fields - ~WetSoil.classname - ~WetSoil.color - ~WetSoil.displayname - ~WetSoil.filename - ~WetSoil.identity - ~WetSoil.input_as_dict - ~WetSoil.log_fmt - ~WetSoil.log_level - ~WetSoil.log_on - ~WetSoil.log_silo - ~WetSoil.logger - ~WetSoil.nu - ~WetSoil.numeric_as_dict - ~WetSoil.numeric_hash - ~WetSoil.rho - ~WetSoil.shear_modulus - ~WetSoil.slack_webhook_url - ~WetSoil.ultimate_stress - ~WetSoil.unique_hash - ~WetSoil.unique_id - ~WetSoil.yield_stress - ~WetSoil.name - ~WetSoil.density - ~WetSoil.elastic_modulus - ~WetSoil.yield_strength - ~WetSoil.tensile_strength_ultimate - ~WetSoil.poissons_ratio - ~WetSoil.melting_point - ~WetSoil.maxium_service_temp - ~WetSoil.thermal_conductivity - ~WetSoil.specific_heat - ~WetSoil.thermal_expansion - ~WetSoil.electrical_resistitivity - ~WetSoil.cost_per_kg - ~WetSoil.in_shear_modulus - ~WetSoil.hardness - ~WetSoil.izod - ~WetSoil.factor_of_saftey - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.ih.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.ih.rst.txt deleted file mode 100644 index 77af855..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.ih.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.eng.solid\_materials.ih -================================ - -.. currentmodule:: engforge.eng.solid_materials - -.. autofunction:: ih \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.random_color.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.random_color.rst.txt deleted file mode 100644 index 72e02f0..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.random_color.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.eng.solid\_materials.random\_color -=========================================== - -.. currentmodule:: engforge.eng.solid_materials - -.. autofunction:: random_color \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.rst.txt deleted file mode 100644 index bb02665..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.solid_materials.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -engforge.eng.solid\_materials -============================= - -.. automodule:: engforge.eng.solid_materials - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - ih - random_color - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - ANSI_4130 - ANSI_4340 - Aluminum - CarbonFiber - Concrete - DrySoil - Rock - Rubber - SS_316 - SolidMaterial - WetSoil - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.structure_beams.Beam.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.structure_beams.Beam.rst.txt deleted file mode 100644 index 9fef51d..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.structure_beams.Beam.rst.txt +++ /dev/null @@ -1,291 +0,0 @@ -engforge.eng.structure\_beams.Beam -================================== - -.. currentmodule:: engforge.eng.structure_beams - -.. autoclass:: Beam - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Beam.add_fields - ~Beam.all_categories - ~Beam.apply_distributed_load - ~Beam.apply_gravity_force - ~Beam.apply_gravity_force_distribution - ~Beam.apply_local_distributed_load - ~Beam.apply_local_pt_load - ~Beam.apply_pt_load - ~Beam.calculate_item_cost - ~Beam.calculate_stress - ~Beam.change_all_log_lvl - ~Beam.check_ref_slot_type - ~Beam.class_cost_properties - ~Beam.cls_all_attrs_fields - ~Beam.cls_all_property_keys - ~Beam.cls_all_property_labels - ~Beam.cls_compile - ~Beam.collect_all_attributes - ~Beam.collect_comp_refs - ~Beam.collect_dynamic_refs - ~Beam.collect_inst_attributes - ~Beam.collect_post_update_refs - ~Beam.collect_solver_refs - ~Beam.collect_update_refs - ~Beam.comp_references - ~Beam.compile_classes - ~Beam.copy_config_at_state - ~Beam.cost_categories_at_term - ~Beam.costs_at_term - ~Beam.create_dynamic_matricies - ~Beam.create_feedthrough_matrix - ~Beam.create_input_matrix - ~Beam.create_output_constants - ~Beam.create_output_matrix - ~Beam.create_state_constants - ~Beam.create_state_matrix - ~Beam.critical - ~Beam.custom_cost - ~Beam.debug - ~Beam.default_cost - ~Beam.determine_nearest_stationary_state - ~Beam.dict_itemized_costs - ~Beam.difference - ~Beam.error - ~Beam.estimate_stress - ~Beam.extract_message - ~Beam.filter - ~Beam.format_columns - ~Beam.get_forces_at - ~Beam.get_stress_at - ~Beam.get_system_input_refs - ~Beam.get_valid_force_choices - ~Beam.go_through_configurations - ~Beam.info - ~Beam.input_attrs - ~Beam.input_fields - ~Beam.installSTDLogger - ~Beam.internal_components - ~Beam.internal_configurations - ~Beam.internal_references - ~Beam.internal_systems - ~Beam.internal_tabulations - ~Beam.linear_output - ~Beam.linear_step - ~Beam.locate - ~Beam.locate_ref - ~Beam.max_von_mises - ~Beam.max_von_mises_by_case - ~Beam.message_with_identiy - ~Beam.msg - ~Beam.nonlinear_output - ~Beam.nonlinear_step - ~Beam.numeric_fields - ~Beam.parent_configurations_cls - ~Beam.parse_run_kwargs - ~Beam.parse_simulation_input - ~Beam.plot_attributes - ~Beam.post_update - ~Beam.pre_compile - ~Beam.print_info - ~Beam.rate - ~Beam.rate_linear - ~Beam.rate_nonlinear - ~Beam.ref_dXdt - ~Beam.resetLog - ~Beam.resetSystemLogs - ~Beam.reset_cls_costs - ~Beam.section_results - ~Beam.section_stresses - ~Beam.set_attr - ~Beam.set_default_costs - ~Beam.set_time - ~Beam.setattrs - ~Beam.show_mesh - ~Beam.signals_attributes - ~Beam.slack_notification - ~Beam.slot_refs - ~Beam.slots_attributes - ~Beam.smart_split_dataframe - ~Beam.solvers_attributes - ~Beam.step - ~Beam.sub_costs - ~Beam.subclasses - ~Beam.subcls_compile - ~Beam.sum_costs - ~Beam.system_properties_classdef - ~Beam.system_references - ~Beam.table_fields - ~Beam.trace_attributes - ~Beam.transients_attributes - ~Beam.update - ~Beam.update_dflt_costs - ~Beam.update_dynamics - ~Beam.update_feedthrough - ~Beam.update_input - ~Beam.update_output_constants - ~Beam.update_output_matrix - ~Beam.update_section - ~Beam.update_state - ~Beam.update_state_constants - ~Beam.validate_class - ~Beam.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Beam.A - ~Beam.Ao - ~Beam.CG_RELATIVE_INERTIA - ~Beam.E - ~Beam.Fg - ~Beam.G - ~Beam.GLOBAL_INERTIA - ~Beam.INERTIA - ~Beam.ITensor - ~Beam.Imx - ~Beam.Imxy - ~Beam.Imy - ~Beam.Imz - ~Beam.Ix - ~Beam.Ixy - ~Beam.Iy - ~Beam.Iz - ~Beam.Izo - ~Beam.J - ~Beam.Jm - ~Beam.L - ~Beam.LOCAL_INERTIA - ~Beam.L_vec - ~Beam.P1 - ~Beam.P2 - ~Beam.ReverseRotationMatrix - ~Beam.RotationMatrix - ~Beam.Ut_ref - ~Beam.Vol - ~Beam.Vol_outside - ~Beam.X1 - ~Beam.X2 - ~Beam.Xcg - ~Beam.Xt_ref - ~Beam.Y1 - ~Beam.Y2 - ~Beam.Ycg - ~Beam.Yt_ref - ~Beam.Z1 - ~Beam.Z2 - ~Beam.Zcg - ~Beam.anything_changed - ~Beam.as_dict - ~Beam.attrs_fields - ~Beam.centroid2d - ~Beam.centroid3d - ~Beam.classname - ~Beam.cog - ~Beam.combine_cost - ~Beam.cost - ~Beam.cost_categories - ~Beam.cost_properties - ~Beam.current_combo - ~Beam.dXtdt_ref - ~Beam.data_dict - ~Beam.dataframe_constants - ~Beam.dataframe_variants - ~Beam.displayname - ~Beam.dynamic_A - ~Beam.dynamic_B - ~Beam.dynamic_C - ~Beam.dynamic_D - ~Beam.dynamic_F - ~Beam.dynamic_K - ~Beam.dynamic_input - ~Beam.dynamic_input_vars - ~Beam.dynamic_output - ~Beam.dynamic_output_vars - ~Beam.dynamic_state - ~Beam.dynamic_state_vars - ~Beam.fail_factor_estimate - ~Beam.filename - ~Beam.future_costs - ~Beam.identity - ~Beam.input_as_dict - ~Beam.item_cost - ~Beam.itemized_costs - ~Beam.last_context - ~Beam.length - ~Beam.log_fmt - ~Beam.log_level - ~Beam.log_on - ~Beam.log_silo - ~Beam.logger - ~Beam.mass - ~Beam.max_axial - ~Beam.max_deflection_x - ~Beam.max_deflection_y - ~Beam.max_moment_y - ~Beam.max_moment_z - ~Beam.max_shear_y - ~Beam.max_shear_z - ~Beam.max_stress_estimate - ~Beam.max_torsion - ~Beam.member - ~Beam.min_axial - ~Beam.min_deflection_x - ~Beam.min_deflection_y - ~Beam.min_moment_y - ~Beam.min_moment_z - ~Beam.min_shear_y - ~Beam.min_shear_z - ~Beam.min_stress_xy - ~Beam.min_torsion - ~Beam.n1 - ~Beam.n2 - ~Beam.n_vec - ~Beam.nonlinear - ~Beam.numeric_as_dict - ~Beam.numeric_hash - ~Beam.plotable_variables - ~Beam.section_mass - ~Beam.skip_plot_vars - ~Beam.slack_webhook_url - ~Beam.static_A - ~Beam.static_B - ~Beam.static_C - ~Beam.static_D - ~Beam.static_F - ~Beam.static_K - ~Beam.sub_items_cost - ~Beam.system_id - ~Beam.time - ~Beam.unique_hash - ~Beam.update_interval - ~Beam.von_mises_stress_l - ~Beam.structure - ~Beam.name - ~Beam.material - ~Beam.section - ~Beam.in_Iy - ~Beam.in_Ix - ~Beam.in_J - ~Beam.in_A - ~Beam.in_Ixy - ~Beam.min_mesh_size - ~Beam.analysis_intervals - ~Beam.parent - ~Beam.cost_per_item - ~Beam.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.structure_beams.rotation_matrix_from_vectors.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.structure_beams.rotation_matrix_from_vectors.rst.txt deleted file mode 100644 index 0345f30..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.structure_beams.rotation_matrix_from_vectors.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.eng.structure\_beams.rotation\_matrix\_from\_vectors -============================================================= - -.. currentmodule:: engforge.eng.structure_beams - -.. autofunction:: rotation_matrix_from_vectors \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.structure_beams.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.structure_beams.rst.txt deleted file mode 100644 index 291afdc..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.structure_beams.rst.txt +++ /dev/null @@ -1,40 +0,0 @@ -engforge.eng.structure\_beams -============================= - -.. automodule:: engforge.eng.structure_beams - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - rotation_matrix_from_vectors - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - Beam - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.SimpleCompressor.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.SimpleCompressor.rst.txt deleted file mode 100644 index 92e811f..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.SimpleCompressor.rst.txt +++ /dev/null @@ -1,177 +0,0 @@ -engforge.eng.thermodynamics.SimpleCompressor -============================================ - -.. currentmodule:: engforge.eng.thermodynamics - -.. autoclass:: SimpleCompressor - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~SimpleCompressor.add_fields - ~SimpleCompressor.change_all_log_lvl - ~SimpleCompressor.check_ref_slot_type - ~SimpleCompressor.cls_all_attrs_fields - ~SimpleCompressor.cls_all_property_keys - ~SimpleCompressor.cls_all_property_labels - ~SimpleCompressor.cls_compile - ~SimpleCompressor.collect_all_attributes - ~SimpleCompressor.collect_comp_refs - ~SimpleCompressor.collect_dynamic_refs - ~SimpleCompressor.collect_inst_attributes - ~SimpleCompressor.collect_post_update_refs - ~SimpleCompressor.collect_solver_refs - ~SimpleCompressor.collect_update_refs - ~SimpleCompressor.comp_references - ~SimpleCompressor.compile_classes - ~SimpleCompressor.copy_config_at_state - ~SimpleCompressor.create_dynamic_matricies - ~SimpleCompressor.create_feedthrough_matrix - ~SimpleCompressor.create_input_matrix - ~SimpleCompressor.create_output_constants - ~SimpleCompressor.create_output_matrix - ~SimpleCompressor.create_state_constants - ~SimpleCompressor.create_state_matrix - ~SimpleCompressor.critical - ~SimpleCompressor.debug - ~SimpleCompressor.determine_nearest_stationary_state - ~SimpleCompressor.difference - ~SimpleCompressor.error - ~SimpleCompressor.extract_message - ~SimpleCompressor.filter - ~SimpleCompressor.format_columns - ~SimpleCompressor.get_system_input_refs - ~SimpleCompressor.go_through_configurations - ~SimpleCompressor.info - ~SimpleCompressor.input_attrs - ~SimpleCompressor.input_fields - ~SimpleCompressor.installSTDLogger - ~SimpleCompressor.internal_components - ~SimpleCompressor.internal_configurations - ~SimpleCompressor.internal_references - ~SimpleCompressor.internal_systems - ~SimpleCompressor.internal_tabulations - ~SimpleCompressor.linear_output - ~SimpleCompressor.linear_step - ~SimpleCompressor.locate - ~SimpleCompressor.locate_ref - ~SimpleCompressor.message_with_identiy - ~SimpleCompressor.msg - ~SimpleCompressor.nonlinear_output - ~SimpleCompressor.nonlinear_step - ~SimpleCompressor.numeric_fields - ~SimpleCompressor.parent_configurations_cls - ~SimpleCompressor.parse_run_kwargs - ~SimpleCompressor.parse_simulation_input - ~SimpleCompressor.plot_attributes - ~SimpleCompressor.post_update - ~SimpleCompressor.pre_compile - ~SimpleCompressor.pressure_out - ~SimpleCompressor.print_info - ~SimpleCompressor.rate - ~SimpleCompressor.rate_linear - ~SimpleCompressor.rate_nonlinear - ~SimpleCompressor.ref_dXdt - ~SimpleCompressor.resetLog - ~SimpleCompressor.resetSystemLogs - ~SimpleCompressor.set_attr - ~SimpleCompressor.set_time - ~SimpleCompressor.setattrs - ~SimpleCompressor.signals_attributes - ~SimpleCompressor.slack_notification - ~SimpleCompressor.slot_refs - ~SimpleCompressor.slots_attributes - ~SimpleCompressor.smart_split_dataframe - ~SimpleCompressor.solvers_attributes - ~SimpleCompressor.step - ~SimpleCompressor.subclasses - ~SimpleCompressor.subcls_compile - ~SimpleCompressor.system_properties_classdef - ~SimpleCompressor.system_references - ~SimpleCompressor.table_fields - ~SimpleCompressor.trace_attributes - ~SimpleCompressor.transients_attributes - ~SimpleCompressor.update - ~SimpleCompressor.update_dynamics - ~SimpleCompressor.update_feedthrough - ~SimpleCompressor.update_input - ~SimpleCompressor.update_output_constants - ~SimpleCompressor.update_output_matrix - ~SimpleCompressor.update_state - ~SimpleCompressor.update_state_constants - ~SimpleCompressor.validate_class - ~SimpleCompressor.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~SimpleCompressor.Tout - ~SimpleCompressor.Ut_ref - ~SimpleCompressor.Xt_ref - ~SimpleCompressor.Yt_ref - ~SimpleCompressor.anything_changed - ~SimpleCompressor.as_dict - ~SimpleCompressor.attrs_fields - ~SimpleCompressor.classname - ~SimpleCompressor.dXtdt_ref - ~SimpleCompressor.data_dict - ~SimpleCompressor.dataframe_constants - ~SimpleCompressor.dataframe_variants - ~SimpleCompressor.displayname - ~SimpleCompressor.dynamic_A - ~SimpleCompressor.dynamic_B - ~SimpleCompressor.dynamic_C - ~SimpleCompressor.dynamic_D - ~SimpleCompressor.dynamic_F - ~SimpleCompressor.dynamic_K - ~SimpleCompressor.dynamic_input - ~SimpleCompressor.dynamic_input_vars - ~SimpleCompressor.dynamic_output - ~SimpleCompressor.dynamic_output_vars - ~SimpleCompressor.dynamic_state - ~SimpleCompressor.dynamic_state_vars - ~SimpleCompressor.filename - ~SimpleCompressor.identity - ~SimpleCompressor.input_as_dict - ~SimpleCompressor.last_context - ~SimpleCompressor.log_fmt - ~SimpleCompressor.log_level - ~SimpleCompressor.log_on - ~SimpleCompressor.log_silo - ~SimpleCompressor.logger - ~SimpleCompressor.nonlinear - ~SimpleCompressor.numeric_as_dict - ~SimpleCompressor.numeric_hash - ~SimpleCompressor.plotable_variables - ~SimpleCompressor.power_input - ~SimpleCompressor.skip_plot_vars - ~SimpleCompressor.slack_webhook_url - ~SimpleCompressor.static_A - ~SimpleCompressor.static_B - ~SimpleCompressor.static_C - ~SimpleCompressor.static_D - ~SimpleCompressor.static_F - ~SimpleCompressor.static_K - ~SimpleCompressor.system_id - ~SimpleCompressor.temperature_ratio - ~SimpleCompressor.time - ~SimpleCompressor.unique_hash - ~SimpleCompressor.update_interval - ~SimpleCompressor.parent - ~SimpleCompressor.name - ~SimpleCompressor.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.SimpleHeatExchanger.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.SimpleHeatExchanger.rst.txt deleted file mode 100644 index bccba5f..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.SimpleHeatExchanger.rst.txt +++ /dev/null @@ -1,180 +0,0 @@ -engforge.eng.thermodynamics.SimpleHeatExchanger -=============================================== - -.. currentmodule:: engforge.eng.thermodynamics - -.. autoclass:: SimpleHeatExchanger - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~SimpleHeatExchanger.add_fields - ~SimpleHeatExchanger.change_all_log_lvl - ~SimpleHeatExchanger.check_ref_slot_type - ~SimpleHeatExchanger.cls_all_attrs_fields - ~SimpleHeatExchanger.cls_all_property_keys - ~SimpleHeatExchanger.cls_all_property_labels - ~SimpleHeatExchanger.cls_compile - ~SimpleHeatExchanger.collect_all_attributes - ~SimpleHeatExchanger.collect_comp_refs - ~SimpleHeatExchanger.collect_dynamic_refs - ~SimpleHeatExchanger.collect_inst_attributes - ~SimpleHeatExchanger.collect_post_update_refs - ~SimpleHeatExchanger.collect_solver_refs - ~SimpleHeatExchanger.collect_update_refs - ~SimpleHeatExchanger.comp_references - ~SimpleHeatExchanger.compile_classes - ~SimpleHeatExchanger.copy_config_at_state - ~SimpleHeatExchanger.create_dynamic_matricies - ~SimpleHeatExchanger.create_feedthrough_matrix - ~SimpleHeatExchanger.create_input_matrix - ~SimpleHeatExchanger.create_output_constants - ~SimpleHeatExchanger.create_output_matrix - ~SimpleHeatExchanger.create_state_constants - ~SimpleHeatExchanger.create_state_matrix - ~SimpleHeatExchanger.critical - ~SimpleHeatExchanger.debug - ~SimpleHeatExchanger.determine_nearest_stationary_state - ~SimpleHeatExchanger.difference - ~SimpleHeatExchanger.error - ~SimpleHeatExchanger.extract_message - ~SimpleHeatExchanger.filter - ~SimpleHeatExchanger.format_columns - ~SimpleHeatExchanger.get_system_input_refs - ~SimpleHeatExchanger.go_through_configurations - ~SimpleHeatExchanger.info - ~SimpleHeatExchanger.input_attrs - ~SimpleHeatExchanger.input_fields - ~SimpleHeatExchanger.installSTDLogger - ~SimpleHeatExchanger.internal_components - ~SimpleHeatExchanger.internal_configurations - ~SimpleHeatExchanger.internal_references - ~SimpleHeatExchanger.internal_systems - ~SimpleHeatExchanger.internal_tabulations - ~SimpleHeatExchanger.linear_output - ~SimpleHeatExchanger.linear_step - ~SimpleHeatExchanger.locate - ~SimpleHeatExchanger.locate_ref - ~SimpleHeatExchanger.message_with_identiy - ~SimpleHeatExchanger.msg - ~SimpleHeatExchanger.nonlinear_output - ~SimpleHeatExchanger.nonlinear_step - ~SimpleHeatExchanger.numeric_fields - ~SimpleHeatExchanger.parent_configurations_cls - ~SimpleHeatExchanger.parse_run_kwargs - ~SimpleHeatExchanger.parse_simulation_input - ~SimpleHeatExchanger.plot_attributes - ~SimpleHeatExchanger.post_update - ~SimpleHeatExchanger.pre_compile - ~SimpleHeatExchanger.print_info - ~SimpleHeatExchanger.rate - ~SimpleHeatExchanger.rate_linear - ~SimpleHeatExchanger.rate_nonlinear - ~SimpleHeatExchanger.ref_dXdt - ~SimpleHeatExchanger.resetLog - ~SimpleHeatExchanger.resetSystemLogs - ~SimpleHeatExchanger.set_attr - ~SimpleHeatExchanger.set_time - ~SimpleHeatExchanger.setattrs - ~SimpleHeatExchanger.signals_attributes - ~SimpleHeatExchanger.slack_notification - ~SimpleHeatExchanger.slot_refs - ~SimpleHeatExchanger.slots_attributes - ~SimpleHeatExchanger.smart_split_dataframe - ~SimpleHeatExchanger.solvers_attributes - ~SimpleHeatExchanger.step - ~SimpleHeatExchanger.subclasses - ~SimpleHeatExchanger.subcls_compile - ~SimpleHeatExchanger.system_properties_classdef - ~SimpleHeatExchanger.system_references - ~SimpleHeatExchanger.table_fields - ~SimpleHeatExchanger.trace_attributes - ~SimpleHeatExchanger.transients_attributes - ~SimpleHeatExchanger.update - ~SimpleHeatExchanger.update_dynamics - ~SimpleHeatExchanger.update_feedthrough - ~SimpleHeatExchanger.update_input - ~SimpleHeatExchanger.update_output_constants - ~SimpleHeatExchanger.update_output_matrix - ~SimpleHeatExchanger.update_state - ~SimpleHeatExchanger.update_state_constants - ~SimpleHeatExchanger.validate_class - ~SimpleHeatExchanger.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~SimpleHeatExchanger.CmatC - ~SimpleHeatExchanger.CmatH - ~SimpleHeatExchanger.Qdot - ~SimpleHeatExchanger.Qdot_ideal - ~SimpleHeatExchanger.Tc_out - ~SimpleHeatExchanger.Th_out - ~SimpleHeatExchanger.Tout_ideal - ~SimpleHeatExchanger.Ut_ref - ~SimpleHeatExchanger.Xt_ref - ~SimpleHeatExchanger.Yt_ref - ~SimpleHeatExchanger.anything_changed - ~SimpleHeatExchanger.as_dict - ~SimpleHeatExchanger.attrs_fields - ~SimpleHeatExchanger.classname - ~SimpleHeatExchanger.dXtdt_ref - ~SimpleHeatExchanger.data_dict - ~SimpleHeatExchanger.dataframe_constants - ~SimpleHeatExchanger.dataframe_variants - ~SimpleHeatExchanger.displayname - ~SimpleHeatExchanger.dynamic_A - ~SimpleHeatExchanger.dynamic_B - ~SimpleHeatExchanger.dynamic_C - ~SimpleHeatExchanger.dynamic_D - ~SimpleHeatExchanger.dynamic_F - ~SimpleHeatExchanger.dynamic_K - ~SimpleHeatExchanger.dynamic_input - ~SimpleHeatExchanger.dynamic_input_vars - ~SimpleHeatExchanger.dynamic_output - ~SimpleHeatExchanger.dynamic_output_vars - ~SimpleHeatExchanger.dynamic_state - ~SimpleHeatExchanger.dynamic_state_vars - ~SimpleHeatExchanger.filename - ~SimpleHeatExchanger.identity - ~SimpleHeatExchanger.input_as_dict - ~SimpleHeatExchanger.last_context - ~SimpleHeatExchanger.log_fmt - ~SimpleHeatExchanger.log_level - ~SimpleHeatExchanger.log_on - ~SimpleHeatExchanger.log_silo - ~SimpleHeatExchanger.logger - ~SimpleHeatExchanger.nonlinear - ~SimpleHeatExchanger.numeric_as_dict - ~SimpleHeatExchanger.numeric_hash - ~SimpleHeatExchanger.plotable_variables - ~SimpleHeatExchanger.skip_plot_vars - ~SimpleHeatExchanger.slack_webhook_url - ~SimpleHeatExchanger.static_A - ~SimpleHeatExchanger.static_B - ~SimpleHeatExchanger.static_C - ~SimpleHeatExchanger.static_D - ~SimpleHeatExchanger.static_F - ~SimpleHeatExchanger.static_K - ~SimpleHeatExchanger.system_id - ~SimpleHeatExchanger.time - ~SimpleHeatExchanger.unique_hash - ~SimpleHeatExchanger.update_interval - ~SimpleHeatExchanger.parent - ~SimpleHeatExchanger.name - ~SimpleHeatExchanger.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.SimplePump.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.SimplePump.rst.txt deleted file mode 100644 index d077e8c..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.SimplePump.rst.txt +++ /dev/null @@ -1,181 +0,0 @@ -engforge.eng.thermodynamics.SimplePump -====================================== - -.. currentmodule:: engforge.eng.thermodynamics - -.. autoclass:: SimplePump - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~SimplePump.add_fields - ~SimplePump.change_all_log_lvl - ~SimplePump.check_ref_slot_type - ~SimplePump.cls_all_attrs_fields - ~SimplePump.cls_all_property_keys - ~SimplePump.cls_all_property_labels - ~SimplePump.cls_compile - ~SimplePump.collect_all_attributes - ~SimplePump.collect_comp_refs - ~SimplePump.collect_dynamic_refs - ~SimplePump.collect_inst_attributes - ~SimplePump.collect_post_update_refs - ~SimplePump.collect_solver_refs - ~SimplePump.collect_update_refs - ~SimplePump.comp_references - ~SimplePump.compile_classes - ~SimplePump.copy_config_at_state - ~SimplePump.create_dynamic_matricies - ~SimplePump.create_feedthrough_matrix - ~SimplePump.create_input_matrix - ~SimplePump.create_output_constants - ~SimplePump.create_output_matrix - ~SimplePump.create_state_constants - ~SimplePump.create_state_matrix - ~SimplePump.critical - ~SimplePump.debug - ~SimplePump.determine_nearest_stationary_state - ~SimplePump.difference - ~SimplePump.error - ~SimplePump.eval - ~SimplePump.extract_message - ~SimplePump.filter - ~SimplePump.format_columns - ~SimplePump.get_system_input_refs - ~SimplePump.go_through_configurations - ~SimplePump.info - ~SimplePump.input_attrs - ~SimplePump.input_fields - ~SimplePump.installSTDLogger - ~SimplePump.internal_components - ~SimplePump.internal_configurations - ~SimplePump.internal_references - ~SimplePump.internal_systems - ~SimplePump.internal_tabulations - ~SimplePump.linear_output - ~SimplePump.linear_step - ~SimplePump.locate - ~SimplePump.locate_ref - ~SimplePump.message_with_identiy - ~SimplePump.msg - ~SimplePump.nonlinear_output - ~SimplePump.nonlinear_step - ~SimplePump.numeric_fields - ~SimplePump.parent_configurations_cls - ~SimplePump.parse_run_kwargs - ~SimplePump.parse_simulation_input - ~SimplePump.plot_attributes - ~SimplePump.post_update - ~SimplePump.pre_compile - ~SimplePump.print_info - ~SimplePump.rate - ~SimplePump.rate_linear - ~SimplePump.rate_nonlinear - ~SimplePump.ref_dXdt - ~SimplePump.resetLog - ~SimplePump.resetSystemLogs - ~SimplePump.set_attr - ~SimplePump.set_time - ~SimplePump.setattrs - ~SimplePump.signals_attributes - ~SimplePump.slack_notification - ~SimplePump.slot_refs - ~SimplePump.slots_attributes - ~SimplePump.smart_split_dataframe - ~SimplePump.solvers_attributes - ~SimplePump.step - ~SimplePump.subclasses - ~SimplePump.subcls_compile - ~SimplePump.system_properties_classdef - ~SimplePump.system_references - ~SimplePump.table_fields - ~SimplePump.trace_attributes - ~SimplePump.transients_attributes - ~SimplePump.update - ~SimplePump.update_dynamics - ~SimplePump.update_feedthrough - ~SimplePump.update_input - ~SimplePump.update_output_constants - ~SimplePump.update_output_matrix - ~SimplePump.update_state - ~SimplePump.update_state_constants - ~SimplePump.validate_class - ~SimplePump.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~SimplePump.Pout - ~SimplePump.Tout - ~SimplePump.Ut_ref - ~SimplePump.Xt_ref - ~SimplePump.Yt_ref - ~SimplePump.anything_changed - ~SimplePump.as_dict - ~SimplePump.attrs_fields - ~SimplePump.classname - ~SimplePump.cost - ~SimplePump.dXtdt_ref - ~SimplePump.data_dict - ~SimplePump.dataframe_constants - ~SimplePump.dataframe_variants - ~SimplePump.displayname - ~SimplePump.dynamic_A - ~SimplePump.dynamic_B - ~SimplePump.dynamic_C - ~SimplePump.dynamic_D - ~SimplePump.dynamic_F - ~SimplePump.dynamic_K - ~SimplePump.dynamic_input - ~SimplePump.dynamic_input_vars - ~SimplePump.dynamic_output - ~SimplePump.dynamic_output_vars - ~SimplePump.dynamic_state - ~SimplePump.dynamic_state_vars - ~SimplePump.filename - ~SimplePump.identity - ~SimplePump.input_as_dict - ~SimplePump.last_context - ~SimplePump.log_fmt - ~SimplePump.log_level - ~SimplePump.log_on - ~SimplePump.log_silo - ~SimplePump.logger - ~SimplePump.nonlinear - ~SimplePump.numeric_as_dict - ~SimplePump.numeric_hash - ~SimplePump.plotable_variables - ~SimplePump.power_input - ~SimplePump.pressure_delta - ~SimplePump.skip_plot_vars - ~SimplePump.slack_webhook_url - ~SimplePump.static_A - ~SimplePump.static_B - ~SimplePump.static_C - ~SimplePump.static_D - ~SimplePump.static_F - ~SimplePump.static_K - ~SimplePump.system_id - ~SimplePump.temperature_delta - ~SimplePump.time - ~SimplePump.unique_hash - ~SimplePump.update_interval - ~SimplePump.volumetric_flow - ~SimplePump.parent - ~SimplePump.name - ~SimplePump.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.SimpleTurbine.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.SimpleTurbine.rst.txt deleted file mode 100644 index fd6a627..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.SimpleTurbine.rst.txt +++ /dev/null @@ -1,176 +0,0 @@ -engforge.eng.thermodynamics.SimpleTurbine -========================================= - -.. currentmodule:: engforge.eng.thermodynamics - -.. autoclass:: SimpleTurbine - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~SimpleTurbine.add_fields - ~SimpleTurbine.change_all_log_lvl - ~SimpleTurbine.check_ref_slot_type - ~SimpleTurbine.cls_all_attrs_fields - ~SimpleTurbine.cls_all_property_keys - ~SimpleTurbine.cls_all_property_labels - ~SimpleTurbine.cls_compile - ~SimpleTurbine.collect_all_attributes - ~SimpleTurbine.collect_comp_refs - ~SimpleTurbine.collect_dynamic_refs - ~SimpleTurbine.collect_inst_attributes - ~SimpleTurbine.collect_post_update_refs - ~SimpleTurbine.collect_solver_refs - ~SimpleTurbine.collect_update_refs - ~SimpleTurbine.comp_references - ~SimpleTurbine.compile_classes - ~SimpleTurbine.copy_config_at_state - ~SimpleTurbine.create_dynamic_matricies - ~SimpleTurbine.create_feedthrough_matrix - ~SimpleTurbine.create_input_matrix - ~SimpleTurbine.create_output_constants - ~SimpleTurbine.create_output_matrix - ~SimpleTurbine.create_state_constants - ~SimpleTurbine.create_state_matrix - ~SimpleTurbine.critical - ~SimpleTurbine.debug - ~SimpleTurbine.determine_nearest_stationary_state - ~SimpleTurbine.difference - ~SimpleTurbine.error - ~SimpleTurbine.extract_message - ~SimpleTurbine.filter - ~SimpleTurbine.format_columns - ~SimpleTurbine.get_system_input_refs - ~SimpleTurbine.go_through_configurations - ~SimpleTurbine.info - ~SimpleTurbine.input_attrs - ~SimpleTurbine.input_fields - ~SimpleTurbine.installSTDLogger - ~SimpleTurbine.internal_components - ~SimpleTurbine.internal_configurations - ~SimpleTurbine.internal_references - ~SimpleTurbine.internal_systems - ~SimpleTurbine.internal_tabulations - ~SimpleTurbine.linear_output - ~SimpleTurbine.linear_step - ~SimpleTurbine.locate - ~SimpleTurbine.locate_ref - ~SimpleTurbine.message_with_identiy - ~SimpleTurbine.msg - ~SimpleTurbine.nonlinear_output - ~SimpleTurbine.nonlinear_step - ~SimpleTurbine.numeric_fields - ~SimpleTurbine.parent_configurations_cls - ~SimpleTurbine.parse_run_kwargs - ~SimpleTurbine.parse_simulation_input - ~SimpleTurbine.plot_attributes - ~SimpleTurbine.post_update - ~SimpleTurbine.pre_compile - ~SimpleTurbine.print_info - ~SimpleTurbine.rate - ~SimpleTurbine.rate_linear - ~SimpleTurbine.rate_nonlinear - ~SimpleTurbine.ref_dXdt - ~SimpleTurbine.resetLog - ~SimpleTurbine.resetSystemLogs - ~SimpleTurbine.set_attr - ~SimpleTurbine.set_time - ~SimpleTurbine.setattrs - ~SimpleTurbine.signals_attributes - ~SimpleTurbine.slack_notification - ~SimpleTurbine.slot_refs - ~SimpleTurbine.slots_attributes - ~SimpleTurbine.smart_split_dataframe - ~SimpleTurbine.solvers_attributes - ~SimpleTurbine.step - ~SimpleTurbine.subclasses - ~SimpleTurbine.subcls_compile - ~SimpleTurbine.system_properties_classdef - ~SimpleTurbine.system_references - ~SimpleTurbine.table_fields - ~SimpleTurbine.trace_attributes - ~SimpleTurbine.transients_attributes - ~SimpleTurbine.update - ~SimpleTurbine.update_dynamics - ~SimpleTurbine.update_feedthrough - ~SimpleTurbine.update_input - ~SimpleTurbine.update_output_constants - ~SimpleTurbine.update_output_matrix - ~SimpleTurbine.update_state - ~SimpleTurbine.update_state_constants - ~SimpleTurbine.validate_class - ~SimpleTurbine.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~SimpleTurbine.Tout - ~SimpleTurbine.Ut_ref - ~SimpleTurbine.Xt_ref - ~SimpleTurbine.Yt_ref - ~SimpleTurbine.anything_changed - ~SimpleTurbine.as_dict - ~SimpleTurbine.attrs_fields - ~SimpleTurbine.classname - ~SimpleTurbine.dXtdt_ref - ~SimpleTurbine.data_dict - ~SimpleTurbine.dataframe_constants - ~SimpleTurbine.dataframe_variants - ~SimpleTurbine.displayname - ~SimpleTurbine.dynamic_A - ~SimpleTurbine.dynamic_B - ~SimpleTurbine.dynamic_C - ~SimpleTurbine.dynamic_D - ~SimpleTurbine.dynamic_F - ~SimpleTurbine.dynamic_K - ~SimpleTurbine.dynamic_input - ~SimpleTurbine.dynamic_input_vars - ~SimpleTurbine.dynamic_output - ~SimpleTurbine.dynamic_output_vars - ~SimpleTurbine.dynamic_state - ~SimpleTurbine.dynamic_state_vars - ~SimpleTurbine.filename - ~SimpleTurbine.identity - ~SimpleTurbine.input_as_dict - ~SimpleTurbine.last_context - ~SimpleTurbine.log_fmt - ~SimpleTurbine.log_level - ~SimpleTurbine.log_on - ~SimpleTurbine.log_silo - ~SimpleTurbine.logger - ~SimpleTurbine.nonlinear - ~SimpleTurbine.numeric_as_dict - ~SimpleTurbine.numeric_hash - ~SimpleTurbine.plotable_variables - ~SimpleTurbine.power_output - ~SimpleTurbine.pressure_ratio - ~SimpleTurbine.skip_plot_vars - ~SimpleTurbine.slack_webhook_url - ~SimpleTurbine.static_A - ~SimpleTurbine.static_B - ~SimpleTurbine.static_C - ~SimpleTurbine.static_D - ~SimpleTurbine.static_F - ~SimpleTurbine.static_K - ~SimpleTurbine.system_id - ~SimpleTurbine.time - ~SimpleTurbine.unique_hash - ~SimpleTurbine.update_interval - ~SimpleTurbine.parent - ~SimpleTurbine.name - ~SimpleTurbine.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.dp_he_core.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.dp_he_core.rst.txt deleted file mode 100644 index 7592067..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.dp_he_core.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.eng.thermodynamics.dp\_he\_core -======================================== - -.. currentmodule:: engforge.eng.thermodynamics - -.. autofunction:: dp_he_core \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.dp_he_entrance.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.dp_he_entrance.rst.txt deleted file mode 100644 index e810bee..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.dp_he_entrance.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.eng.thermodynamics.dp\_he\_entrance -============================================ - -.. currentmodule:: engforge.eng.thermodynamics - -.. autofunction:: dp_he_entrance \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.dp_he_exit.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.dp_he_exit.rst.txt deleted file mode 100644 index 89c7657..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.dp_he_exit.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.eng.thermodynamics.dp\_he\_exit -======================================== - -.. currentmodule:: engforge.eng.thermodynamics - -.. autofunction:: dp_he_exit \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.dp_he_gas_losses.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.dp_he_gas_losses.rst.txt deleted file mode 100644 index 1b183ad..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.dp_he_gas_losses.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.eng.thermodynamics.dp\_he\_gas\_losses -=============================================== - -.. currentmodule:: engforge.eng.thermodynamics - -.. autofunction:: dp_he_gas_losses \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.fanning_friction_factor.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.fanning_friction_factor.rst.txt deleted file mode 100644 index c736884..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.fanning_friction_factor.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.eng.thermodynamics.fanning\_friction\_factor -===================================================== - -.. currentmodule:: engforge.eng.thermodynamics - -.. autofunction:: fanning_friction_factor \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.rst.txt deleted file mode 100644 index 43aad24..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.eng.thermodynamics.rst.txt +++ /dev/null @@ -1,47 +0,0 @@ -engforge.eng.thermodynamics -=========================== - -.. automodule:: engforge.eng.thermodynamics - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - dp_he_core - dp_he_entrance - dp_he_exit - dp_he_gas_losses - fanning_friction_factor - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - SimpleCompressor - SimpleHeatExchanger - SimplePump - SimpleTurbine - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.engforge_attributes.AttributedBaseMixin.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.engforge_attributes.AttributedBaseMixin.rst.txt deleted file mode 100644 index f9824e3..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.engforge_attributes.AttributedBaseMixin.rst.txt +++ /dev/null @@ -1,72 +0,0 @@ -engforge.engforge\_attributes.AttributedBaseMixin -================================================= - -.. currentmodule:: engforge.engforge_attributes - -.. autoclass:: AttributedBaseMixin - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~AttributedBaseMixin.add_fields - ~AttributedBaseMixin.change_all_log_lvl - ~AttributedBaseMixin.check_ref_slot_type - ~AttributedBaseMixin.collect_all_attributes - ~AttributedBaseMixin.collect_inst_attributes - ~AttributedBaseMixin.critical - ~AttributedBaseMixin.debug - ~AttributedBaseMixin.difference - ~AttributedBaseMixin.error - ~AttributedBaseMixin.extract_message - ~AttributedBaseMixin.filter - ~AttributedBaseMixin.info - ~AttributedBaseMixin.input_attrs - ~AttributedBaseMixin.input_fields - ~AttributedBaseMixin.installSTDLogger - ~AttributedBaseMixin.message_with_identiy - ~AttributedBaseMixin.msg - ~AttributedBaseMixin.numeric_fields - ~AttributedBaseMixin.plot_attributes - ~AttributedBaseMixin.resetLog - ~AttributedBaseMixin.resetSystemLogs - ~AttributedBaseMixin.setattrs - ~AttributedBaseMixin.signals_attributes - ~AttributedBaseMixin.slack_notification - ~AttributedBaseMixin.slot_refs - ~AttributedBaseMixin.slots_attributes - ~AttributedBaseMixin.solvers_attributes - ~AttributedBaseMixin.table_fields - ~AttributedBaseMixin.trace_attributes - ~AttributedBaseMixin.transients_attributes - ~AttributedBaseMixin.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~AttributedBaseMixin.as_dict - ~AttributedBaseMixin.attrs_fields - ~AttributedBaseMixin.identity - ~AttributedBaseMixin.input_as_dict - ~AttributedBaseMixin.log_fmt - ~AttributedBaseMixin.log_level - ~AttributedBaseMixin.log_on - ~AttributedBaseMixin.logger - ~AttributedBaseMixin.numeric_as_dict - ~AttributedBaseMixin.numeric_hash - ~AttributedBaseMixin.slack_webhook_url - ~AttributedBaseMixin.unique_hash - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.engforge_attributes.EngAttr.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.engforge_attributes.EngAttr.rst.txt deleted file mode 100644 index bff1650..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.engforge_attributes.EngAttr.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.engforge\_attributes.EngAttr -===================================== - -.. currentmodule:: engforge.engforge_attributes - -.. autoclass:: EngAttr - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~EngAttr.add_fields - ~EngAttr.change_all_log_lvl - ~EngAttr.critical - ~EngAttr.debug - ~EngAttr.error - ~EngAttr.extract_message - ~EngAttr.filter - ~EngAttr.info - ~EngAttr.installSTDLogger - ~EngAttr.message_with_identiy - ~EngAttr.msg - ~EngAttr.resetLog - ~EngAttr.resetSystemLogs - ~EngAttr.slack_notification - ~EngAttr.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~EngAttr.identity - ~EngAttr.log_fmt - ~EngAttr.log_level - ~EngAttr.log_on - ~EngAttr.logger - ~EngAttr.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.engforge_attributes.get_attributes_of.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.engforge_attributes.get_attributes_of.rst.txt deleted file mode 100644 index b01b756..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.engforge_attributes.get_attributes_of.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.engforge\_attributes.get\_attributes\_of -================================================= - -.. currentmodule:: engforge.engforge_attributes - -.. autofunction:: get_attributes_of \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.engforge_attributes.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.engforge_attributes.rst.txt deleted file mode 100644 index 99ce8b5..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.engforge_attributes.rst.txt +++ /dev/null @@ -1,41 +0,0 @@ -engforge.engforge\_attributes -============================= - -.. automodule:: engforge.engforge_attributes - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - get_attributes_of - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - AttributedBaseMixin - EngAttr - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.env_var.EnvVariable.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.env_var.EnvVariable.rst.txt deleted file mode 100644 index 911bd8d..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.env_var.EnvVariable.rst.txt +++ /dev/null @@ -1,62 +0,0 @@ -engforge.env\_var.EnvVariable -============================= - -.. currentmodule:: engforge.env_var - -.. autoclass:: EnvVariable - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~EnvVariable.add_fields - ~EnvVariable.change_all_log_lvl - ~EnvVariable.critical - ~EnvVariable.debug - ~EnvVariable.error - ~EnvVariable.extract_message - ~EnvVariable.filter - ~EnvVariable.info - ~EnvVariable.installSTDLogger - ~EnvVariable.load_env_vars - ~EnvVariable.message_with_identiy - ~EnvVariable.msg - ~EnvVariable.print_env_vars - ~EnvVariable.remove - ~EnvVariable.resetLog - ~EnvVariable.resetSystemLogs - ~EnvVariable.slack_notification - ~EnvVariable.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~EnvVariable.default - ~EnvVariable.desc - ~EnvVariable.identity - ~EnvVariable.in_env - ~EnvVariable.log_fmt - ~EnvVariable.log_level - ~EnvVariable.log_on - ~EnvVariable.logger - ~EnvVariable.obscure - ~EnvVariable.obscured_name - ~EnvVariable.secret - ~EnvVariable.slack_webhook_url - ~EnvVariable.type_conv - ~EnvVariable.var_name - ~EnvVariable.fail_on_missing - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.env_var.parse_bool.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.env_var.parse_bool.rst.txt deleted file mode 100644 index a38eef6..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.env_var.parse_bool.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.env\_var.parse\_bool -============================= - -.. currentmodule:: engforge.env_var - -.. autofunction:: parse_bool \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.env_var.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.env_var.rst.txt deleted file mode 100644 index e180e26..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.env_var.rst.txt +++ /dev/null @@ -1,40 +0,0 @@ -engforge.env\_var -================= - -.. automodule:: engforge.env_var - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - parse_bool - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - EnvVariable - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.locations.client_path.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.locations.client_path.rst.txt deleted file mode 100644 index 24e2a98..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.locations.client_path.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.locations.client\_path -=============================== - -.. currentmodule:: engforge.locations - -.. autofunction:: client_path \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.locations.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.locations.rst.txt deleted file mode 100644 index 1d74392..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.locations.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -engforge.locations -================== - -.. automodule:: engforge.locations - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - client_path - - - - - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.logging.Log.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.logging.Log.rst.txt deleted file mode 100644 index b308c96..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.logging.Log.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.logging.Log -==================== - -.. currentmodule:: engforge.logging - -.. autoclass:: Log - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Log.add_fields - ~Log.change_all_log_lvl - ~Log.critical - ~Log.debug - ~Log.error - ~Log.extract_message - ~Log.filter - ~Log.info - ~Log.installSTDLogger - ~Log.message_with_identiy - ~Log.msg - ~Log.resetLog - ~Log.resetSystemLogs - ~Log.slack_notification - ~Log.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Log.identity - ~Log.log_fmt - ~Log.log_level - ~Log.log_on - ~Log.logger - ~Log.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.logging.LoggingMixin.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.logging.LoggingMixin.rst.txt deleted file mode 100644 index 7be4727..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.logging.LoggingMixin.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.logging.LoggingMixin -============================= - -.. currentmodule:: engforge.logging - -.. autoclass:: LoggingMixin - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~LoggingMixin.add_fields - ~LoggingMixin.change_all_log_lvl - ~LoggingMixin.critical - ~LoggingMixin.debug - ~LoggingMixin.error - ~LoggingMixin.extract_message - ~LoggingMixin.filter - ~LoggingMixin.info - ~LoggingMixin.installSTDLogger - ~LoggingMixin.message_with_identiy - ~LoggingMixin.msg - ~LoggingMixin.resetLog - ~LoggingMixin.resetSystemLogs - ~LoggingMixin.slack_notification - ~LoggingMixin.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~LoggingMixin.identity - ~LoggingMixin.log_fmt - ~LoggingMixin.log_level - ~LoggingMixin.log_on - ~LoggingMixin.logger - ~LoggingMixin.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.logging.change_all_log_levels.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.logging.change_all_log_levels.rst.txt deleted file mode 100644 index 484e6f3..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.logging.change_all_log_levels.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.logging.change\_all\_log\_levels -========================================= - -.. currentmodule:: engforge.logging - -.. autofunction:: change_all_log_levels \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.logging.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.logging.rst.txt deleted file mode 100644 index 2c9457e..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.logging.rst.txt +++ /dev/null @@ -1,41 +0,0 @@ -engforge.logging -================ - -.. automodule:: engforge.logging - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - change_all_log_levels - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - Log - LoggingMixin - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.patterns.InputSingletonMeta.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.patterns.InputSingletonMeta.rst.txt deleted file mode 100644 index 46e57d1..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.patterns.InputSingletonMeta.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -engforge.patterns.InputSingletonMeta -==================================== - -.. currentmodule:: engforge.patterns - -.. autoclass:: InputSingletonMeta - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~InputSingletonMeta.mro - - - - - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.patterns.Singleton.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.patterns.Singleton.rst.txt deleted file mode 100644 index e09d0da..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.patterns.Singleton.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -engforge.patterns.Singleton -=========================== - -.. currentmodule:: engforge.patterns - -.. autoclass:: Singleton - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Singleton.instance - - - - - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.patterns.SingletonMeta.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.patterns.SingletonMeta.rst.txt deleted file mode 100644 index 10a93b3..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.patterns.SingletonMeta.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -engforge.patterns.SingletonMeta -=============================== - -.. currentmodule:: engforge.patterns - -.. autoclass:: SingletonMeta - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~SingletonMeta.mro - - - - - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.patterns.chunks.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.patterns.chunks.rst.txt deleted file mode 100644 index f847f0e..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.patterns.chunks.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.patterns.chunks -======================== - -.. currentmodule:: engforge.patterns - -.. autofunction:: chunks \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.patterns.flat2gen.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.patterns.flat2gen.rst.txt deleted file mode 100644 index 9bf5db3..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.patterns.flat2gen.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.patterns.flat2gen -========================== - -.. currentmodule:: engforge.patterns - -.. autofunction:: flat2gen \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.patterns.flatten.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.patterns.flatten.rst.txt deleted file mode 100644 index d3d28ce..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.patterns.flatten.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.patterns.flatten -========================= - -.. currentmodule:: engforge.patterns - -.. autofunction:: flatten \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.patterns.inst_vectorize.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.patterns.inst_vectorize.rst.txt deleted file mode 100644 index c85bc9d..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.patterns.inst_vectorize.rst.txt +++ /dev/null @@ -1,24 +0,0 @@ -engforge.patterns.inst\_vectorize -================================= - -.. currentmodule:: engforge.patterns - -.. autoclass:: inst_vectorize - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - - - - - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.patterns.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.patterns.rst.txt deleted file mode 100644 index e9cabdf..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.patterns.rst.txt +++ /dev/null @@ -1,46 +0,0 @@ -engforge.patterns -================= - -.. automodule:: engforge.patterns - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - chunks - flat2gen - flatten - singleton_meta_object - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - InputSingletonMeta - Singleton - SingletonMeta - inst_vectorize - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.patterns.singleton_meta_object.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.patterns.singleton_meta_object.rst.txt deleted file mode 100644 index 81aaad7..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.patterns.singleton_meta_object.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.patterns.singleton\_meta\_object -========================================= - -.. currentmodule:: engforge.patterns - -.. autofunction:: singleton_meta_object \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.problem_context.IllegalArgument.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.problem_context.IllegalArgument.rst.txt deleted file mode 100644 index 758d926..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.problem_context.IllegalArgument.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.problem\_context.IllegalArgument -========================================= - -.. currentmodule:: engforge.problem_context - -.. autoexception:: IllegalArgument \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.problem_context.ProbLog.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.problem_context.ProbLog.rst.txt deleted file mode 100644 index c0e6f8e..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.problem_context.ProbLog.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.problem\_context.ProbLog -================================= - -.. currentmodule:: engforge.problem_context - -.. autoclass:: ProbLog - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~ProbLog.add_fields - ~ProbLog.change_all_log_lvl - ~ProbLog.critical - ~ProbLog.debug - ~ProbLog.error - ~ProbLog.extract_message - ~ProbLog.filter - ~ProbLog.info - ~ProbLog.installSTDLogger - ~ProbLog.message_with_identiy - ~ProbLog.msg - ~ProbLog.resetLog - ~ProbLog.resetSystemLogs - ~ProbLog.slack_notification - ~ProbLog.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ProbLog.identity - ~ProbLog.log_fmt - ~ProbLog.log_level - ~ProbLog.log_on - ~ProbLog.logger - ~ProbLog.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.problem_context.Problem.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.problem_context.Problem.rst.txt deleted file mode 100644 index a2a513c..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.problem_context.Problem.rst.txt +++ /dev/null @@ -1,146 +0,0 @@ -engforge.problem\_context.Problem -================================= - -.. currentmodule:: engforge.problem_context - -.. autoclass:: Problem - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Problem.activate_temp_state - ~Problem.apply_post_signals - ~Problem.apply_pre_signals - ~Problem.clean_context - ~Problem.critical - ~Problem.debug - ~Problem.debug_levels - ~Problem.discard_contexts - ~Problem.error - ~Problem.error_action - ~Problem.establish_system - ~Problem.exit_action - ~Problem.exit_and_revert - ~Problem.exit_to_level - ~Problem.exit_with_state - ~Problem.filter_vars - ~Problem.format_columns - ~Problem.get_extra_kws - ~Problem.get_parent_key - ~Problem.get_ref_values - ~Problem.get_sesh - ~Problem.handle_solution - ~Problem.info - ~Problem.integral_rate - ~Problem.integrate - ~Problem.min_refresh - ~Problem.msg - ~Problem.parse_default - ~Problem.persist_contexts - ~Problem.pos_obj - ~Problem.post_execute - ~Problem.post_update_system - ~Problem.pre_execute - ~Problem.refresh_references - ~Problem.reset_contexts - ~Problem.reset_data - ~Problem.revert_to_start - ~Problem.save_data - ~Problem.set_checkpoint - ~Problem.set_ref_values - ~Problem.set_time - ~Problem.smart_split_dataframe - ~Problem.solve_min - ~Problem.sys_solver_constraints - ~Problem.sys_solver_objectives - ~Problem.update_dynamics - ~Problem.update_methods - ~Problem.update_system - ~Problem.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Problem.all_components - ~Problem.all_comps - ~Problem.all_comps_and_vars - ~Problem.all_problem_vars - ~Problem.all_system_references - ~Problem.all_variable_refs - ~Problem.all_variables - ~Problem.attr_inst - ~Problem.check_dynamics - ~Problem.copy_system - ~Problem.dataframe - ~Problem.dataframe_constants - ~Problem.dataframe_variants - ~Problem.dynamic_comps - ~Problem.dynamic_rate - ~Problem.dynamic_rate_eq - ~Problem.dynamic_solve - ~Problem.dynamic_state - ~Problem.enter_refresh - ~Problem.entered - ~Problem.exit_on_failure - ~Problem.exited - ~Problem.fail_revert - ~Problem.final_objectives - ~Problem.identity - ~Problem.integrator_rate_refs - ~Problem.integrator_rates - ~Problem.integrator_var_refs - ~Problem.integrator_vars - ~Problem.integrators - ~Problem.is_active - ~Problem.kwargs - ~Problem.level_name - ~Problem.level_number - ~Problem.log_level - ~Problem.opt_fail - ~Problem.output_state - ~Problem.post_callback - ~Problem.post_exec - ~Problem.pre_exec - ~Problem.problem_eq - ~Problem.problem_id - ~Problem.problem_ineq - ~Problem.problem_input - ~Problem.problem_objs - ~Problem.problem_opt_vars - ~Problem.problems_dict - ~Problem.raise_on_unknown - ~Problem.record_state - ~Problem.ref_attrs - ~Problem.revert_every - ~Problem.revert_last - ~Problem.run_solver - ~Problem.save_mode - ~Problem.save_on_exit - ~Problem.sesh - ~Problem.session_id - ~Problem.signal_inst - ~Problem.signals - ~Problem.signals_source - ~Problem.signals_target - ~Problem.skip_plot_vars - ~Problem.solveable - ~Problem.solver_inst - ~Problem.success_thresh - ~Problem.system - ~Problem.session - ~Problem.x_start - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.problem_context.ProblemExec.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.problem_context.ProblemExec.rst.txt deleted file mode 100644 index 09e8b7b..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.problem_context.ProblemExec.rst.txt +++ /dev/null @@ -1,141 +0,0 @@ -engforge.problem\_context.ProblemExec -===================================== - -.. currentmodule:: engforge.problem_context - -.. autoclass:: ProblemExec - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~ProblemExec.activate_temp_state - ~ProblemExec.apply_post_signals - ~ProblemExec.apply_pre_signals - ~ProblemExec.clean_context - ~ProblemExec.critical - ~ProblemExec.debug - ~ProblemExec.debug_levels - ~ProblemExec.discard_contexts - ~ProblemExec.error - ~ProblemExec.error_action - ~ProblemExec.establish_system - ~ProblemExec.exit_action - ~ProblemExec.exit_and_revert - ~ProblemExec.exit_to_level - ~ProblemExec.exit_with_state - ~ProblemExec.filter_vars - ~ProblemExec.get_extra_kws - ~ProblemExec.get_parent_key - ~ProblemExec.get_ref_values - ~ProblemExec.get_sesh - ~ProblemExec.handle_solution - ~ProblemExec.info - ~ProblemExec.integral_rate - ~ProblemExec.integrate - ~ProblemExec.min_refresh - ~ProblemExec.msg - ~ProblemExec.parse_default - ~ProblemExec.persist_contexts - ~ProblemExec.pos_obj - ~ProblemExec.post_execute - ~ProblemExec.post_update_system - ~ProblemExec.pre_execute - ~ProblemExec.refresh_references - ~ProblemExec.reset_contexts - ~ProblemExec.reset_data - ~ProblemExec.revert_to_start - ~ProblemExec.save_data - ~ProblemExec.set_checkpoint - ~ProblemExec.set_ref_values - ~ProblemExec.set_time - ~ProblemExec.solve_min - ~ProblemExec.sys_solver_constraints - ~ProblemExec.sys_solver_objectives - ~ProblemExec.update_dynamics - ~ProblemExec.update_methods - ~ProblemExec.update_system - ~ProblemExec.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ProblemExec.all_components - ~ProblemExec.all_comps - ~ProblemExec.all_comps_and_vars - ~ProblemExec.all_problem_vars - ~ProblemExec.all_system_references - ~ProblemExec.all_variable_refs - ~ProblemExec.all_variables - ~ProblemExec.attr_inst - ~ProblemExec.check_dynamics - ~ProblemExec.copy_system - ~ProblemExec.dataframe - ~ProblemExec.dynamic_comps - ~ProblemExec.dynamic_rate - ~ProblemExec.dynamic_rate_eq - ~ProblemExec.dynamic_solve - ~ProblemExec.dynamic_state - ~ProblemExec.enter_refresh - ~ProblemExec.entered - ~ProblemExec.exit_on_failure - ~ProblemExec.exited - ~ProblemExec.fail_revert - ~ProblemExec.final_objectives - ~ProblemExec.identity - ~ProblemExec.integrator_rate_refs - ~ProblemExec.integrator_rates - ~ProblemExec.integrator_var_refs - ~ProblemExec.integrator_vars - ~ProblemExec.integrators - ~ProblemExec.is_active - ~ProblemExec.kwargs - ~ProblemExec.level_name - ~ProblemExec.level_number - ~ProblemExec.log_level - ~ProblemExec.opt_fail - ~ProblemExec.output_state - ~ProblemExec.post_callback - ~ProblemExec.post_exec - ~ProblemExec.pre_exec - ~ProblemExec.problem_eq - ~ProblemExec.problem_id - ~ProblemExec.problem_ineq - ~ProblemExec.problem_input - ~ProblemExec.problem_objs - ~ProblemExec.problem_opt_vars - ~ProblemExec.problems_dict - ~ProblemExec.raise_on_unknown - ~ProblemExec.record_state - ~ProblemExec.ref_attrs - ~ProblemExec.revert_every - ~ProblemExec.revert_last - ~ProblemExec.run_solver - ~ProblemExec.save_mode - ~ProblemExec.save_on_exit - ~ProblemExec.sesh - ~ProblemExec.session_id - ~ProblemExec.signal_inst - ~ProblemExec.signals - ~ProblemExec.signals_source - ~ProblemExec.signals_target - ~ProblemExec.solveable - ~ProblemExec.solver_inst - ~ProblemExec.success_thresh - ~ProblemExec.system - ~ProblemExec.session - ~ProblemExec.x_start - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.problem_context.ProblemExit.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.problem_context.ProblemExit.rst.txt deleted file mode 100644 index fc01363..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.problem_context.ProblemExit.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.problem\_context.ProblemExit -===================================== - -.. currentmodule:: engforge.problem_context - -.. autoexception:: ProblemExit \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.problem_context.ProblemExitAtLevel.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.problem_context.ProblemExitAtLevel.rst.txt deleted file mode 100644 index 865a2d1..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.problem_context.ProblemExitAtLevel.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.problem\_context.ProblemExitAtLevel -============================================ - -.. currentmodule:: engforge.problem_context - -.. autoexception:: ProblemExitAtLevel \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.problem_context.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.problem_context.rst.txt deleted file mode 100644 index 626a747..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.problem_context.rst.txt +++ /dev/null @@ -1,43 +0,0 @@ -engforge.problem\_context -========================= - -.. automodule:: engforge.problem_context - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - ProbLog - Problem - ProblemExec - - - - - - .. rubric:: Exceptions - - .. autosummary:: - :toctree: - - IllegalArgument - ProblemExit - ProblemExitAtLevel - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.properties.PropertyLog.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.properties.PropertyLog.rst.txt deleted file mode 100644 index eba112c..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.properties.PropertyLog.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.properties.PropertyLog -=============================== - -.. currentmodule:: engforge.properties - -.. autoclass:: PropertyLog - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~PropertyLog.add_fields - ~PropertyLog.change_all_log_lvl - ~PropertyLog.critical - ~PropertyLog.debug - ~PropertyLog.error - ~PropertyLog.extract_message - ~PropertyLog.filter - ~PropertyLog.info - ~PropertyLog.installSTDLogger - ~PropertyLog.message_with_identiy - ~PropertyLog.msg - ~PropertyLog.resetLog - ~PropertyLog.resetSystemLogs - ~PropertyLog.slack_notification - ~PropertyLog.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~PropertyLog.identity - ~PropertyLog.log_fmt - ~PropertyLog.log_level - ~PropertyLog.log_on - ~PropertyLog.logger - ~PropertyLog.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.properties.cache_prop.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.properties.cache_prop.rst.txt deleted file mode 100644 index 559e543..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.properties.cache_prop.rst.txt +++ /dev/null @@ -1,36 +0,0 @@ -engforge.properties.cache\_prop -=============================== - -.. currentmodule:: engforge.properties - -.. autoclass:: cache_prop - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~cache_prop.deleter - ~cache_prop.get_func_return - ~cache_prop.getter - ~cache_prop.set_cache - ~cache_prop.setter - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~cache_prop.allow_set - ~cache_prop.must_return - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.properties.cached_sys_prop.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.properties.cached_sys_prop.rst.txt deleted file mode 100644 index 9264855..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.properties.cached_sys_prop.rst.txt +++ /dev/null @@ -1,38 +0,0 @@ -engforge.properties.cached\_sys\_prop -===================================== - -.. currentmodule:: engforge.properties - -.. autoclass:: cached_sys_prop - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~cached_sys_prop.deleter - ~cached_sys_prop.get_func_return - ~cached_sys_prop.getter - ~cached_sys_prop.setter - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~cached_sys_prop.desc - ~cached_sys_prop.label - ~cached_sys_prop.must_return - ~cached_sys_prop.return_type - ~cached_sys_prop.stochastic - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.properties.cached_system_prop.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.properties.cached_system_prop.rst.txt deleted file mode 100644 index 4566db5..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.properties.cached_system_prop.rst.txt +++ /dev/null @@ -1,38 +0,0 @@ -engforge.properties.cached\_system\_prop -======================================== - -.. currentmodule:: engforge.properties - -.. autoclass:: cached_system_prop - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~cached_system_prop.deleter - ~cached_system_prop.get_func_return - ~cached_system_prop.getter - ~cached_system_prop.setter - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~cached_system_prop.desc - ~cached_system_prop.label - ~cached_system_prop.must_return - ~cached_system_prop.return_type - ~cached_system_prop.stochastic - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.properties.cached_system_property.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.properties.cached_system_property.rst.txt deleted file mode 100644 index c8c0b3d..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.properties.cached_system_property.rst.txt +++ /dev/null @@ -1,41 +0,0 @@ -engforge.properties.cached\_system\_property -============================================ - -.. currentmodule:: engforge.properties - -.. autoclass:: cached_system_property - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~cached_system_property.deleter - ~cached_system_property.get_func_return - ~cached_system_property.getter - ~cached_system_property.set_cache - ~cached_system_property.setter - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~cached_system_property.desc - ~cached_system_property.label - ~cached_system_property.must_return - ~cached_system_property.private_var - ~cached_system_property.return_type - ~cached_system_property.stochastic - ~cached_system_property.gname - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.properties.class_cache.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.properties.class_cache.rst.txt deleted file mode 100644 index 0304229..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.properties.class_cache.rst.txt +++ /dev/null @@ -1,38 +0,0 @@ -engforge.properties.class\_cache -================================ - -.. currentmodule:: engforge.properties - -.. autoclass:: class_cache - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~class_cache.deleter - ~class_cache.get_func_return - ~class_cache.getter - ~class_cache.set_cache - ~class_cache.setter - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~class_cache.allow_set - ~class_cache.id_var - ~class_cache.must_return - ~class_cache.private_var - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.properties.engforge_prop.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.properties.engforge_prop.rst.txt deleted file mode 100644 index 0878e00..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.properties.engforge_prop.rst.txt +++ /dev/null @@ -1,34 +0,0 @@ -engforge.properties.engforge\_prop -================================== - -.. currentmodule:: engforge.properties - -.. autoclass:: engforge_prop - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~engforge_prop.deleter - ~engforge_prop.get_func_return - ~engforge_prop.getter - ~engforge_prop.setter - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~engforge_prop.must_return - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.properties.instance_cached.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.properties.instance_cached.rst.txt deleted file mode 100644 index b33ae0d..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.properties.instance_cached.rst.txt +++ /dev/null @@ -1,37 +0,0 @@ -engforge.properties.instance\_cached -==================================== - -.. currentmodule:: engforge.properties - -.. autoclass:: instance_cached - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~instance_cached.deleter - ~instance_cached.get_func_return - ~instance_cached.getter - ~instance_cached.set_cache - ~instance_cached.setter - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~instance_cached.allow_set - ~instance_cached.must_return - ~instance_cached.private_var - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.properties.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.properties.rst.txt deleted file mode 100644 index a3dc12c..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.properties.rst.txt +++ /dev/null @@ -1,43 +0,0 @@ -engforge.properties -=================== - -.. automodule:: engforge.properties - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - PropertyLog - cache_prop - cached_sys_prop - cached_system_prop - cached_system_property - class_cache - engforge_prop - instance_cached - solver_cached - sys_prop - system_prop - system_property - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.properties.solver_cached.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.properties.solver_cached.rst.txt deleted file mode 100644 index 7af80b8..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.properties.solver_cached.rst.txt +++ /dev/null @@ -1,37 +0,0 @@ -engforge.properties.solver\_cached -================================== - -.. currentmodule:: engforge.properties - -.. autoclass:: solver_cached - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~solver_cached.deleter - ~solver_cached.get_func_return - ~solver_cached.getter - ~solver_cached.set_cache - ~solver_cached.setter - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~solver_cached.allow_set - ~solver_cached.must_return - ~solver_cached.private_var - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.properties.sys_prop.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.properties.sys_prop.rst.txt deleted file mode 100644 index f5202c6..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.properties.sys_prop.rst.txt +++ /dev/null @@ -1,38 +0,0 @@ -engforge.properties.sys\_prop -============================= - -.. currentmodule:: engforge.properties - -.. autoclass:: sys_prop - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~sys_prop.deleter - ~sys_prop.get_func_return - ~sys_prop.getter - ~sys_prop.setter - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~sys_prop.desc - ~sys_prop.label - ~sys_prop.must_return - ~sys_prop.return_type - ~sys_prop.stochastic - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.properties.system_prop.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.properties.system_prop.rst.txt deleted file mode 100644 index d0816cc..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.properties.system_prop.rst.txt +++ /dev/null @@ -1,38 +0,0 @@ -engforge.properties.system\_prop -================================ - -.. currentmodule:: engforge.properties - -.. autoclass:: system_prop - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~system_prop.deleter - ~system_prop.get_func_return - ~system_prop.getter - ~system_prop.setter - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~system_prop.desc - ~system_prop.label - ~system_prop.must_return - ~system_prop.return_type - ~system_prop.stochastic - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.properties.system_property.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.properties.system_property.rst.txt deleted file mode 100644 index 7928014..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.properties.system_property.rst.txt +++ /dev/null @@ -1,38 +0,0 @@ -engforge.properties.system\_property -==================================== - -.. currentmodule:: engforge.properties - -.. autoclass:: system_property - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~system_property.deleter - ~system_property.get_func_return - ~system_property.getter - ~system_property.setter - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~system_property.desc - ~system_property.label - ~system_property.must_return - ~system_property.return_type - ~system_property.stochastic - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.reporting.CSVReporter.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.reporting.CSVReporter.rst.txt deleted file mode 100644 index 71f9eaf..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.reporting.CSVReporter.rst.txt +++ /dev/null @@ -1,61 +0,0 @@ -engforge.reporting.CSVReporter -============================== - -.. currentmodule:: engforge.reporting - -.. autoclass:: CSVReporter - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~CSVReporter.add_fields - ~CSVReporter.change_all_log_lvl - ~CSVReporter.check_config - ~CSVReporter.critical - ~CSVReporter.debug - ~CSVReporter.ensure_exists - ~CSVReporter.ensure_path - ~CSVReporter.error - ~CSVReporter.extract_message - ~CSVReporter.filter - ~CSVReporter.info - ~CSVReporter.installSTDLogger - ~CSVReporter.message_with_identiy - ~CSVReporter.msg - ~CSVReporter.resetLog - ~CSVReporter.resetSystemLogs - ~CSVReporter.slack_notification - ~CSVReporter.subclasses - ~CSVReporter.upload - ~CSVReporter.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~CSVReporter.date_key - ~CSVReporter.identity - ~CSVReporter.log_fmt - ~CSVReporter.log_level - ~CSVReporter.log_on - ~CSVReporter.logger - ~CSVReporter.month_key - ~CSVReporter.name - ~CSVReporter.path - ~CSVReporter.report_mode - ~CSVReporter.report_root - ~CSVReporter.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.reporting.DiskPlotReporter.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.reporting.DiskPlotReporter.rst.txt deleted file mode 100644 index 7cdcf02..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.reporting.DiskPlotReporter.rst.txt +++ /dev/null @@ -1,62 +0,0 @@ -engforge.reporting.DiskPlotReporter -=================================== - -.. currentmodule:: engforge.reporting - -.. autoclass:: DiskPlotReporter - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~DiskPlotReporter.add_fields - ~DiskPlotReporter.change_all_log_lvl - ~DiskPlotReporter.check_config - ~DiskPlotReporter.critical - ~DiskPlotReporter.debug - ~DiskPlotReporter.ensure_exists - ~DiskPlotReporter.ensure_path - ~DiskPlotReporter.error - ~DiskPlotReporter.extract_message - ~DiskPlotReporter.filter - ~DiskPlotReporter.info - ~DiskPlotReporter.installSTDLogger - ~DiskPlotReporter.message_with_identiy - ~DiskPlotReporter.msg - ~DiskPlotReporter.resetLog - ~DiskPlotReporter.resetSystemLogs - ~DiskPlotReporter.slack_notification - ~DiskPlotReporter.subclasses - ~DiskPlotReporter.upload - ~DiskPlotReporter.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~DiskPlotReporter.date_key - ~DiskPlotReporter.ext - ~DiskPlotReporter.identity - ~DiskPlotReporter.log_fmt - ~DiskPlotReporter.log_level - ~DiskPlotReporter.log_on - ~DiskPlotReporter.logger - ~DiskPlotReporter.month_key - ~DiskPlotReporter.name - ~DiskPlotReporter.path - ~DiskPlotReporter.report_mode - ~DiskPlotReporter.report_root - ~DiskPlotReporter.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.reporting.DiskReporterMixin.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.reporting.DiskReporterMixin.rst.txt deleted file mode 100644 index 546a3bf..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.reporting.DiskReporterMixin.rst.txt +++ /dev/null @@ -1,61 +0,0 @@ -engforge.reporting.DiskReporterMixin -==================================== - -.. currentmodule:: engforge.reporting - -.. autoclass:: DiskReporterMixin - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~DiskReporterMixin.add_fields - ~DiskReporterMixin.change_all_log_lvl - ~DiskReporterMixin.check_config - ~DiskReporterMixin.critical - ~DiskReporterMixin.debug - ~DiskReporterMixin.ensure_exists - ~DiskReporterMixin.ensure_path - ~DiskReporterMixin.error - ~DiskReporterMixin.extract_message - ~DiskReporterMixin.filter - ~DiskReporterMixin.info - ~DiskReporterMixin.installSTDLogger - ~DiskReporterMixin.message_with_identiy - ~DiskReporterMixin.msg - ~DiskReporterMixin.resetLog - ~DiskReporterMixin.resetSystemLogs - ~DiskReporterMixin.slack_notification - ~DiskReporterMixin.subclasses - ~DiskReporterMixin.upload - ~DiskReporterMixin.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~DiskReporterMixin.path - ~DiskReporterMixin.report_mode - ~DiskReporterMixin.date_key - ~DiskReporterMixin.identity - ~DiskReporterMixin.log_fmt - ~DiskReporterMixin.log_level - ~DiskReporterMixin.log_on - ~DiskReporterMixin.logger - ~DiskReporterMixin.month_key - ~DiskReporterMixin.name - ~DiskReporterMixin.report_root - ~DiskReporterMixin.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.reporting.ExcelReporter.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.reporting.ExcelReporter.rst.txt deleted file mode 100644 index 2c195e4..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.reporting.ExcelReporter.rst.txt +++ /dev/null @@ -1,61 +0,0 @@ -engforge.reporting.ExcelReporter -================================ - -.. currentmodule:: engforge.reporting - -.. autoclass:: ExcelReporter - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~ExcelReporter.add_fields - ~ExcelReporter.change_all_log_lvl - ~ExcelReporter.check_config - ~ExcelReporter.critical - ~ExcelReporter.debug - ~ExcelReporter.ensure_exists - ~ExcelReporter.ensure_path - ~ExcelReporter.error - ~ExcelReporter.extract_message - ~ExcelReporter.filter - ~ExcelReporter.info - ~ExcelReporter.installSTDLogger - ~ExcelReporter.message_with_identiy - ~ExcelReporter.msg - ~ExcelReporter.resetLog - ~ExcelReporter.resetSystemLogs - ~ExcelReporter.slack_notification - ~ExcelReporter.subclasses - ~ExcelReporter.upload - ~ExcelReporter.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~ExcelReporter.date_key - ~ExcelReporter.identity - ~ExcelReporter.log_fmt - ~ExcelReporter.log_level - ~ExcelReporter.log_on - ~ExcelReporter.logger - ~ExcelReporter.month_key - ~ExcelReporter.name - ~ExcelReporter.path - ~ExcelReporter.report_mode - ~ExcelReporter.report_root - ~ExcelReporter.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.reporting.GdriveReporter.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.reporting.GdriveReporter.rst.txt deleted file mode 100644 index e51b69f..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.reporting.GdriveReporter.rst.txt +++ /dev/null @@ -1,59 +0,0 @@ -engforge.reporting.GdriveReporter -================================= - -.. currentmodule:: engforge.reporting - -.. autoclass:: GdriveReporter - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~GdriveReporter.add_fields - ~GdriveReporter.change_all_log_lvl - ~GdriveReporter.check_config - ~GdriveReporter.critical - ~GdriveReporter.debug - ~GdriveReporter.error - ~GdriveReporter.extract_message - ~GdriveReporter.filter - ~GdriveReporter.info - ~GdriveReporter.installSTDLogger - ~GdriveReporter.message_with_identiy - ~GdriveReporter.msg - ~GdriveReporter.resetLog - ~GdriveReporter.resetSystemLogs - ~GdriveReporter.slack_notification - ~GdriveReporter.subclasses - ~GdriveReporter.upload - ~GdriveReporter.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~GdriveReporter.share_drive - ~GdriveReporter.date_key - ~GdriveReporter.ext - ~GdriveReporter.identity - ~GdriveReporter.log_fmt - ~GdriveReporter.log_level - ~GdriveReporter.log_on - ~GdriveReporter.logger - ~GdriveReporter.month_key - ~GdriveReporter.name - ~GdriveReporter.report_root - ~GdriveReporter.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.reporting.GsheetsReporter.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.reporting.GsheetsReporter.rst.txt deleted file mode 100644 index 129b84f..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.reporting.GsheetsReporter.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -engforge.reporting.GsheetsReporter -================================== - -.. currentmodule:: engforge.reporting - -.. autoclass:: GsheetsReporter - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~GsheetsReporter.add_fields - ~GsheetsReporter.change_all_log_lvl - ~GsheetsReporter.check_config - ~GsheetsReporter.critical - ~GsheetsReporter.debug - ~GsheetsReporter.error - ~GsheetsReporter.extract_message - ~GsheetsReporter.filter - ~GsheetsReporter.info - ~GsheetsReporter.installSTDLogger - ~GsheetsReporter.message_with_identiy - ~GsheetsReporter.msg - ~GsheetsReporter.resetLog - ~GsheetsReporter.resetSystemLogs - ~GsheetsReporter.slack_notification - ~GsheetsReporter.subclasses - ~GsheetsReporter.upload - ~GsheetsReporter.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~GsheetsReporter.date_key - ~GsheetsReporter.identity - ~GsheetsReporter.log_fmt - ~GsheetsReporter.log_level - ~GsheetsReporter.log_on - ~GsheetsReporter.logger - ~GsheetsReporter.month_key - ~GsheetsReporter.name - ~GsheetsReporter.report_root - ~GsheetsReporter.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.reporting.PlotReporter.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.reporting.PlotReporter.rst.txt deleted file mode 100644 index a2fdfec..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.reporting.PlotReporter.rst.txt +++ /dev/null @@ -1,55 +0,0 @@ -engforge.reporting.PlotReporter -=============================== - -.. currentmodule:: engforge.reporting - -.. autoclass:: PlotReporter - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~PlotReporter.add_fields - ~PlotReporter.change_all_log_lvl - ~PlotReporter.check_config - ~PlotReporter.critical - ~PlotReporter.debug - ~PlotReporter.error - ~PlotReporter.extract_message - ~PlotReporter.filter - ~PlotReporter.info - ~PlotReporter.installSTDLogger - ~PlotReporter.message_with_identiy - ~PlotReporter.msg - ~PlotReporter.resetLog - ~PlotReporter.resetSystemLogs - ~PlotReporter.slack_notification - ~PlotReporter.subclasses - ~PlotReporter.upload - ~PlotReporter.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~PlotReporter.ext - ~PlotReporter.identity - ~PlotReporter.log_fmt - ~PlotReporter.log_level - ~PlotReporter.log_on - ~PlotReporter.logger - ~PlotReporter.name - ~PlotReporter.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.reporting.Reporter.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.reporting.Reporter.rst.txt deleted file mode 100644 index b89295f..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.reporting.Reporter.rst.txt +++ /dev/null @@ -1,54 +0,0 @@ -engforge.reporting.Reporter -=========================== - -.. currentmodule:: engforge.reporting - -.. autoclass:: Reporter - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Reporter.add_fields - ~Reporter.change_all_log_lvl - ~Reporter.check_config - ~Reporter.critical - ~Reporter.debug - ~Reporter.error - ~Reporter.extract_message - ~Reporter.filter - ~Reporter.info - ~Reporter.installSTDLogger - ~Reporter.message_with_identiy - ~Reporter.msg - ~Reporter.resetLog - ~Reporter.resetSystemLogs - ~Reporter.slack_notification - ~Reporter.subclasses - ~Reporter.upload - ~Reporter.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Reporter.name - ~Reporter.identity - ~Reporter.log_fmt - ~Reporter.log_level - ~Reporter.log_on - ~Reporter.logger - ~Reporter.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.reporting.TableReporter.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.reporting.TableReporter.rst.txt deleted file mode 100644 index 7ee1f0b..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.reporting.TableReporter.rst.txt +++ /dev/null @@ -1,54 +0,0 @@ -engforge.reporting.TableReporter -================================ - -.. currentmodule:: engforge.reporting - -.. autoclass:: TableReporter - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~TableReporter.add_fields - ~TableReporter.change_all_log_lvl - ~TableReporter.check_config - ~TableReporter.critical - ~TableReporter.debug - ~TableReporter.error - ~TableReporter.extract_message - ~TableReporter.filter - ~TableReporter.info - ~TableReporter.installSTDLogger - ~TableReporter.message_with_identiy - ~TableReporter.msg - ~TableReporter.resetLog - ~TableReporter.resetSystemLogs - ~TableReporter.slack_notification - ~TableReporter.subclasses - ~TableReporter.upload - ~TableReporter.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~TableReporter.identity - ~TableReporter.log_fmt - ~TableReporter.log_level - ~TableReporter.log_on - ~TableReporter.logger - ~TableReporter.name - ~TableReporter.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.reporting.TemporalReporterMixin.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.reporting.TemporalReporterMixin.rst.txt deleted file mode 100644 index f6404f5..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.reporting.TemporalReporterMixin.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -engforge.reporting.TemporalReporterMixin -======================================== - -.. currentmodule:: engforge.reporting - -.. autoclass:: TemporalReporterMixin - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~TemporalReporterMixin.add_fields - ~TemporalReporterMixin.change_all_log_lvl - ~TemporalReporterMixin.check_config - ~TemporalReporterMixin.critical - ~TemporalReporterMixin.debug - ~TemporalReporterMixin.error - ~TemporalReporterMixin.extract_message - ~TemporalReporterMixin.filter - ~TemporalReporterMixin.info - ~TemporalReporterMixin.installSTDLogger - ~TemporalReporterMixin.message_with_identiy - ~TemporalReporterMixin.msg - ~TemporalReporterMixin.resetLog - ~TemporalReporterMixin.resetSystemLogs - ~TemporalReporterMixin.slack_notification - ~TemporalReporterMixin.subclasses - ~TemporalReporterMixin.upload - ~TemporalReporterMixin.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~TemporalReporterMixin.date_key - ~TemporalReporterMixin.identity - ~TemporalReporterMixin.log_fmt - ~TemporalReporterMixin.log_level - ~TemporalReporterMixin.log_on - ~TemporalReporterMixin.logger - ~TemporalReporterMixin.month_key - ~TemporalReporterMixin.name - ~TemporalReporterMixin.report_root - ~TemporalReporterMixin.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.reporting.path_exist_validator.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.reporting.path_exist_validator.rst.txt deleted file mode 100644 index 2269d39..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.reporting.path_exist_validator.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.reporting.path\_exist\_validator -========================================= - -.. currentmodule:: engforge.reporting - -.. autofunction:: path_exist_validator \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.reporting.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.reporting.rst.txt deleted file mode 100644 index 935d5fa..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.reporting.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -engforge.reporting -================== - -.. automodule:: engforge.reporting - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - path_exist_validator - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - CSVReporter - DiskPlotReporter - DiskReporterMixin - ExcelReporter - GdriveReporter - GsheetsReporter - PlotReporter - Reporter - TableReporter - TemporalReporterMixin - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.rst.txt deleted file mode 100644 index 08d5fbf..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.rst.txt +++ /dev/null @@ -1,59 +0,0 @@ -engforge -======== - -.. automodule:: engforge - - - - - - - - - - - - - - - - - - - -.. autosummary:: - :toctree: - :template: custom-module-template.rst - :recursive: - - analysis - attr_dynamics - attr_plotting - attr_signals - attr_slots - attr_solver - attributes - common - component_collections - components - configuration - dataframe - datastores - dynamics - eng - engforge_attributes - env_var - locations - logging - patterns - problem_context - properties - reporting - solveable - solver - solver_utils - system - system_reference - tabulation - typing - diff --git a/docs/_build/html/_sources/_autosummary/engforge.solveable.SolvableLog.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solveable.SolvableLog.rst.txt deleted file mode 100644 index 777f8f2..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solveable.SolvableLog.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.solveable.SolvableLog -============================== - -.. currentmodule:: engforge.solveable - -.. autoclass:: SolvableLog - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~SolvableLog.add_fields - ~SolvableLog.change_all_log_lvl - ~SolvableLog.critical - ~SolvableLog.debug - ~SolvableLog.error - ~SolvableLog.extract_message - ~SolvableLog.filter - ~SolvableLog.info - ~SolvableLog.installSTDLogger - ~SolvableLog.message_with_identiy - ~SolvableLog.msg - ~SolvableLog.resetLog - ~SolvableLog.resetSystemLogs - ~SolvableLog.slack_notification - ~SolvableLog.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~SolvableLog.identity - ~SolvableLog.log_fmt - ~SolvableLog.log_level - ~SolvableLog.log_on - ~SolvableLog.logger - ~SolvableLog.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.solveable.SolveableMixin.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solveable.SolveableMixin.rst.txt deleted file mode 100644 index fa05541..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solveable.SolveableMixin.rst.txt +++ /dev/null @@ -1,95 +0,0 @@ -engforge.solveable.SolveableMixin -================================= - -.. currentmodule:: engforge.solveable - -.. autoclass:: SolveableMixin - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~SolveableMixin.add_fields - ~SolveableMixin.change_all_log_lvl - ~SolveableMixin.check_ref_slot_type - ~SolveableMixin.collect_all_attributes - ~SolveableMixin.collect_comp_refs - ~SolveableMixin.collect_dynamic_refs - ~SolveableMixin.collect_inst_attributes - ~SolveableMixin.collect_post_update_refs - ~SolveableMixin.collect_solver_refs - ~SolveableMixin.collect_update_refs - ~SolveableMixin.comp_references - ~SolveableMixin.critical - ~SolveableMixin.debug - ~SolveableMixin.difference - ~SolveableMixin.error - ~SolveableMixin.extract_message - ~SolveableMixin.filter - ~SolveableMixin.get_system_input_refs - ~SolveableMixin.info - ~SolveableMixin.input_attrs - ~SolveableMixin.input_fields - ~SolveableMixin.installSTDLogger - ~SolveableMixin.internal_components - ~SolveableMixin.internal_references - ~SolveableMixin.internal_systems - ~SolveableMixin.internal_tabulations - ~SolveableMixin.locate - ~SolveableMixin.locate_ref - ~SolveableMixin.message_with_identiy - ~SolveableMixin.msg - ~SolveableMixin.numeric_fields - ~SolveableMixin.parse_run_kwargs - ~SolveableMixin.parse_simulation_input - ~SolveableMixin.plot_attributes - ~SolveableMixin.post_update - ~SolveableMixin.resetLog - ~SolveableMixin.resetSystemLogs - ~SolveableMixin.setattrs - ~SolveableMixin.signals_attributes - ~SolveableMixin.slack_notification - ~SolveableMixin.slot_refs - ~SolveableMixin.slots_attributes - ~SolveableMixin.solvers_attributes - ~SolveableMixin.system_references - ~SolveableMixin.table_fields - ~SolveableMixin.trace_attributes - ~SolveableMixin.transients_attributes - ~SolveableMixin.update - ~SolveableMixin.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~SolveableMixin.as_dict - ~SolveableMixin.attrs_fields - ~SolveableMixin.identity - ~SolveableMixin.input_as_dict - ~SolveableMixin.iterable_components - ~SolveableMixin.log_fmt - ~SolveableMixin.log_level - ~SolveableMixin.log_on - ~SolveableMixin.logger - ~SolveableMixin.numeric_as_dict - ~SolveableMixin.numeric_hash - ~SolveableMixin.signals - ~SolveableMixin.slack_webhook_url - ~SolveableMixin.solvers - ~SolveableMixin.transients - ~SolveableMixin.unique_hash - ~SolveableMixin.parent - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.solveable.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solveable.rst.txt deleted file mode 100644 index 2a6df64..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solveable.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -engforge.solveable -================== - -.. automodule:: engforge.solveable - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - SolvableLog - SolveableMixin - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.solver.SolverLog.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solver.SolverLog.rst.txt deleted file mode 100644 index c638646..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solver.SolverLog.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.solver.SolverLog -========================= - -.. currentmodule:: engforge.solver - -.. autoclass:: SolverLog - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~SolverLog.add_fields - ~SolverLog.change_all_log_lvl - ~SolverLog.critical - ~SolverLog.debug - ~SolverLog.error - ~SolverLog.extract_message - ~SolverLog.filter - ~SolverLog.info - ~SolverLog.installSTDLogger - ~SolverLog.message_with_identiy - ~SolverLog.msg - ~SolverLog.resetLog - ~SolverLog.resetSystemLogs - ~SolverLog.slack_notification - ~SolverLog.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~SolverLog.identity - ~SolverLog.log_fmt - ~SolverLog.log_level - ~SolverLog.log_on - ~SolverLog.logger - ~SolverLog.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.solver.SolverMixin.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solver.SolverMixin.rst.txt deleted file mode 100644 index ae5c404..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solver.SolverMixin.rst.txt +++ /dev/null @@ -1,101 +0,0 @@ -engforge.solver.SolverMixin -=========================== - -.. currentmodule:: engforge.solver - -.. autoclass:: SolverMixin - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~SolverMixin.add_fields - ~SolverMixin.change_all_log_lvl - ~SolverMixin.check_ref_slot_type - ~SolverMixin.collect_all_attributes - ~SolverMixin.collect_comp_refs - ~SolverMixin.collect_dynamic_refs - ~SolverMixin.collect_inst_attributes - ~SolverMixin.collect_post_update_refs - ~SolverMixin.collect_solver_refs - ~SolverMixin.collect_update_refs - ~SolverMixin.comp_references - ~SolverMixin.critical - ~SolverMixin.debug - ~SolverMixin.difference - ~SolverMixin.error - ~SolverMixin.eval - ~SolverMixin.execute - ~SolverMixin.extract_message - ~SolverMixin.filter - ~SolverMixin.get_system_input_refs - ~SolverMixin.info - ~SolverMixin.input_attrs - ~SolverMixin.input_fields - ~SolverMixin.installSTDLogger - ~SolverMixin.internal_components - ~SolverMixin.internal_references - ~SolverMixin.internal_systems - ~SolverMixin.internal_tabulations - ~SolverMixin.locate - ~SolverMixin.locate_ref - ~SolverMixin.message_with_identiy - ~SolverMixin.msg - ~SolverMixin.numeric_fields - ~SolverMixin.parse_run_kwargs - ~SolverMixin.parse_simulation_input - ~SolverMixin.plot_attributes - ~SolverMixin.post_run_callback - ~SolverMixin.post_update - ~SolverMixin.pre_run_callback - ~SolverMixin.resetLog - ~SolverMixin.resetSystemLogs - ~SolverMixin.run - ~SolverMixin.run_internal_systems - ~SolverMixin.setattrs - ~SolverMixin.signals_attributes - ~SolverMixin.slack_notification - ~SolverMixin.slot_refs - ~SolverMixin.slots_attributes - ~SolverMixin.solver - ~SolverMixin.solver_vars - ~SolverMixin.solvers_attributes - ~SolverMixin.system_references - ~SolverMixin.table_fields - ~SolverMixin.trace_attributes - ~SolverMixin.transients_attributes - ~SolverMixin.update - ~SolverMixin.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~SolverMixin.as_dict - ~SolverMixin.attrs_fields - ~SolverMixin.data_dict - ~SolverMixin.identity - ~SolverMixin.input_as_dict - ~SolverMixin.log_fmt - ~SolverMixin.log_level - ~SolverMixin.log_on - ~SolverMixin.logger - ~SolverMixin.numeric_as_dict - ~SolverMixin.numeric_hash - ~SolverMixin.slack_webhook_url - ~SolverMixin.solved - ~SolverMixin.unique_hash - ~SolverMixin.parent - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.solver.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solver.rst.txt deleted file mode 100644 index 1829552..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solver.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -engforge.solver -=============== - -.. automodule:: engforge.solver - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - SolverLog - SolverMixin - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.SolverUtilLog.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solver_utils.SolverUtilLog.rst.txt deleted file mode 100644 index 9fdb85b..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.SolverUtilLog.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.solver\_utils.SolverUtilLog -==================================== - -.. currentmodule:: engforge.solver_utils - -.. autoclass:: SolverUtilLog - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~SolverUtilLog.add_fields - ~SolverUtilLog.change_all_log_lvl - ~SolverUtilLog.critical - ~SolverUtilLog.debug - ~SolverUtilLog.error - ~SolverUtilLog.extract_message - ~SolverUtilLog.filter - ~SolverUtilLog.info - ~SolverUtilLog.installSTDLogger - ~SolverUtilLog.message_with_identiy - ~SolverUtilLog.msg - ~SolverUtilLog.resetLog - ~SolverUtilLog.resetSystemLogs - ~SolverUtilLog.slack_notification - ~SolverUtilLog.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~SolverUtilLog.identity - ~SolverUtilLog.log_fmt - ~SolverUtilLog.log_level - ~SolverUtilLog.log_on - ~SolverUtilLog.logger - ~SolverUtilLog.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.arg_var_compare.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solver_utils.arg_var_compare.rst.txt deleted file mode 100644 index 060461a..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.arg_var_compare.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.solver\_utils.arg\_var\_compare -======================================== - -.. currentmodule:: engforge.solver_utils - -.. autofunction:: arg_var_compare \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.combo_filter.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solver_utils.combo_filter.rst.txt deleted file mode 100644 index b50e53c..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.combo_filter.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.solver\_utils.combo\_filter -==================================== - -.. currentmodule:: engforge.solver_utils - -.. autofunction:: combo_filter \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.create_constraint.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solver_utils.create_constraint.rst.txt deleted file mode 100644 index 3692a62..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.create_constraint.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.solver\_utils.create\_constraint -========================================= - -.. currentmodule:: engforge.solver_utils - -.. autofunction:: create_constraint \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.ext_str_list.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solver_utils.ext_str_list.rst.txt deleted file mode 100644 index a491b84..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.ext_str_list.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.solver\_utils.ext\_str\_list -===================================== - -.. currentmodule:: engforge.solver_utils - -.. autofunction:: ext_str_list \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.f_lin_min.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solver_utils.f_lin_min.rst.txt deleted file mode 100644 index 0670101..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.f_lin_min.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.solver\_utils.f\_lin\_min -================================== - -.. currentmodule:: engforge.solver_utils - -.. autofunction:: f_lin_min \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.filt_active.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solver_utils.filt_active.rst.txt deleted file mode 100644 index 245d8e2..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.filt_active.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.solver\_utils.filt\_active -=================================== - -.. currentmodule:: engforge.solver_utils - -.. autofunction:: filt_active \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.filter_combos.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solver_utils.filter_combos.rst.txt deleted file mode 100644 index b6fe5bd..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.filter_combos.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.solver\_utils.filter\_combos -===================================== - -.. currentmodule:: engforge.solver_utils - -.. autofunction:: filter_combos \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.filter_vals.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solver_utils.filter_vals.rst.txt deleted file mode 100644 index b961d82..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.filter_vals.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.solver\_utils.filter\_vals -=================================== - -.. currentmodule:: engforge.solver_utils - -.. autofunction:: filter_vals \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.handle_normalize.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solver_utils.handle_normalize.rst.txt deleted file mode 100644 index dfb5b15..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.handle_normalize.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.solver\_utils.handle\_normalize -======================================== - -.. currentmodule:: engforge.solver_utils - -.. autofunction:: handle_normalize \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.objectify.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solver_utils.objectify.rst.txt deleted file mode 100644 index aff51db..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.objectify.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.solver\_utils.objectify -================================ - -.. currentmodule:: engforge.solver_utils - -.. autofunction:: objectify \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.ref_to_val_constraint.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solver_utils.ref_to_val_constraint.rst.txt deleted file mode 100644 index 1f44791..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.ref_to_val_constraint.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.solver\_utils.ref\_to\_val\_constraint -=============================================== - -.. currentmodule:: engforge.solver_utils - -.. autofunction:: ref_to_val_constraint \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.refmin_solve.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solver_utils.refmin_solve.rst.txt deleted file mode 100644 index adb8aa2..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.refmin_solve.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.solver\_utils.refmin\_solve -==================================== - -.. currentmodule:: engforge.solver_utils - -.. autofunction:: refmin_solve \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solver_utils.rst.txt deleted file mode 100644 index a68591d..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.rst.txt +++ /dev/null @@ -1,53 +0,0 @@ -engforge.solver\_utils -====================== - -.. automodule:: engforge.solver_utils - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - arg_var_compare - combo_filter - create_constraint - ext_str_list - f_lin_min - filt_active - filter_combos - filter_vals - handle_normalize - objectify - ref_to_val_constraint - refmin_solve - secondary_obj - str_list_f - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - SolverUtilLog - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.secondary_obj.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solver_utils.secondary_obj.rst.txt deleted file mode 100644 index 794291f..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.secondary_obj.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.solver\_utils.secondary\_obj -===================================== - -.. currentmodule:: engforge.solver_utils - -.. autofunction:: secondary_obj \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.str_list_f.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.solver_utils.str_list_f.rst.txt deleted file mode 100644 index 608090c..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.solver_utils.str_list_f.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.solver\_utils.str\_list\_f -=================================== - -.. currentmodule:: engforge.solver_utils - -.. autofunction:: str_list_f \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.system.System.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.system.System.rst.txt deleted file mode 100644 index 5577434..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.system.System.rst.txt +++ /dev/null @@ -1,190 +0,0 @@ -engforge.system.System -====================== - -.. currentmodule:: engforge.system - -.. autoclass:: System - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~System.add_fields - ~System.change_all_log_lvl - ~System.check_ref_slot_type - ~System.clone - ~System.cls_all_attrs_fields - ~System.cls_all_property_keys - ~System.cls_all_property_labels - ~System.cls_compile - ~System.collect_all_attributes - ~System.collect_comp_refs - ~System.collect_dynamic_refs - ~System.collect_inst_attributes - ~System.collect_post_update_refs - ~System.collect_solver_refs - ~System.collect_update_refs - ~System.comp_references - ~System.compile_classes - ~System.copy_config_at_state - ~System.create_dynamic_matricies - ~System.create_feedthrough_matrix - ~System.create_input_matrix - ~System.create_output_constants - ~System.create_output_matrix - ~System.create_state_constants - ~System.create_state_matrix - ~System.critical - ~System.debug - ~System.determine_nearest_stationary_state - ~System.difference - ~System.error - ~System.eval - ~System.execute - ~System.extract_message - ~System.filter - ~System.format_columns - ~System.get_system_input_refs - ~System.go_through_configurations - ~System.info - ~System.input_attrs - ~System.input_fields - ~System.installSTDLogger - ~System.internal_components - ~System.internal_configurations - ~System.internal_references - ~System.internal_systems - ~System.internal_tabulations - ~System.linear_output - ~System.linear_step - ~System.locate - ~System.locate_ref - ~System.make_plots - ~System.mark_all_comps_changed - ~System.message_with_identiy - ~System.msg - ~System.nonlinear_output - ~System.nonlinear_step - ~System.numeric_fields - ~System.parent_configurations_cls - ~System.parse_run_kwargs - ~System.parse_simulation_input - ~System.plot_attributes - ~System.post_run_callback - ~System.post_update - ~System.pre_compile - ~System.pre_run_callback - ~System.print_info - ~System.rate - ~System.rate_linear - ~System.rate_nonlinear - ~System.ref_dXdt - ~System.resetLog - ~System.resetSystemLogs - ~System.run - ~System.run_internal_systems - ~System.set_attr - ~System.set_time - ~System.setattrs - ~System.setup_global_dynamics - ~System.signals_attributes - ~System.sim_matrix - ~System.simulate - ~System.slack_notification - ~System.slot_refs - ~System.slots_attributes - ~System.smart_split_dataframe - ~System.solver - ~System.solver_vars - ~System.solvers_attributes - ~System.step - ~System.subclasses - ~System.subcls_compile - ~System.system_properties_classdef - ~System.system_references - ~System.table_fields - ~System.trace_attributes - ~System.transients_attributes - ~System.update - ~System.update_dynamics - ~System.update_feedthrough - ~System.update_input - ~System.update_output_constants - ~System.update_output_matrix - ~System.update_state - ~System.update_state_constants - ~System.validate_class - ~System.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~System.Ut_ref - ~System.Xt_ref - ~System.Yt_ref - ~System.anything_changed - ~System.as_dict - ~System.attrs_fields - ~System.classname - ~System.converged - ~System.dXtdt_ref - ~System.dataframe_constants - ~System.dataframe_variants - ~System.displayname - ~System.dynamic_A - ~System.dynamic_B - ~System.dynamic_C - ~System.dynamic_D - ~System.dynamic_F - ~System.dynamic_K - ~System.dynamic_input - ~System.dynamic_input_vars - ~System.dynamic_output - ~System.dynamic_output_vars - ~System.dynamic_state - ~System.dynamic_state_vars - ~System.filename - ~System.identity - ~System.input_as_dict - ~System.last_context - ~System.log_fmt - ~System.log_level - ~System.log_on - ~System.log_silo - ~System.logger - ~System.nonlinear - ~System.numeric_as_dict - ~System.numeric_hash - ~System.plotable_variables - ~System.run_id - ~System.skip_plot_vars - ~System.slack_webhook_url - ~System.solved - ~System.static_A - ~System.static_B - ~System.static_C - ~System.static_D - ~System.static_F - ~System.static_K - ~System.stored_plots - ~System.system_id - ~System.time - ~System.unique_hash - ~System.update_interval - ~System.parent - ~System.name - ~System.dataframe - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.system.SystemsLog.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.system.SystemsLog.rst.txt deleted file mode 100644 index 23423c5..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.system.SystemsLog.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.system.SystemsLog -========================== - -.. currentmodule:: engforge.system - -.. autoclass:: SystemsLog - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~SystemsLog.add_fields - ~SystemsLog.change_all_log_lvl - ~SystemsLog.critical - ~SystemsLog.debug - ~SystemsLog.error - ~SystemsLog.extract_message - ~SystemsLog.filter - ~SystemsLog.info - ~SystemsLog.installSTDLogger - ~SystemsLog.message_with_identiy - ~SystemsLog.msg - ~SystemsLog.resetLog - ~SystemsLog.resetSystemLogs - ~SystemsLog.slack_notification - ~SystemsLog.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~SystemsLog.identity - ~SystemsLog.log_fmt - ~SystemsLog.log_level - ~SystemsLog.log_on - ~SystemsLog.logger - ~SystemsLog.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.system.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.system.rst.txt deleted file mode 100644 index 9fa36ae..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.system.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -engforge.system -=============== - -.. automodule:: engforge.system - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - System - SystemsLog - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.system_reference.Ref.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.system_reference.Ref.rst.txt deleted file mode 100644 index 5f29cc4..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.system_reference.Ref.rst.txt +++ /dev/null @@ -1,44 +0,0 @@ -engforge.system\_reference.Ref -============================== - -.. currentmodule:: engforge.system_reference - -.. autoclass:: Ref - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~Ref.copy - ~Ref.refset_get - ~Ref.refset_input - ~Ref.set - ~Ref.set_value - ~Ref.setup_calls - ~Ref.value - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~Ref.comp - ~Ref.key - ~Ref.use_call - ~Ref.use_dict - ~Ref.allow_set - ~Ref.eval_f - ~Ref.key_override - ~Ref.hxd - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.system_reference.RefLog.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.system_reference.RefLog.rst.txt deleted file mode 100644 index 405b2f7..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.system_reference.RefLog.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.system\_reference.RefLog -================================= - -.. currentmodule:: engforge.system_reference - -.. autoclass:: RefLog - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~RefLog.add_fields - ~RefLog.change_all_log_lvl - ~RefLog.critical - ~RefLog.debug - ~RefLog.error - ~RefLog.extract_message - ~RefLog.filter - ~RefLog.info - ~RefLog.installSTDLogger - ~RefLog.message_with_identiy - ~RefLog.msg - ~RefLog.resetLog - ~RefLog.resetSystemLogs - ~RefLog.slack_notification - ~RefLog.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~RefLog.identity - ~RefLog.log_fmt - ~RefLog.log_level - ~RefLog.log_on - ~RefLog.logger - ~RefLog.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.system_reference.eval_ref.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.system_reference.eval_ref.rst.txt deleted file mode 100644 index b5ecd73..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.system_reference.eval_ref.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.system\_reference.eval\_ref -==================================== - -.. currentmodule:: engforge.system_reference - -.. autofunction:: eval_ref \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.system_reference.maybe_attr_inst.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.system_reference.maybe_attr_inst.rst.txt deleted file mode 100644 index 2e56478..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.system_reference.maybe_attr_inst.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.system\_reference.maybe\_attr\_inst -============================================ - -.. currentmodule:: engforge.system_reference - -.. autofunction:: maybe_attr_inst \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.system_reference.maybe_ref.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.system_reference.maybe_ref.rst.txt deleted file mode 100644 index 145f538..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.system_reference.maybe_ref.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.system\_reference.maybe\_ref -===================================== - -.. currentmodule:: engforge.system_reference - -.. autofunction:: maybe_ref \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.system_reference.refset_get.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.system_reference.refset_get.rst.txt deleted file mode 100644 index 5388b61..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.system_reference.refset_get.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.system\_reference.refset\_get -====================================== - -.. currentmodule:: engforge.system_reference - -.. autofunction:: refset_get \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.system_reference.refset_input.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.system_reference.refset_input.rst.txt deleted file mode 100644 index 7c3f3be..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.system_reference.refset_input.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.system\_reference.refset\_input -======================================== - -.. currentmodule:: engforge.system_reference - -.. autofunction:: refset_input \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.system_reference.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.system_reference.rst.txt deleted file mode 100644 index eb9d4e7..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.system_reference.rst.txt +++ /dev/null @@ -1,46 +0,0 @@ -engforge.system\_reference -========================== - -.. automodule:: engforge.system_reference - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - eval_ref - maybe_attr_inst - maybe_ref - refset_get - refset_input - scale_val - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - Ref - RefLog - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.system_reference.scale_val.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.system_reference.scale_val.rst.txt deleted file mode 100644 index 1e0d624..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.system_reference.scale_val.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.system\_reference.scale\_val -===================================== - -.. currentmodule:: engforge.system_reference - -.. autofunction:: scale_val \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.tabulation.TableLog.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.tabulation.TableLog.rst.txt deleted file mode 100644 index 7972d9b..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.tabulation.TableLog.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -engforge.tabulation.TableLog -============================ - -.. currentmodule:: engforge.tabulation - -.. autoclass:: TableLog - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~TableLog.add_fields - ~TableLog.change_all_log_lvl - ~TableLog.critical - ~TableLog.debug - ~TableLog.error - ~TableLog.extract_message - ~TableLog.filter - ~TableLog.info - ~TableLog.installSTDLogger - ~TableLog.message_with_identiy - ~TableLog.msg - ~TableLog.resetLog - ~TableLog.resetSystemLogs - ~TableLog.slack_notification - ~TableLog.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~TableLog.identity - ~TableLog.log_fmt - ~TableLog.log_level - ~TableLog.log_on - ~TableLog.logger - ~TableLog.slack_webhook_url - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.tabulation.TabulationMixin.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.tabulation.TabulationMixin.rst.txt deleted file mode 100644 index 5366412..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.tabulation.TabulationMixin.rst.txt +++ /dev/null @@ -1,118 +0,0 @@ -engforge.tabulation.TabulationMixin -=================================== - -.. currentmodule:: engforge.tabulation - -.. autoclass:: TabulationMixin - :members: - :show-inheritance: - :inherited-members: - :special-members: __call__, __add__, __mul__ - - - - .. rubric:: Methods - - .. autosummary:: - :nosignatures: - - ~TabulationMixin.add_fields - ~TabulationMixin.change_all_log_lvl - ~TabulationMixin.check_ref_slot_type - ~TabulationMixin.cls_all_attrs_fields - ~TabulationMixin.cls_all_property_keys - ~TabulationMixin.cls_all_property_labels - ~TabulationMixin.collect_all_attributes - ~TabulationMixin.collect_comp_refs - ~TabulationMixin.collect_dynamic_refs - ~TabulationMixin.collect_inst_attributes - ~TabulationMixin.collect_post_update_refs - ~TabulationMixin.collect_solver_refs - ~TabulationMixin.collect_update_refs - ~TabulationMixin.comp_references - ~TabulationMixin.critical - ~TabulationMixin.debug - ~TabulationMixin.difference - ~TabulationMixin.error - ~TabulationMixin.extract_message - ~TabulationMixin.filter - ~TabulationMixin.format_columns - ~TabulationMixin.get_system_input_refs - ~TabulationMixin.info - ~TabulationMixin.input_attrs - ~TabulationMixin.input_fields - ~TabulationMixin.installSTDLogger - ~TabulationMixin.internal_components - ~TabulationMixin.internal_references - ~TabulationMixin.internal_systems - ~TabulationMixin.internal_tabulations - ~TabulationMixin.locate - ~TabulationMixin.locate_ref - ~TabulationMixin.message_with_identiy - ~TabulationMixin.msg - ~TabulationMixin.numeric_fields - ~TabulationMixin.parse_run_kwargs - ~TabulationMixin.parse_simulation_input - ~TabulationMixin.plot_attributes - ~TabulationMixin.post_update - ~TabulationMixin.pre_compile - ~TabulationMixin.print_info - ~TabulationMixin.resetLog - ~TabulationMixin.resetSystemLogs - ~TabulationMixin.set_attr - ~TabulationMixin.setattrs - ~TabulationMixin.signals_attributes - ~TabulationMixin.slack_notification - ~TabulationMixin.slot_refs - ~TabulationMixin.slots_attributes - ~TabulationMixin.smart_split_dataframe - ~TabulationMixin.solvers_attributes - ~TabulationMixin.system_properties_classdef - ~TabulationMixin.system_references - ~TabulationMixin.table_fields - ~TabulationMixin.trace_attributes - ~TabulationMixin.transients_attributes - ~TabulationMixin.update - ~TabulationMixin.warning - - - - - - .. rubric:: Attributes - - .. autosummary:: - - ~TabulationMixin.always_save_data - ~TabulationMixin.anything_changed - ~TabulationMixin.as_dict - ~TabulationMixin.attr_raw_keys - ~TabulationMixin.attrs_fields - ~TabulationMixin.data_dict - ~TabulationMixin.dataframe - ~TabulationMixin.dataframe_constants - ~TabulationMixin.dataframe_variants - ~TabulationMixin.identity - ~TabulationMixin.input_as_dict - ~TabulationMixin.last_context - ~TabulationMixin.log_fmt - ~TabulationMixin.log_level - ~TabulationMixin.log_on - ~TabulationMixin.logger - ~TabulationMixin.numeric_as_dict - ~TabulationMixin.numeric_hash - ~TabulationMixin.plotable_variables - ~TabulationMixin.skip_plot_vars - ~TabulationMixin.slack_webhook_url - ~TabulationMixin.system_id - ~TabulationMixin.system_properties - ~TabulationMixin.system_properties_def - ~TabulationMixin.system_properties_description - ~TabulationMixin.system_properties_keys - ~TabulationMixin.system_properties_labels - ~TabulationMixin.system_properties_types - ~TabulationMixin.table_dict - ~TabulationMixin.unique_hash - ~TabulationMixin.parent - - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.tabulation.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.tabulation.rst.txt deleted file mode 100644 index 8ff6938..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.tabulation.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -engforge.tabulation -=================== - -.. automodule:: engforge.tabulation - - - - - - - - - - - - .. rubric:: Classes - - .. autosummary:: - :toctree: - :template: custom-class-template.rst - :nosignatures: - - TableLog - TabulationMixin - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/engforge.typing.NUMERIC_NAN_VALIDATOR.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.typing.NUMERIC_NAN_VALIDATOR.rst.txt deleted file mode 100644 index a53ba50..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.typing.NUMERIC_NAN_VALIDATOR.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.typing.NUMERIC\_NAN\_VALIDATOR -======================================= - -.. currentmodule:: engforge.typing - -.. autofunction:: NUMERIC_NAN_VALIDATOR \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.typing.NUMERIC_VALIDATOR.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.typing.NUMERIC_VALIDATOR.rst.txt deleted file mode 100644 index 24b7f97..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.typing.NUMERIC_VALIDATOR.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.typing.NUMERIC\_VALIDATOR -================================== - -.. currentmodule:: engforge.typing - -.. autofunction:: NUMERIC_VALIDATOR \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.typing.Options.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.typing.Options.rst.txt deleted file mode 100644 index d424dbf..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.typing.Options.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.typing.Options -======================= - -.. currentmodule:: engforge.typing - -.. autofunction:: Options \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.typing.STR_VALIDATOR.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.typing.STR_VALIDATOR.rst.txt deleted file mode 100644 index a95a91b..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.typing.STR_VALIDATOR.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -engforge.typing.STR\_VALIDATOR -============================== - -.. currentmodule:: engforge.typing - -.. autofunction:: STR_VALIDATOR \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/engforge.typing.rst.txt b/docs/_build/html/_sources/_autosummary/engforge.typing.rst.txt deleted file mode 100644 index 5cb23ce..0000000 --- a/docs/_build/html/_sources/_autosummary/engforge.typing.rst.txt +++ /dev/null @@ -1,34 +0,0 @@ -engforge.typing -=============== - -.. automodule:: engforge.typing - - - - - - - - .. rubric:: Functions - - .. autosummary:: - :toctree: - :nosignatures: - - NUMERIC_NAN_VALIDATOR - NUMERIC_VALIDATOR - Options - STR_VALIDATOR - - - - - - - - - - - - - diff --git a/docs/_build/html/_sources/_autosummary/examples.air_filter.rst.txt b/docs/_build/html/_sources/_autosummary/examples.air_filter.rst.txt deleted file mode 100644 index 922d73c..0000000 --- a/docs/_build/html/_sources/_autosummary/examples.air_filter.rst.txt +++ /dev/null @@ -1,15 +0,0 @@ -examples.air\_filter -==================== - -.. automodule:: examples.air_filter - - - .. rubric:: Classes - - .. autosummary:: - - Airfilter - AirfilterAnalysis - Fan - Filter - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/examples.rst.txt b/docs/_build/html/_sources/_autosummary/examples.rst.txt deleted file mode 100644 index 9e28923..0000000 --- a/docs/_build/html/_sources/_autosummary/examples.rst.txt +++ /dev/null @@ -1,14 +0,0 @@ -examples -======== - -.. automodule:: examples - - -.. rubric:: Modules - -.. autosummary:: - :toctree: - :recursive: - - air_filter - spring_mass diff --git a/docs/_build/html/_sources/_autosummary/examples.spring_mass.rst.txt b/docs/_build/html/_sources/_autosummary/examples.spring_mass.rst.txt deleted file mode 100644 index 3ab16c4..0000000 --- a/docs/_build/html/_sources/_autosummary/examples.spring_mass.rst.txt +++ /dev/null @@ -1,12 +0,0 @@ -examples.spring\_mass -===================== - -.. automodule:: examples.spring_mass - - - .. rubric:: Classes - - .. autosummary:: - - SpringMass - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/test.rst.txt b/docs/_build/html/_sources/_autosummary/test.rst.txt deleted file mode 100644 index 111fa25..0000000 --- a/docs/_build/html/_sources/_autosummary/test.rst.txt +++ /dev/null @@ -1,30 +0,0 @@ -test -==== - -.. automodule:: test - - -.. rubric:: Modules - -.. autosummary:: - :toctree: - :recursive: - - report_testing - test_airfilter - test_analysis - test_comp_iter - test_composition - test_costs - test_dynamics - test_dynamics_spaces - test_four_bar - test_modules - test_performance - test_pipes - test_problem - test_problem_deepscoping - test_slider_crank - test_solver - test_structures - test_tabulation diff --git a/docs/_build/html/_sources/_autosummary/test.test_airfilter.rst.txt b/docs/_build/html/_sources/_autosummary/test.test_airfilter.rst.txt deleted file mode 100644 index 89a74d1..0000000 --- a/docs/_build/html/_sources/_autosummary/test.test_airfilter.rst.txt +++ /dev/null @@ -1,13 +0,0 @@ -test.test\_airfilter -==================== - -.. automodule:: test.test_airfilter - - - .. rubric:: Classes - - .. autosummary:: - - TestAnalysis - TestFilterSystem - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/test.test_comp_iter.rst.txt b/docs/_build/html/_sources/_autosummary/test.test_comp_iter.rst.txt deleted file mode 100644 index 9b54678..0000000 --- a/docs/_build/html/_sources/_autosummary/test.test_comp_iter.rst.txt +++ /dev/null @@ -1,18 +0,0 @@ -test.test\_comp\_iter -===================== - -.. automodule:: test.test_comp_iter - - - .. rubric:: Classes - - .. autosummary:: - - DictComp - ListComp - NarrowSystem - TestConfig - TestNarrow - TestWide - WideSystem - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/test.test_composition.rst.txt b/docs/_build/html/_sources/_autosummary/test.test_composition.rst.txt deleted file mode 100644 index 0445a6b..0000000 --- a/docs/_build/html/_sources/_autosummary/test.test_composition.rst.txt +++ /dev/null @@ -1,20 +0,0 @@ -test.test\_composition -====================== - -.. automodule:: test.test_composition - - - .. rubric:: Functions - - .. autosummary:: - - limit_max - - .. rubric:: Classes - - .. autosummary:: - - MockComponent - MockSystem - TestComposition - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/test.test_costs.rst.txt b/docs/_build/html/_sources/_autosummary/test.test_costs.rst.txt deleted file mode 100644 index ce1cead..0000000 --- a/docs/_build/html/_sources/_autosummary/test.test_costs.rst.txt +++ /dev/null @@ -1,16 +0,0 @@ -test.test\_costs -================ - -.. automodule:: test.test_costs - - - .. rubric:: Classes - - .. autosummary:: - - TestCategoriesAndTerms - TestCostModel - TestEconDefaults - TestEconomicsAccounting - TestFanSystemDataFrame - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/test.test_dynamics.rst.txt b/docs/_build/html/_sources/_autosummary/test.test_dynamics.rst.txt deleted file mode 100644 index dd526a6..0000000 --- a/docs/_build/html/_sources/_autosummary/test.test_dynamics.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -test.test\_dynamics -=================== - -.. automodule:: test.test_dynamics - - - .. rubric:: Functions - - .. autosummary:: - - f - fit - jac - ls - - .. rubric:: Classes - - .. autosummary:: - - TestDynamics - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/test.test_dynamics_spaces.rst.txt b/docs/_build/html/_sources/_autosummary/test.test_dynamics_spaces.rst.txt deleted file mode 100644 index be24cf5..0000000 --- a/docs/_build/html/_sources/_autosummary/test.test_dynamics_spaces.rst.txt +++ /dev/null @@ -1,12 +0,0 @@ -test.test\_dynamics\_spaces -=========================== - -.. automodule:: test.test_dynamics_spaces - - - .. rubric:: Classes - - .. autosummary:: - - TestDynamics - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/test.test_four_bar.rst.txt b/docs/_build/html/_sources/_autosummary/test.test_four_bar.rst.txt deleted file mode 100644 index e4e8b31..0000000 --- a/docs/_build/html/_sources/_autosummary/test.test_four_bar.rst.txt +++ /dev/null @@ -1,12 +0,0 @@ -test.test\_four\_bar -==================== - -.. automodule:: test.test_four_bar - - - .. rubric:: Classes - - .. autosummary:: - - FourBar - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/test.test_modules.rst.txt b/docs/_build/html/_sources/_autosummary/test.test_modules.rst.txt deleted file mode 100644 index 1c33084..0000000 --- a/docs/_build/html/_sources/_autosummary/test.test_modules.rst.txt +++ /dev/null @@ -1,12 +0,0 @@ -test.test\_modules -================== - -.. automodule:: test.test_modules - - - .. rubric:: Classes - - .. autosummary:: - - ImportTest - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/test.test_performance.rst.txt b/docs/_build/html/_sources/_autosummary/test.test_performance.rst.txt deleted file mode 100644 index f81f40a..0000000 --- a/docs/_build/html/_sources/_autosummary/test.test_performance.rst.txt +++ /dev/null @@ -1,20 +0,0 @@ -test.test\_performance -====================== - -.. automodule:: test.test_performance - - - .. rubric:: Functions - - .. autosummary:: - - eval_steady_state - eval_transient - - .. rubric:: Classes - - .. autosummary:: - - PerfTest - TestPerformance - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/test.test_pipes.rst.txt b/docs/_build/html/_sources/_autosummary/test.test_pipes.rst.txt deleted file mode 100644 index f8ae364..0000000 --- a/docs/_build/html/_sources/_autosummary/test.test_pipes.rst.txt +++ /dev/null @@ -1,12 +0,0 @@ -test.test\_pipes -================ - -.. automodule:: test.test_pipes - - - .. rubric:: Classes - - .. autosummary:: - - TestPipes - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/test.test_problem_deepscoping.rst.txt b/docs/_build/html/_sources/_autosummary/test.test_problem_deepscoping.rst.txt deleted file mode 100644 index b5fc8bd..0000000 --- a/docs/_build/html/_sources/_autosummary/test.test_problem_deepscoping.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -test.test\_problem\_deepscoping -=============================== - -.. automodule:: test.test_problem_deepscoping - - - .. rubric:: Functions - - .. autosummary:: - - test_con - test_obj - test_zero - - .. rubric:: Classes - - .. autosummary:: - - DeepComp - DeepSys - TestComp - TestDeep - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/test.test_slider_crank.rst.txt b/docs/_build/html/_sources/_autosummary/test.test_slider_crank.rst.txt deleted file mode 100644 index 3d9b362..0000000 --- a/docs/_build/html/_sources/_autosummary/test.test_slider_crank.rst.txt +++ /dev/null @@ -1,12 +0,0 @@ -test.test\_slider\_crank -======================== - -.. automodule:: test.test_slider_crank - - - .. rubric:: Classes - - .. autosummary:: - - TestSliderCrank - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/test.test_solver.rst.txt b/docs/_build/html/_sources/_autosummary/test.test_solver.rst.txt deleted file mode 100644 index 21c72d7..0000000 --- a/docs/_build/html/_sources/_autosummary/test.test_solver.rst.txt +++ /dev/null @@ -1,13 +0,0 @@ -test.test\_solver -================= - -.. automodule:: test.test_solver - - - .. rubric:: Classes - - .. autosummary:: - - SingleCompSolverTest - SolverRefSelection - \ No newline at end of file diff --git a/docs/_build/html/_sources/_autosummary/test.test_tabulation.rst.txt b/docs/_build/html/_sources/_autosummary/test.test_tabulation.rst.txt deleted file mode 100644 index e9dd04a..0000000 --- a/docs/_build/html/_sources/_autosummary/test.test_tabulation.rst.txt +++ /dev/null @@ -1,15 +0,0 @@ -test.test\_tabulation -===================== - -.. automodule:: test.test_tabulation - - - .. rubric:: Classes - - .. autosummary:: - - Static - Test - TestConfig - TestStatic - \ No newline at end of file diff --git a/docs/_build/html/_sources/api.rst.txt b/docs/_build/html/_sources/api.rst.txt deleted file mode 100644 index 2e35260..0000000 --- a/docs/_build/html/_sources/api.rst.txt +++ /dev/null @@ -1,12 +0,0 @@ -.. - DO NOT DELETE THIS FILE! It contains the all-important `.. autosummary::` directive with `:recursive:` option, without - which API documentation wouldn't get extracted from docstrings by the `sphinx.ext.autosummary` engine. It is hidden - (not declared in any toctree) to remove an unnecessary intermediate page; index.rst instead points directly to the - package page. DO NOT REMOVE THIS FILE! - -.. autosummary:: - :toctree: _autosummary - :template: custom-module-template.rst - :recursive: - - engforge diff --git a/docs/_build/html/_sources/examples.rst.txt b/docs/_build/html/_sources/examples.rst.txt deleted file mode 100644 index 8646ce2..0000000 --- a/docs/_build/html/_sources/examples.rst.txt +++ /dev/null @@ -1,14 +0,0 @@ -.. - DO NOT DELETE THIS FILE! It contains the all-important `.. autosummary::` directive with `:recursive:` option, without - which API documentation wouldn't get extracted from docstrings by the `sphinx.ext.autosummary` engine. It is hidden - (not declared in any toctree) to remove an unnecessary intermediate page; index.rst instead points directly to the - package page. DO NOT REMOVE THIS FILE! - -Examples -======== - -.. autosummary:: - :toctree: _autosummary - :recursive: - - examples diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt deleted file mode 100644 index cf18b5d..0000000 --- a/docs/_build/html/_sources/index.rst.txt +++ /dev/null @@ -1,27 +0,0 @@ -.. engforge documentation master file, created by - sphinx-quickstart on Thu Jul 25 21:01:24 2024. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -.. toctree:: - :hidden: - - Home page - Examples <_autosummary/examples> - Tutorials - Tests <_autosummary/test> - API reference <_autosummary/engforge> - -Welcome to engforge's documentation! -==================================== - -.. include:: ../README.md - :parser: myst_parser.sphinx_ - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` \ No newline at end of file diff --git a/docs/_build/html/_sources/tests.rst.txt b/docs/_build/html/_sources/tests.rst.txt deleted file mode 100644 index 8cea913..0000000 --- a/docs/_build/html/_sources/tests.rst.txt +++ /dev/null @@ -1,14 +0,0 @@ -.. - DO NOT DELETE THIS FILE! It contains the all-important `.. autosummary::` directive with `:recursive:` option, without - which API documentation wouldn't get extracted from docstrings by the `sphinx.ext.autosummary` engine. It is hidden - (not declared in any toctree) to remove an unnecessary intermediate page; index.rst instead points directly to the - package page. DO NOT REMOVE THIS FILE! - -Tests -======== - -.. autosummary:: - :toctree: _autosummary - :recursive: - - test diff --git a/docs/_build/html/_sources/tutorials.rst.txt b/docs/_build/html/_sources/tutorials.rst.txt deleted file mode 100644 index e08ecc7..0000000 --- a/docs/_build/html/_sources/tutorials.rst.txt +++ /dev/null @@ -1,4 +0,0 @@ -Tutorials -========= - -coming soon... \ No newline at end of file diff --git a/docs/_build/html/_static/_sphinx_javascript_frameworks_compat.js b/docs/_build/html/_static/_sphinx_javascript_frameworks_compat.js deleted file mode 100644 index 8141580..0000000 --- a/docs/_build/html/_static/_sphinx_javascript_frameworks_compat.js +++ /dev/null @@ -1,123 +0,0 @@ -/* Compatability shim for jQuery and underscores.js. - * - * Copyright Sphinx contributors - * Released under the two clause BSD licence - */ - -/** - * small helper function to urldecode strings - * - * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL - */ -jQuery.urldecode = function(x) { - if (!x) { - return 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; -} diff --git a/docs/_build/html/_static/basic.css b/docs/_build/html/_static/basic.css deleted file mode 100644 index f316efc..0000000 --- a/docs/_build/html/_static/basic.css +++ /dev/null @@ -1,925 +0,0 @@ -/* - * basic.css - * ~~~~~~~~~ - * - * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/* -- main layout ----------------------------------------------------------- */ - -div.clearer { - clear: both; -} - -div.section::after { - display: block; - content: ''; - clear: left; -} - -/* -- 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 p.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: 360px; - 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:visited { - color: #551A8B; -} - -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, .figure.align-left, object.align-left { - clear: left; - float: left; - margin-right: 1em; -} - -img.align-right, figure.align-right, .figure.align-right, object.align-right { - clear: right; - float: right; - margin-left: 1em; -} - -img.align-center, figure.align-center, .figure.align-center, object.align-center { - display: block; - margin-left: auto; - margin-right: auto; -} - -img.align-default, figure.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, -aside.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; -} - -nav.contents, -aside.topic, -div.admonition, div.topic, blockquote { - clear: left; -} - -/* -- topics ---------------------------------------------------------------- */ - -nav.contents, -aside.topic, -div.topic { - border: 1px solid #ccc; - padding: 7px; - margin: 10px 0 10px 0; -} - -p.topic-title { - font-size: 1.1em; - font-weight: bold; - margin-top: 10px; -} - -/* -- admonitions ----------------------------------------------------------- */ - -div.admonition { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; -} - -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, -aside.sidebar > :last-child, -nav.contents > :last-child, -aside.topic > :last-child, -div.topic > :last-child, -div.admonition > :last-child { - margin-bottom: 0; -} - -div.sidebar::after, -aside.sidebar::after, -nav.contents::after, -aside.topic::after, -div.topic::after, -div.admonition::after, -blockquote::after { - display: block; - content: ''; - clear: both; -} - -/* -- 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; -} - -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, figure { - margin: 0.5em; - padding: 0.5em; -} - -div.figure p.caption, figcaption { - padding: 0.3em; -} - -div.figure p.caption span.caption-number, -figcaption span.caption-number { - font-style: italic; -} - -div.figure p.caption span.caption-text, -figcaption 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; -} - -/* -- object description styles --------------------------------------------- */ - -.sig { - font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; -} - -.sig-name, code.descname { - background-color: transparent; - font-weight: bold; -} - -.sig-name { - font-size: 1.1em; -} - -code.descname { - font-size: 1.2em; -} - -.sig-prename, code.descclassname { - background-color: transparent; -} - -.optional { - font-size: 1.3em; -} - -.sig-paren { - font-size: larger; -} - -.sig-param.n { - font-style: italic; -} - -/* C++ specific styling */ - -.sig-inline.c-texpr, -.sig-inline.cpp-texpr { - font-family: unset; -} - -.sig.c .k, .sig.c .kt, -.sig.cpp .k, .sig.cpp .kt { - color: #0033B3; -} - -.sig.c .m, -.sig.cpp .m { - color: #1750EB; -} - -.sig.c .s, .sig.c .sc, -.sig.cpp .s, .sig.cpp .sc { - color: #067D17; -} - - -/* -- 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; -} - -:not(li) > ol > li:first-child > :first-child, -:not(li) > ul > li:first-child > :first-child { - margin-top: 0px; -} - -:not(li) > ol > li:last-child > :last-child, -:not(li) > ul > li:last-child > :last-child { - margin-bottom: 0px; -} - -ol.simple ol p, -ol.simple ul p, -ul.simple ol p, -ul.simple ul p { - margin-top: 0; -} - -ol.simple > li:not(:first-child) > p, -ul.simple > li:not(:first-child) > p { - margin-top: 0; -} - -ol.simple p, -ul.simple p { - margin-bottom: 0; -} - -aside.footnote > span, -div.citation > span { - float: left; -} -aside.footnote > span:last-of-type, -div.citation > span:last-of-type { - padding-right: 0.5em; -} -aside.footnote > p { - margin-left: 2em; -} -div.citation > p { - margin-left: 4em; -} -aside.footnote > p:last-of-type, -div.citation > p:last-of-type { - margin-bottom: 0em; -} -aside.footnote > p:last-of-type:after, -div.citation > p:last-of-type: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 > 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; -} - -.sig dd { - margin-top: 0px; - margin-bottom: 0px; -} - -.sig dl { - margin-top: 0px; - margin-bottom: 0px; -} - -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; -} - -.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 0.5em; - content: ":"; - display: inline-block; -} - -abbr, acronym { - border-bottom: dotted 1px; - cursor: help; -} - -.translated { - background-color: rgba(207, 255, 207, 0.2) -} - -.untranslated { - background-color: rgba(255, 207, 207, 0.2) -} - -/* -- code displays --------------------------------------------------------- */ - -pre { - overflow: auto; - overflow-y: hidden; /* fixes display issues on Chrome browsers */ -} - -pre, div[class*="highlight-"] { - clear: both; -} - -span.pre { - -moz-hyphens: none; - -ms-hyphens: none; - -webkit-hyphens: none; - hyphens: none; - white-space: nowrap; -} - -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, -span.linenos, -div.highlight span.gp { /* gp: Generic.Prompt */ - user-select: none; - -webkit-user-select: text; /* Safari fallback only */ - -webkit-user-select: none; /* Chrome/Safari */ - -moz-user-select: none; /* Firefox */ - -ms-user-select: none; /* IE10+ */ -} - -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.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; - } -} \ No newline at end of file diff --git a/docs/_build/html/_static/css/badge_only.css b/docs/_build/html/_static/css/badge_only.css deleted file mode 100644 index c718cee..0000000 --- a/docs/_build/html/_static/css/badge_only.css +++ /dev/null @@ -1 +0,0 @@ -.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/docs/_build/html/_static/css/fonts/Roboto-Slab-Bold.woff b/docs/_build/html/_static/css/fonts/Roboto-Slab-Bold.woff deleted file mode 100644 index 6cb6000..0000000 Binary files a/docs/_build/html/_static/css/fonts/Roboto-Slab-Bold.woff and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 b/docs/_build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 deleted file mode 100644 index 7059e23..0000000 Binary files a/docs/_build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/Roboto-Slab-Regular.woff b/docs/_build/html/_static/css/fonts/Roboto-Slab-Regular.woff deleted file mode 100644 index f815f63..0000000 Binary files a/docs/_build/html/_static/css/fonts/Roboto-Slab-Regular.woff and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 b/docs/_build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 deleted file mode 100644 index f2c76e5..0000000 Binary files a/docs/_build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/fontawesome-webfont.eot b/docs/_build/html/_static/css/fonts/fontawesome-webfont.eot deleted file mode 100644 index e9f60ca..0000000 Binary files a/docs/_build/html/_static/css/fonts/fontawesome-webfont.eot and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/fontawesome-webfont.svg b/docs/_build/html/_static/css/fonts/fontawesome-webfont.svg deleted file mode 100644 index 855c845..0000000 --- a/docs/_build/html/_static/css/fonts/fontawesome-webfont.svg +++ /dev/null @@ -1,2671 +0,0 @@ - - - - -Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 - By ,,, -Copyright Dave Gandy 2016. All rights reserved. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/_build/html/_static/css/fonts/fontawesome-webfont.ttf b/docs/_build/html/_static/css/fonts/fontawesome-webfont.ttf deleted file mode 100644 index 35acda2..0000000 Binary files a/docs/_build/html/_static/css/fonts/fontawesome-webfont.ttf and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/fontawesome-webfont.woff b/docs/_build/html/_static/css/fonts/fontawesome-webfont.woff deleted file mode 100644 index 400014a..0000000 Binary files a/docs/_build/html/_static/css/fonts/fontawesome-webfont.woff and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/fontawesome-webfont.woff2 b/docs/_build/html/_static/css/fonts/fontawesome-webfont.woff2 deleted file mode 100644 index 4d13fc6..0000000 Binary files a/docs/_build/html/_static/css/fonts/fontawesome-webfont.woff2 and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/lato-bold-italic.woff b/docs/_build/html/_static/css/fonts/lato-bold-italic.woff deleted file mode 100644 index 88ad05b..0000000 Binary files a/docs/_build/html/_static/css/fonts/lato-bold-italic.woff and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/lato-bold-italic.woff2 b/docs/_build/html/_static/css/fonts/lato-bold-italic.woff2 deleted file mode 100644 index c4e3d80..0000000 Binary files a/docs/_build/html/_static/css/fonts/lato-bold-italic.woff2 and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/lato-bold.woff b/docs/_build/html/_static/css/fonts/lato-bold.woff deleted file mode 100644 index c6dff51..0000000 Binary files a/docs/_build/html/_static/css/fonts/lato-bold.woff and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/lato-bold.woff2 b/docs/_build/html/_static/css/fonts/lato-bold.woff2 deleted file mode 100644 index bb19504..0000000 Binary files a/docs/_build/html/_static/css/fonts/lato-bold.woff2 and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/lato-normal-italic.woff b/docs/_build/html/_static/css/fonts/lato-normal-italic.woff deleted file mode 100644 index 76114bc..0000000 Binary files a/docs/_build/html/_static/css/fonts/lato-normal-italic.woff and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/lato-normal-italic.woff2 b/docs/_build/html/_static/css/fonts/lato-normal-italic.woff2 deleted file mode 100644 index 3404f37..0000000 Binary files a/docs/_build/html/_static/css/fonts/lato-normal-italic.woff2 and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/lato-normal.woff b/docs/_build/html/_static/css/fonts/lato-normal.woff deleted file mode 100644 index ae1307f..0000000 Binary files a/docs/_build/html/_static/css/fonts/lato-normal.woff and /dev/null differ diff --git a/docs/_build/html/_static/css/fonts/lato-normal.woff2 b/docs/_build/html/_static/css/fonts/lato-normal.woff2 deleted file mode 100644 index 3bf9843..0000000 Binary files a/docs/_build/html/_static/css/fonts/lato-normal.woff2 and /dev/null differ diff --git a/docs/_build/html/_static/css/theme.css b/docs/_build/html/_static/css/theme.css deleted file mode 100644 index 19a446a..0000000 --- a/docs/_build/html/_static/css/theme.css +++ /dev/null @@ -1,4 +0,0 @@ -html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! - * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome - * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) - */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/docs/_build/html/_static/doctools.js b/docs/_build/html/_static/doctools.js deleted file mode 100644 index 4d67807..0000000 --- a/docs/_build/html/_static/doctools.js +++ /dev/null @@ -1,156 +0,0 @@ -/* - * doctools.js - * ~~~~~~~~~~~ - * - * Base JavaScript utilities for all Sphinx HTML documentation. - * - * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ -"use strict"; - -const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ - "TEXTAREA", - "INPUT", - "SELECT", - "BUTTON", -]); - -const _ready = (callback) => { - if (document.readyState !== "loading") { - callback(); - } else { - document.addEventListener("DOMContentLoaded", callback); - } -}; - -/** - * Small JavaScript module for the documentation. - */ -const Documentation = { - init: () => { - Documentation.initDomainIndexTable(); - Documentation.initOnKeyListeners(); - }, - - /** - * i18n support - */ - TRANSLATIONS: {}, - PLURAL_EXPR: (n) => (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: (string) => { - const translated = Documentation.TRANSLATIONS[string]; - switch (typeof translated) { - case "undefined": - return string; // no translation - case "string": - return translated; // translation exists - default: - return translated[0]; // (singular, plural) translation tuple exists - } - }, - - ngettext: (singular, plural, n) => { - const translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated !== "undefined") - return translated[Documentation.PLURAL_EXPR(n)]; - return n === 1 ? singular : plural; - }, - - addTranslations: (catalog) => { - Object.assign(Documentation.TRANSLATIONS, catalog.messages); - Documentation.PLURAL_EXPR = new Function( - "n", - `return (${catalog.plural_expr})` - ); - Documentation.LOCALE = catalog.locale; - }, - - /** - * helper function to focus on search bar - */ - focusSearchBar: () => { - document.querySelectorAll("input[name=q]")[0]?.focus(); - }, - - /** - * Initialise the domain index toggle buttons - */ - initDomainIndexTable: () => { - const toggler = (el) => { - const idNumber = el.id.substr(7); - const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); - if (el.src.substr(-9) === "minus.png") { - el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; - toggledRows.forEach((el) => (el.style.display = "none")); - } else { - el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; - toggledRows.forEach((el) => (el.style.display = "")); - } - }; - - const togglerElements = document.querySelectorAll("img.toggler"); - togglerElements.forEach((el) => - el.addEventListener("click", (event) => toggler(event.currentTarget)) - ); - togglerElements.forEach((el) => (el.style.display = "")); - if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); - }, - - initOnKeyListeners: () => { - // only install a listener if it is really needed - if ( - !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && - !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS - ) - return; - - document.addEventListener("keydown", (event) => { - // bail for input elements - if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; - // bail with special keys - if (event.altKey || event.ctrlKey || event.metaKey) return; - - if (!event.shiftKey) { - switch (event.key) { - case "ArrowLeft": - if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; - - const prevLink = document.querySelector('link[rel="prev"]'); - if (prevLink && prevLink.href) { - window.location.href = prevLink.href; - event.preventDefault(); - } - break; - case "ArrowRight": - if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; - - const nextLink = document.querySelector('link[rel="next"]'); - if (nextLink && nextLink.href) { - window.location.href = nextLink.href; - event.preventDefault(); - } - break; - } - } - - // some keyboard layouts may need Shift to get / - switch (event.key) { - case "/": - if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; - Documentation.focusSearchBar(); - event.preventDefault(); - } - }); - }, -}; - -// quick alias for translations -const _ = Documentation.gettext; - -_ready(Documentation.init); diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/html/_static/documentation_options.js deleted file mode 100644 index 529239f..0000000 --- a/docs/_build/html/_static/documentation_options.js +++ /dev/null @@ -1,13 +0,0 @@ -const DOCUMENTATION_OPTIONS = { - VERSION: '1.0', - LANGUAGE: 'en', - COLLAPSE_INDEX: false, - BUILDER: 'html', - FILE_SUFFIX: '.html', - LINK_SUFFIX: '.html', - HAS_SOURCE: true, - SOURCELINK_SUFFIX: '.txt', - NAVIGATION_WITH_KEYS: false, - SHOW_SEARCH_SUMMARY: true, - ENABLE_SEARCH_SHORTCUTS: true, -}; \ No newline at end of file diff --git a/docs/_build/html/_static/file.png b/docs/_build/html/_static/file.png deleted file mode 100644 index a858a41..0000000 Binary files a/docs/_build/html/_static/file.png and /dev/null differ diff --git a/docs/_build/html/_static/jquery.js b/docs/_build/html/_static/jquery.js deleted file mode 100644 index c4c6022..0000000 --- a/docs/_build/html/_static/jquery.js +++ /dev/null @@ -1,2 +0,0 @@ -/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ -!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/docs/_build/html/_static/js/html5shiv.min.js b/docs/_build/html/_static/js/html5shiv.min.js deleted file mode 100644 index cd1c674..0000000 --- a/docs/_build/html/_static/js/html5shiv.min.js +++ /dev/null @@ -1,4 +0,0 @@ -/** -* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed -*/ -!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/docs/_build/html/_static/js/theme.js b/docs/_build/html/_static/js/theme.js deleted file mode 100644 index 1fddb6e..0000000 --- a/docs/_build/html/_static/js/theme.js +++ /dev/null @@ -1 +0,0 @@ -!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("
"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t0 - 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; - } -} - diff --git a/docs/_build/html/_static/minus.png b/docs/_build/html/_static/minus.png deleted file mode 100644 index d96755f..0000000 Binary files a/docs/_build/html/_static/minus.png and /dev/null differ diff --git a/docs/_build/html/_static/plus.png b/docs/_build/html/_static/plus.png deleted file mode 100644 index 7107cec..0000000 Binary files a/docs/_build/html/_static/plus.png and /dev/null differ diff --git a/docs/_build/html/_static/pygments.css b/docs/_build/html/_static/pygments.css deleted file mode 100644 index 84ab303..0000000 --- a/docs/_build/html/_static/pygments.css +++ /dev/null @@ -1,75 +0,0 @@ -pre { line-height: 125%; } -td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } -span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } -td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -.highlight .hll { background-color: #ffffcc } -.highlight { background: #f8f8f8; } -.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ -.highlight .err { border: 1px solid #FF0000 } /* Error */ -.highlight .k { color: #008000; font-weight: bold } /* Keyword */ -.highlight .o { color: #666666 } /* Operator */ -.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ -.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ -.highlight .cp { color: #9C6500 } /* Comment.Preproc */ -.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ -.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ -.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ -.highlight .gd { color: #A00000 } /* Generic.Deleted */ -.highlight .ge { font-style: italic } /* Generic.Emph */ -.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -.highlight .gr { color: #E40000 } /* Generic.Error */ -.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ -.highlight .gi { color: #008400 } /* Generic.Inserted */ -.highlight .go { color: #717171 } /* Generic.Output */ -.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ -.highlight .gs { font-weight: bold } /* Generic.Strong */ -.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ -.highlight .gt { color: #0044DD } /* Generic.Traceback */ -.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ -.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ -.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ -.highlight .kp { color: #008000 } /* Keyword.Pseudo */ -.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ -.highlight .kt { color: #B00040 } /* Keyword.Type */ -.highlight .m { color: #666666 } /* Literal.Number */ -.highlight .s { color: #BA2121 } /* Literal.String */ -.highlight .na { color: #687822 } /* Name.Attribute */ -.highlight .nb { color: #008000 } /* Name.Builtin */ -.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ -.highlight .no { color: #880000 } /* Name.Constant */ -.highlight .nd { color: #AA22FF } /* Name.Decorator */ -.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */ -.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ -.highlight .nf { color: #0000FF } /* Name.Function */ -.highlight .nl { color: #767600 } /* Name.Label */ -.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ -.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ -.highlight .nv { color: #19177C } /* Name.Variable */ -.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ -.highlight .w { color: #bbbbbb } /* Text.Whitespace */ -.highlight .mb { color: #666666 } /* Literal.Number.Bin */ -.highlight .mf { color: #666666 } /* Literal.Number.Float */ -.highlight .mh { color: #666666 } /* Literal.Number.Hex */ -.highlight .mi { color: #666666 } /* Literal.Number.Integer */ -.highlight .mo { color: #666666 } /* Literal.Number.Oct */ -.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ -.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ -.highlight .sc { color: #BA2121 } /* Literal.String.Char */ -.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ -.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ -.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ -.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ -.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ -.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ -.highlight .sx { color: #008000 } /* Literal.String.Other */ -.highlight .sr { color: #A45A77 } /* Literal.String.Regex */ -.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ -.highlight .ss { color: #19177C } /* Literal.String.Symbol */ -.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ -.highlight .fm { color: #0000FF } /* Name.Function.Magic */ -.highlight .vc { color: #19177C } /* Name.Variable.Class */ -.highlight .vg { color: #19177C } /* Name.Variable.Global */ -.highlight .vi { color: #19177C } /* Name.Variable.Instance */ -.highlight .vm { color: #19177C } /* Name.Variable.Magic */ -.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/docs/_build/html/_static/searchtools.js b/docs/_build/html/_static/searchtools.js deleted file mode 100644 index b08d58c..0000000 --- a/docs/_build/html/_static/searchtools.js +++ /dev/null @@ -1,620 +0,0 @@ -/* - * searchtools.js - * ~~~~~~~~~~~~~~~~ - * - * Sphinx JavaScript utilities for the full-text search. - * - * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ -"use strict"; - -/** - * Simple result scoring code. - */ -if (typeof Scorer === "undefined") { - var Scorer = { - // Implement the following function to further tweak the score for each result - // The function takes a result array [docname, title, anchor, descr, score, filename] - // and returns the new score. - /* - score: result => { - const [docname, title, anchor, descr, score, filename] = result - return score - }, - */ - - // 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, - }; -} - -const _removeChildren = (element) => { - while (element && element.lastChild) element.removeChild(element.lastChild); -}; - -/** - * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping - */ -const _escapeRegExp = (string) => - string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string - -const _displayItem = (item, searchTerms, highlightTerms) => { - const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; - const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; - const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; - const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; - const contentRoot = document.documentElement.dataset.content_root; - - const [docName, title, anchor, descr, score, _filename] = item; - - let listItem = document.createElement("li"); - let requestUrl; - let linkUrl; - if (docBuilder === "dirhtml") { - // dirhtml builder - let dirname = docName + "/"; - if (dirname.match(/\/index\/$/)) - dirname = dirname.substring(0, dirname.length - 6); - else if (dirname === "index/") dirname = ""; - requestUrl = contentRoot + dirname; - linkUrl = requestUrl; - } else { - // normal html builders - requestUrl = contentRoot + docName + docFileSuffix; - linkUrl = docName + docLinkSuffix; - } - let linkEl = listItem.appendChild(document.createElement("a")); - linkEl.href = linkUrl + anchor; - linkEl.dataset.score = score; - linkEl.innerHTML = title; - if (descr) { - listItem.appendChild(document.createElement("span")).innerHTML = - " (" + descr + ")"; - // highlight search terms in the description - if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js - highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); - } - else if (showSearchSummary) - fetch(requestUrl) - .then((responseData) => responseData.text()) - .then((data) => { - if (data) - listItem.appendChild( - Search.makeSearchSummary(data, searchTerms, anchor) - ); - // highlight search terms in the summary - if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js - highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); - }); - Search.output.appendChild(listItem); -}; -const _finishSearch = (resultCount) => { - Search.stopPulse(); - Search.title.innerText = _("Search Results"); - if (!resultCount) - Search.status.innerText = Documentation.gettext( - "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.innerText = _( - "Search finished, found ${resultCount} page(s) matching the search query." - ).replace('${resultCount}', resultCount); -}; -const _displayNextItem = ( - results, - resultCount, - searchTerms, - highlightTerms, -) => { - // results left, load the summary and display it - // this is intended to be dynamic (don't sub resultsCount) - if (results.length) { - _displayItem(results.pop(), searchTerms, highlightTerms); - setTimeout( - () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), - 5 - ); - } - // search finished, update title and status message - else _finishSearch(resultCount); -}; -// Helper function used by query() to order search results. -// Each input is an array of [docname, title, anchor, descr, score, filename]. -// Order the results by score (in opposite order of appearance, since the -// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. -const _orderResultsByScoreThenName = (a, b) => { - const leftScore = a[4]; - const rightScore = b[4]; - if (leftScore === rightScore) { - // same score: sort alphabetically - const leftTitle = a[1].toLowerCase(); - const rightTitle = b[1].toLowerCase(); - if (leftTitle === rightTitle) return 0; - return leftTitle > rightTitle ? -1 : 1; // inverted is intentional - } - return leftScore > rightScore ? 1 : -1; -}; - -/** - * Default splitQuery function. Can be overridden in ``sphinx.search`` with a - * custom function per language. - * - * The regular expression works by splitting the string on consecutive characters - * that are not Unicode letters, numbers, underscores, or emoji characters. - * This is the same as ``\W+`` in Python, preserving the surrogate pair area. - */ -if (typeof splitQuery === "undefined") { - var splitQuery = (query) => query - .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) - .filter(term => term) // remove remaining empty strings -} - -/** - * Search Module - */ -const Search = { - _index: null, - _queued_query: null, - _pulse_status: -1, - - htmlToText: (htmlString, anchor) => { - const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); - for (const removalQuery of [".headerlink", "script", "style"]) { - htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); - } - if (anchor) { - const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`); - if (anchorContent) return anchorContent.textContent; - - console.warn( - `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.` - ); - } - - // if anchor not specified or not found, fall back to main content - const docContent = htmlElement.querySelector('[role="main"]'); - if (docContent) return docContent.textContent; - - console.warn( - "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template." - ); - return ""; - }, - - init: () => { - const query = new URLSearchParams(window.location.search).get("q"); - document - .querySelectorAll('input[name="q"]') - .forEach((el) => (el.value = query)); - if (query) Search.performSearch(query); - }, - - loadIndex: (url) => - (document.body.appendChild(document.createElement("script")).src = url), - - setIndex: (index) => { - Search._index = index; - if (Search._queued_query !== null) { - const query = Search._queued_query; - Search._queued_query = null; - Search.query(query); - } - }, - - hasIndex: () => Search._index !== null, - - deferQuery: (query) => (Search._queued_query = query), - - stopPulse: () => (Search._pulse_status = -1), - - startPulse: () => { - if (Search._pulse_status >= 0) return; - - const pulse = () => { - Search._pulse_status = (Search._pulse_status + 1) % 4; - Search.dots.innerText = ".".repeat(Search._pulse_status); - if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); - }; - pulse(); - }, - - /** - * perform a search for something (or wait until index is loaded) - */ - performSearch: (query) => { - // create the required interface elements - const searchText = document.createElement("h2"); - searchText.textContent = _("Searching"); - const searchSummary = document.createElement("p"); - searchSummary.classList.add("search-summary"); - searchSummary.innerText = ""; - const searchList = document.createElement("ul"); - searchList.classList.add("search"); - - const out = document.getElementById("search-results"); - Search.title = out.appendChild(searchText); - Search.dots = Search.title.appendChild(document.createElement("span")); - Search.status = out.appendChild(searchSummary); - Search.output = out.appendChild(searchList); - - const searchProgress = document.getElementById("search-progress"); - // Some themes don't use the search progress node - if (searchProgress) { - searchProgress.innerText = _("Preparing search..."); - } - Search.startPulse(); - - // index already loaded, the browser was quick! - if (Search.hasIndex()) Search.query(query); - else Search.deferQuery(query); - }, - - _parseQuery: (query) => { - // stem the search terms and add them to the correct list - const stemmer = new Stemmer(); - const searchTerms = new Set(); - const excludedTerms = new Set(); - const highlightTerms = new Set(); - const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); - splitQuery(query.trim()).forEach((queryTerm) => { - const queryTermLower = queryTerm.toLowerCase(); - - // maybe skip this "word" - // stopwords array is from language_data.js - if ( - stopwords.indexOf(queryTermLower) !== -1 || - queryTerm.match(/^\d+$/) - ) - return; - - // stem the word - let word = stemmer.stemWord(queryTermLower); - // select the correct list - if (word[0] === "-") excludedTerms.add(word.substr(1)); - else { - searchTerms.add(word); - highlightTerms.add(queryTermLower); - } - }); - - if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js - localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) - } - - // console.debug("SEARCH: searching for:"); - // console.info("required: ", [...searchTerms]); - // console.info("excluded: ", [...excludedTerms]); - - return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; - }, - - /** - * execute search (requires search index to be loaded) - */ - _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const titles = Search._index.titles; - const allTitles = Search._index.alltitles; - const indexEntries = Search._index.indexentries; - - // Collect multiple result groups to be sorted separately and then ordered. - // Each is an array of [docname, title, anchor, descr, score, filename]. - const normalResults = []; - const nonMainIndexResults = []; - - _removeChildren(document.getElementById("search-progress")); - - const queryLower = query.toLowerCase().trim(); - for (const [title, foundTitles] of Object.entries(allTitles)) { - if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { - for (const [file, id] of foundTitles) { - const score = Math.round(Scorer.title * queryLower.length / title.length); - const boost = titles[file] === title ? 1 : 0; // add a boost for document titles - normalResults.push([ - docNames[file], - titles[file] !== title ? `${titles[file]} > ${title}` : title, - id !== null ? "#" + id : "", - null, - score + boost, - filenames[file], - ]); - } - } - } - - // search for explicit entries in index directives - for (const [entry, foundEntries] of Object.entries(indexEntries)) { - if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { - for (const [file, id, isMain] of foundEntries) { - const score = Math.round(100 * queryLower.length / entry.length); - const result = [ - docNames[file], - titles[file], - id ? "#" + id : "", - null, - score, - filenames[file], - ]; - if (isMain) { - normalResults.push(result); - } else { - nonMainIndexResults.push(result); - } - } - } - } - - // lookup as object - objectTerms.forEach((term) => - normalResults.push(...Search.performObjectSearch(term, objectTerms)) - ); - - // lookup as search terms in fulltext - normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); - - // let the scorer override scores with a custom scoring function - if (Scorer.score) { - normalResults.forEach((item) => (item[4] = Scorer.score(item))); - nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); - } - - // Sort each group of results by score and then alphabetically by name. - normalResults.sort(_orderResultsByScoreThenName); - nonMainIndexResults.sort(_orderResultsByScoreThenName); - - // Combine the result groups in (reverse) order. - // Non-main index entries are typically arbitrary cross-references, - // so display them after other results. - let results = [...nonMainIndexResults, ...normalResults]; - - // remove duplicate search results - // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept - let seen = new Set(); - results = results.reverse().reduce((acc, result) => { - let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); - if (!seen.has(resultStr)) { - acc.push(result); - seen.add(resultStr); - } - return acc; - }, []); - - return results.reverse(); - }, - - query: (query) => { - const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); - const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); - - // for debugging - //Search.lastresults = results.slice(); // a copy - // console.info("search results:", Search.lastresults); - - // print the results - _displayNextItem(results, results.length, searchTerms, highlightTerms); - }, - - /** - * search for object names - */ - performObjectSearch: (object, objectTerms) => { - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const objects = Search._index.objects; - const objNames = Search._index.objnames; - const titles = Search._index.titles; - - const results = []; - - const objectSearchCallback = (prefix, match) => { - const name = match[4] - const fullname = (prefix ? prefix + "." : "") + name; - const fullnameLower = fullname.toLowerCase(); - if (fullnameLower.indexOf(object) < 0) return; - - let score = 0; - const 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.slice(-1)[0] === object) - score += Scorer.objNameMatch; - else if (parts.slice(-1)[0].indexOf(object) > -1) - score += Scorer.objPartialMatch; // matches in last name - - const objName = objNames[match[1]][2]; - const title = titles[match[0]]; - - // If more than one term searched for, we require other words to be - // found in the name/title/description - const otherTerms = new Set(objectTerms); - otherTerms.delete(object); - if (otherTerms.size > 0) { - const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); - if ( - [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) - ) - return; - } - - let anchor = match[3]; - if (anchor === "") anchor = fullname; - else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; - - const descr = objName + _(", in ") + title; - - // 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]], - ]); - }; - Object.keys(objects).forEach((prefix) => - objects[prefix].forEach((array) => - objectSearchCallback(prefix, array) - ) - ); - return results; - }, - - /** - * search for full-text terms in the index - */ - performTermsSearch: (searchTerms, excludedTerms) => { - // prepare search - const terms = Search._index.terms; - const titleTerms = Search._index.titleterms; - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const titles = Search._index.titles; - - const scoreMap = new Map(); - const fileMap = new Map(); - - // perform the search on the required terms - searchTerms.forEach((word) => { - const files = []; - const arr = [ - { files: terms[word], score: Scorer.term }, - { files: titleTerms[word], score: Scorer.title }, - ]; - // add support for partial matches - if (word.length > 2) { - const escapedWord = _escapeRegExp(word); - if (!terms.hasOwnProperty(word)) { - Object.keys(terms).forEach((term) => { - if (term.match(escapedWord)) - arr.push({ files: terms[term], score: Scorer.partialTerm }); - }); - } - if (!titleTerms.hasOwnProperty(word)) { - Object.keys(titleTerms).forEach((term) => { - if (term.match(escapedWord)) - arr.push({ files: titleTerms[term], score: Scorer.partialTitle }); - }); - } - } - - // no match but word was a required one - if (arr.every((record) => record.files === undefined)) return; - - // found search word in contents - arr.forEach((record) => { - if (record.files === undefined) return; - - let recordFiles = record.files; - if (recordFiles.length === undefined) recordFiles = [recordFiles]; - files.push(...recordFiles); - - // set score for the word in each file - recordFiles.forEach((file) => { - if (!scoreMap.has(file)) scoreMap.set(file, {}); - scoreMap.get(file)[word] = record.score; - }); - }); - - // create the mapping - files.forEach((file) => { - if (!fileMap.has(file)) fileMap.set(file, [word]); - else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word); - }); - }); - - // now check if the files don't contain excluded terms - const results = []; - for (const [file, wordList] of fileMap) { - // check if all requirements are matched - - // as search terms with length < 3 are discarded - const filteredTermCount = [...searchTerms].filter( - (term) => term.length > 2 - ).length; - if ( - wordList.length !== searchTerms.size && - wordList.length !== filteredTermCount - ) - continue; - - // ensure that none of the excluded terms is in the search result - if ( - [...excludedTerms].some( - (term) => - terms[term] === file || - titleTerms[term] === file || - (terms[term] || []).includes(file) || - (titleTerms[term] || []).includes(file) - ) - ) - break; - - // select one (max) score for the file. - const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); - // add result to the result list - 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. - */ - makeSearchSummary: (htmlText, keywords, anchor) => { - const text = Search.htmlToText(htmlText, anchor); - if (text === "") return null; - - const textLower = text.toLowerCase(); - const actualStartPosition = [...keywords] - .map((k) => textLower.indexOf(k.toLowerCase())) - .filter((i) => i > -1) - .slice(-1)[0]; - const startWithContext = Math.max(actualStartPosition - 120, 0); - - const top = startWithContext === 0 ? "" : "..."; - const tail = startWithContext + 240 < text.length ? "..." : ""; - - let summary = document.createElement("p"); - summary.classList.add("context"); - summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; - - return summary; - }, -}; - -_ready(Search.init); diff --git a/docs/_build/html/_static/sphinx_highlight.js b/docs/_build/html/_static/sphinx_highlight.js deleted file mode 100644 index 8a96c69..0000000 --- a/docs/_build/html/_static/sphinx_highlight.js +++ /dev/null @@ -1,154 +0,0 @@ -/* Highlighting utilities for Sphinx HTML documentation. */ -"use strict"; - -const SPHINX_HIGHLIGHT_ENABLED = true - -/** - * highlight a given string on a node by wrapping it in - * span elements with the given class name. - */ -const _highlight = (node, addItems, text, className) => { - if (node.nodeType === Node.TEXT_NODE) { - const val = node.nodeValue; - const parent = node.parentNode; - const pos = val.toLowerCase().indexOf(text); - if ( - pos >= 0 && - !parent.classList.contains(className) && - !parent.classList.contains("nohighlight") - ) { - let span; - - const closestNode = parent.closest("body, svg, foreignObject"); - const isInSVG = closestNode && closestNode.matches("svg"); - if (isInSVG) { - span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); - } else { - span = document.createElement("span"); - span.classList.add(className); - } - - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - const rest = document.createTextNode(val.substr(pos + text.length)); - parent.insertBefore( - span, - parent.insertBefore( - rest, - node.nextSibling - ) - ); - node.nodeValue = val.substr(0, pos); - /* There may be more occurrences of search term in this node. So call this - * function recursively on the remaining fragment. - */ - _highlight(rest, addItems, text, className); - - if (isInSVG) { - const rect = document.createElementNS( - "http://www.w3.org/2000/svg", - "rect" - ); - const bbox = parent.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: parent, target: rect }); - } - } - } else if (node.matches && !node.matches("button, select, textarea")) { - node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); - } -}; -const _highlightText = (thisNode, text, className) => { - let addItems = []; - _highlight(thisNode, addItems, text, className); - addItems.forEach((obj) => - obj.parent.insertAdjacentElement("beforebegin", obj.target) - ); -}; - -/** - * Small JavaScript module for the documentation. - */ -const SphinxHighlight = { - - /** - * highlight the search words provided in localstorage in the text - */ - highlightSearchWords: () => { - if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight - - // get and clear terms from localstorage - const url = new URL(window.location); - const highlight = - localStorage.getItem("sphinx_highlight_terms") - || url.searchParams.get("highlight") - || ""; - localStorage.removeItem("sphinx_highlight_terms") - url.searchParams.delete("highlight"); - window.history.replaceState({}, "", url); - - // get individual terms from highlight string - const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); - if (terms.length === 0) return; // nothing to do - - // There should never be more than one element matching "div.body" - const divBody = document.querySelectorAll("div.body"); - const body = divBody.length ? divBody[0] : document.querySelector("body"); - window.setTimeout(() => { - terms.forEach((term) => _highlightText(body, term, "highlighted")); - }, 10); - - const searchBox = document.getElementById("searchbox"); - if (searchBox === null) return; - searchBox.appendChild( - document - .createRange() - .createContextualFragment( - '

' + - '' + - _("Hide Search Matches") + - "

" - ) - ); - }, - - /** - * helper function to hide the search marks again - */ - hideSearchWords: () => { - document - .querySelectorAll("#searchbox .highlight-link") - .forEach((el) => el.remove()); - document - .querySelectorAll("span.highlighted") - .forEach((el) => el.classList.remove("highlighted")); - localStorage.removeItem("sphinx_highlight_terms") - }, - - initEscapeListener: () => { - // only install a listener if it is really needed - if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; - - document.addEventListener("keydown", (event) => { - // bail for input elements - if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; - // bail with special keys - if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; - if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { - SphinxHighlight.hideSearchWords(); - event.preventDefault(); - } - }); - }, -}; - -_ready(() => { - /* Do not call highlightSearchWords() when we are on the search page. - * It will highlight words from the *previous* search query. - */ - if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); - SphinxHighlight.initEscapeListener(); -}); diff --git a/docs/_build/html/api.html b/docs/_build/html/api.html deleted file mode 100644 index 5c4c316..0000000 --- a/docs/_build/html/api.html +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - <no title> — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • <no title>
    • -
  • -
    • -
-
-
-
-
- - - - - - - -

engforge

- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/examples.html b/docs/_build/html/examples.html deleted file mode 100644 index b52b609..0000000 --- a/docs/_build/html/examples.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - Examples — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • Examples
    • -
  • -
    • -
-
-
-
-
- -
-

Examples

- - - - - - -

examples

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html deleted file mode 100644 index 82eac21..0000000 --- a/docs/_build/html/genindex.html +++ /dev/null @@ -1,12440 +0,0 @@ - - - - - - Index — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • Index
    • -
  • -
    • -
-
-
-
-
- - -

Index

- -
- _ - | A - | B - | C - | D - | E - | F - | G - | H - | I - | K - | L - | M - | N - | O - | P - | R - | S - | T - | U - | V - | W - | X - | Y - -
-

_

- - -
- -

A

- - - -
- -

B

- - - -
- -

C

- - - -
- -

D

- - - -
- -

E

- - - -
- -

F

- - - -
- -

G

- - - -
- -

H

- - - -
- -

I

- - - -
- -

K

- - - -
- -

L

- - - -
- -

M

- - - -
- -

N

- - - -
- -

O

- - - -
- -

P

- - - -
- -

R

- - - -
- -

S

- - - -
- -

T

- - - -
- -

U

- - - -
- -

V

- - - -
- -

W

- - - -
- -

X

- - -
- -

Y

- - -
- - - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html deleted file mode 100644 index 52780b3..0000000 --- a/docs/_build/html/index.html +++ /dev/null @@ -1,446 +0,0 @@ - - - - - - - Welcome to engforge’s documentation! — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • Welcome to engforge’s documentation!
    • -
  • -
    • -
-
-
-
-
- -
-
-
-

Welcome to engforge’s documentation!

-

build

-
-

EngForge

-

A library to tabulate information from complex systems with various ways to store data and act as glue code for complex systems & engineering problems.

-
-

Installation

-
pip install git+https://github.com/Ottermatics/engforge.git
-
-
-
-
-

Core Functions

-
    -

  1. Tabulation Of Complex Systems

    2. -

  2. Modular Post Processing (dataframes)

    3. -

  3. Exploratory Analysis (ipython + functions / docs)

    4. -

  4. Workflows for core engineering problemes (structures + cost, thermal+fluids solve)

    5. -
-
-
-

MVP Features (WIP)

-
    -

  1. Tabulation, use attrs.field and system_property to capture y=f(x) where fields are the state from which system_property derives results [Done]

    2. -

  2. Dynamic Programing ensures work is only done when new data is available with cached_system_property. [Done]

    3. -

  3. Quick Calculation provided by direct cached references to attribues and properties [Done]

    4. -

  4. Solver based on NPSS strategy of balances and integrators [Done]

    5. -

  5. Reporting to google sheets, csv and excel.

    6. -
-
-
-

Systems & Analysis

-

Systems record data from components, and can execute a solver via the run(**parameter_iterables) command. Via a system’s run command its state and internal component’s & systems state can be altered in an outer product fashion, ie all combinations of inputs will be run. At the start of a run the systems & its components state is recorded and reset by default using Ref instances so that way multiple systems can use the same component. Its possible reference loops may occcur so its generally preferred to create components per system, however for coupled systems this is often desireable to converge on a solution.

-

By default the system calls a default_solver() method in its execute() function. A solver aims to drive its dependent parameter to zero by changing the independent parameters to zero, however it may adjust multiple parameters to meet multiple targets in more complex applications. For custom System behavior or to invoke custom solvers this method may be overriden.

-

To use the default solver & constraints

-
@forge
-SolverSystem(System):
-    sol2 = Solver.define("dep", "indep")
-    sol2.add_constraint("max", limit_max) #indep should never go above this value (or function)
-    sol2.add_constraint("min", 0) #indep should never go below zero
-
-
-

Analysis is a pluggable way to provide different output and calculation from the same system and interacts with plot and table reporters.

-
-
-

Components, Signals & Slots

-

Component are able to be mounted into multiple Systems via SLOTS.define( ComponentType ). A Component’s properties can be updated via SIGNALS in the Systems’s solver in the pre_execute and/or the post_execute functions via SIGNAL.define(target, source, mode) where mode can be pre,post or both to update before the System.execute() method.

-

Iterable Components may be defined on a System via SLOT.define_iterable( <ComponentIter>, wide=True/False) to choose how the system should iterate over the component, wide mode provides all the component attributes and properties in the same row whereas the narrow mode will iterate over each combination of component as though it was input into system.run()

-
-
-

Example Engineering Problems:

-

These problems demonstrate functionality

-
-

Air Filter

-

run a throttle sweep with filter loss characteristic and fan afinity law based pressure based off of a design point.

-
from engforge.analysis import Analysis
-from engforge.reporting import CSVReporter,DiskPlotReporter
-from engforge.properties import system_property
-from engforge import *
-import numpy as np
-import os,pathlib
-import attrs
-
-@forge
-class Fan(Component):
-
-    n_frac:float = field(default=1)
-    dp_design:float= field(default=100)
-    w_design:float = field(default=2)
-
-
-    @system_property
-    def dP_fan(self) -> float:
-        return self.dp_design*(self.n_frac*self.w_design)**2.0
-
-@forge
-class Filter(Component):
-
-    w:float = field(default=0)
-    k_loss:float = field(default=50)
-
-    @system_property
-    def dP_filter(self) -> float:
-        return self.k_loss*self.w
-
-@forge
-class Airfilter(System):
-
-    throttle:float = field(default=1)
-    w:float = field(default=1)
-    k_parasitic:float = field(default=0.1)
-
-    fan: Fan = Slot.define(Fan)
-    filt: Filter = Slot.define(Filter)
-
-    set_fan_n = Signal.define('fan.n_frac','throttle',mode='both')
-    set_filter_w = Signal.define('filt.w','w',mode='both')
-
-    flow_var = Solver.declare_var('w',combos='flow')
-    flow_var.add_var_constraint(0,'min',combos='flow')
-
-    pr_eq = Solver.constraint_equality('sum_dP',0,combos='flow')
-
-
-    flow_curve = Plot.define(
-        "throttle", "w", kind="lineplot", title="Flow Curve"
-    )
-
-    @system_property
-    def dP_parasitic(self) -> float:
-        return self.k_parasitic * self.w**2.0
-
-    @system_property
-    def sum_dP(self) -> float:
-        return self.fan.dP_fan - self.dP_parasitic - self.filt.dP_filter
-
-
-#Run the system
-from matplotlib.pylab import *
-
-
-
-fan = Fan()
-filt = Filter()
-af = Airfilter(fan=fan,filt=filt)
-
-change_all_log_levels(af,20) #info
-
-af.run(throttle=list(np.arange(0.1,1.1,0.1)),combos='*')
-
-df = af.dataframe
-
-fig,(ax,ax2) = subplots(2,1)
-ax.plot(df.throttle*100,df.w,'k--',label='flow')
-ax2.plot(df.throttle*100,df.filt_dp_filter,label='filter')
-ax2.plot(df.throttle*100,df.dp_parasitic,label='parasitic')
-ax2.plot(df.throttle*100,df.fan_dp_fan,label='fan')
-ax.legend(loc='upper right')
-ax.set_title('flow')
-ax.grid()
-ax2.legend()
-ax2.grid()
-ax2.set_title(f'pressure')
-ax2.set_xlabel(f'throttle%')
-
-
-
-
Results
-

air_filter_calc.png

-
-
-
-

Spring Mass Damper

-
-
Overview
-

Test case results in accurate resonance frequency calculation

-

-@forge
-class SpringMass(System):
-
-    k: float = attrs.field(default=50)
-    m: float = attrs.field(default=1)
-    g: float = attrs.field(default=9.81)
-    u: float = attrs.field(default=0.3)
-
-    a: float = attrs.field(default=0)
-    x: float = attrs.field(default=0.0)
-    v: float = attrs.field(default=0.0)
-
-    wo_f: float = attrs.field(default=1.0)
-    Fa: float = attrs.field(default=10.0)
-
-    x_neutral: float = attrs.field(default=0.5)
-
-    res =Solver.constraint_equality("sumF")
-    var_a = Solver.declare_var("a",combos='a',active=False)
-    var_b = Solver.declare_var("u",combos='u',active=False)
-    var_b.add_var_constraint(0.0,kind="min")
-    var_b.add_var_constraint(1.0,kind="max")
-
-    vtx = Time.integrate("v", "accl")
-    xtx = Time.integrate("x", "v")
-    xtx.add_var_constraint(0,kind="min")
-
-    #FIXME: implement trace testing
-    #pos = Trace.define(y="x", y2=["v", "a"])
-
-    @system_property
-    def dx(self) -> float:
-        return self.x_neutral - self.x
-
-    @system_property
-    def Fspring(self) -> float:
-        return self.k * self.dx
-
-    @system_property
-    def Fgrav(self) -> float:
-        return self.g * self.m
-
-    @system_property
-    def Faccel(self) -> float:
-        return self.a * self.m
-
-    @system_property
-    def Ffric(self) -> float:
-        return self.u * self.v
-
-    @system_property
-    def sumF(self) -> float:
-        return self.Fspring - self.Fgrav - self.Faccel - self.Ffric + self.Fext
-
-    @system_property
-    def Fext(self) -> float:
-        return self.Fa * np.cos( self.time * self.wo_f )
-
-    @system_property
-    def accl(self) -> float:
-        return self.sumF / self.m
-
-
-#Run The System, Compare damping `u`=0 & 0.1
-sm = SpringMass(x=0.0)
-sm.sim(dt=0.01,endtime=10,u=[0.0,0.1],combos='*',slv_vars='*')
-
-df = sm.dataframe
-df.groupby('run_id').plot('time','x')
-
-
-
-
-
Results Damping Off
-

olib_spring_mass_clac.png

-
-
-
Results - Damping On
- -
-
-
-
-

Reporting & Analysis

-

Analysis is capable of tabulation as a Component or System and wraps a top level System and will save data for each system interval. Analysis stores several reporters for tables and plots that may be used to store results in multiple locations.

-

Reporting is supported for tables via dataframes in CSV,Excel and Gsheets (WIP).

-

For plots reporting is supported in disk storage.

-

-from engforge.analysis import Analysis
-from engforge.reporting import CSVReporter,DiskPlotReporter
-from engforge.properties import system_property
-import numpy as np
-import os,pathlib
-
-this_dir = str(pathlib.Path(__file__).parent)
-this_dir = os.path.join(this_dir,'airfilter_report')
-if not os.path.exists(this_dir):
-    os.path.mkdir(this_dir)
-
-csv = CSVReporter(path=this_dir,report_mode='daily')
-csv_latest = CSVReporter(path=this_dir,report_mode='single')
-
-plots = DiskPlotReporter(path=this_dir,report_mode='monthly')
-plots_latest = DiskPlotReporter(path=this_dir,report_mode='single')
-
-
-@forge
-class AirfilterAnalysis(Analysis):
-    """Does post processing on a system"""
-
-    efficiency = attrs.field(defualt=0.95)
-
-    @system_property
-    def clean_air_delivery_rate(self) -> float:
-        return self.system.w*self.efficiency
-
-    def post_process(self,*run_args,**run_kwargs):
-        pass
-        #TODO: something custom!
-
-#Air Filter as before
-fan = Fan()
-filt = Filter()
-af = Airfilter(fan=fan,filt=filt)
-
-#Make The Analysis
-sa = AirfilterAnalysis(
-                    system = af,
-                    table_reporters = [csv,csv_latest],
-                    plot_reporters = [plots,plots_latest]
-                   )
-
-#Run the analysis! Input passed to system
-sa.run(throttle=list(np.arange(0.1,1.1,0.1)),combos='*')
-
-
-#CSV's & Plots available in ./airfilter_report!
-
-
-
-
-

Documentation:

-

https://engforge.github.io/engforge/build/html/index.html

-
-

DataStores

-

Datastores are a work in progress feature to provide a zero configuration library for storage of tabulated data and report generated artifacts. No garuntee is provided as to their stability yet. -Requirements for datasources are attempted upon access of engforge.datastores and entering of a CONFIRM prompt.

-
-
-

Environmental Variables

-

To allow a write-once implement anywhere interface EnvVariable is provided for both open (the default) and secret variables. Allowance for type conversion, and defaults are provided.

-

The current variable slots in memory are listed by EnvVariable.print_env_vars()

-
FORGE_DB_HOST                            |SECRETS[FORGE_DB_HOST]                    = localhost
-FORGE_DB_NAME                            |SECRETS[FORGE_DB_NAME]                    =
-FORGE_DB_PASS                            |SECRETS[FORGE_DB_PASS]                    = postgres
-FORGE_DB_PORT                            |SECRETS[FORGE_DB_PORT]                    = 5432
-FORGE_DB_USER                            |SECRETS[FORGE_DB_USER]                    = postgres
-FORGE_HOSTNAME                           |SECRETS[FORGE_HOSTNAME]                   = <your-machine>
-FORGE_REPORT_PATH                        |SECRETS[FORGE_REPORT_PATH]                =
-FORGE_SLACK_LOG_WEBHOOK                  |SECRETS[FORGE_SLACK_LOG_WEBHOOK]          =
-SEABORN_CONTEXT                         |SECRETS[SEABORN_CONTEXT]                 = paper
-SEABORN_PALETTE                         |SECRETS[SEABORN_PALETTE]                 = deep
-SEABORN_THEME                           |SECRETS[SEABORN_THEME]                   = darkgrid
-
-
-
-
-
-
-
-

Indices and tables

- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/media/air_filter_calc.png b/docs/_build/html/media/air_filter_calc.png deleted file mode 100644 index fb870cc..0000000 Binary files a/docs/_build/html/media/air_filter_calc.png and /dev/null differ diff --git a/docs/_build/html/media/olib_spring_mass_clac.png b/docs/_build/html/media/olib_spring_mass_clac.png deleted file mode 100644 index 06a53e8..0000000 Binary files a/docs/_build/html/media/olib_spring_mass_clac.png and /dev/null differ diff --git a/docs/_build/html/media/olib_spring_mass_clac_damp 1.png b/docs/_build/html/media/olib_spring_mass_clac_damp 1.png deleted file mode 100644 index 928a6b0..0000000 Binary files a/docs/_build/html/media/olib_spring_mass_clac_damp 1.png and /dev/null differ diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv deleted file mode 100644 index f5147c3..0000000 Binary files a/docs/_build/html/objects.inv and /dev/null differ diff --git a/docs/_build/html/py-modindex.html b/docs/_build/html/py-modindex.html deleted file mode 100644 index 0de5891..0000000 --- a/docs/_build/html/py-modindex.html +++ /dev/null @@ -1,417 +0,0 @@ - - - - - - Python Module Index — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • Python Module Index
    • -
  • -
    • -
-
-
-
-
- - -

Python Module Index

- -
- e | - t -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 
- e
- engforge -
    - engforge.analysis -
    - engforge.attr_dynamics -
    - engforge.attr_plotting -
    - engforge.attr_signals -
    - engforge.attr_slots -
    - engforge.attr_solver -
    - engforge.attributes -
    - engforge.common -
    - engforge.component_collections -
    - engforge.components -
    - engforge.configuration -
    - engforge.dataframe -
    - engforge.datastores -
    - engforge.datastores.data -
    - engforge.dynamics -
    - engforge.eng -
    - engforge.eng.costs -
    - engforge.eng.fluid_material -
    - engforge.eng.geometry -
    - engforge.eng.pipes -
    - engforge.eng.prediction -
    - engforge.eng.solid_materials -
    - engforge.eng.structure_beams -
    - engforge.eng.thermodynamics -
    - engforge.engforge_attributes -
    - engforge.env_var -
    - engforge.locations -
    - engforge.logging -
    - engforge.patterns -
    - engforge.problem_context -
    - engforge.properties -
    - engforge.reporting -
    - engforge.solveable -
    - engforge.solver -
    - engforge.solver_utils -
    - engforge.system -
    - engforge.system_reference -
    - engforge.tabulation -
    - engforge.typing -
- examples -
    - examples.air_filter -
    - examples.spring_mass -
 
- t
- test -
    - test.test_airfilter -
    - test.test_comp_iter -
    - test.test_composition -
    - test.test_costs -
    - test.test_dynamics -
    - test.test_dynamics_spaces -
    - test.test_four_bar -
    - test.test_modules -
    - test.test_performance -
    - test.test_pipes -
    - test.test_problem_deepscoping -
    - test.test_slider_crank -
    - test.test_solver -
    - test.test_tabulation -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html deleted file mode 100644 index cc15d44..0000000 --- a/docs/_build/html/search.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - Search — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • Search
    • -
  • -
    • -
-
-
-
-
- - - - -
- -
- -
-
- -
-
-
-
- - - - - - - - - \ No newline at end of file diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js deleted file mode 100644 index 066b3f6..0000000 --- a/docs/_build/html/searchindex.js +++ /dev/null @@ -1 +0,0 @@ -Search.setIndex({"alltitles": {"Air Filter": [[279, "air-filter"]], "Components, Signals & Slots": [[279, "components-signals-slots"]], "Core Functions": [[279, "core-functions"]], "DataStores": [[279, "datastores"]], "Documentation:": [[279, "documentation"]], "EngForge": [[279, "engforge"]], "Environmental Variables": [[279, "environmental-variables"]], "Example Engineering Problems:": [[279, "example-engineering-problems"]], "Examples": [[278, null]], "Indices and tables": [[279, "indices-and-tables"]], "Installation": [[279, "installation"]], "MVP Features (WIP)": [[279, "mvp-features-wip"]], "Overview": [[279, "overview"]], "Reporting & Analysis": [[279, "reporting-analysis"]], "Results": [[279, "results"]], "Results - Damping On": [[279, "results-damping-on"]], "Results Damping Off": [[279, "results-damping-off"]], "Spring Mass Damper": [[279, "spring-mass-damper"]], "Systems & Analysis": [[279, "systems-analysis"]], "Tests": [[280, null]], "Tutorials": [[281, null]], "Welcome to engforge\u2019s documentation!": [[279, null]], "engforge": [[0, null]], "engforge.analysis": [[1, null]], "engforge.analysis.Analysis": [[2, null]], "engforge.analysis.make_reporter_check": [[3, null]], "engforge.attr_dynamics": [[4, null]], "engforge.attr_dynamics.IntegratorInstance": [[5, null]], "engforge.attr_dynamics.TRANSIENT": [[6, null]], "engforge.attr_dynamics.Time": [[7, null]], "engforge.attr_plotting": [[8, null]], "engforge.attr_plotting.Plot": [[9, null]], "engforge.attr_plotting.PlotBase": [[10, null]], "engforge.attr_plotting.PlotInstance": [[11, null]], "engforge.attr_plotting.PlotLog": [[12, null]], "engforge.attr_plotting.PlottingMixin": [[13, null]], "engforge.attr_plotting.Trace": [[14, null]], "engforge.attr_plotting.TraceInstance": [[15, null]], "engforge.attr_plotting.conv_ctx": [[16, null]], "engforge.attr_plotting.conv_maps": [[17, null]], "engforge.attr_plotting.conv_theme": [[18, null]], "engforge.attr_plotting.install_seaborn": [[19, null]], "engforge.attr_plotting.save_all_figures_to_pdf": [[20, null]], "engforge.attr_signals": [[21, null]], "engforge.attr_signals.Signal": [[22, null]], "engforge.attr_signals.SignalInstance": [[23, null]], "engforge.attr_slots": [[24, null]], "engforge.attr_slots.Slot": [[25, null]], "engforge.attr_slots.SlotLog": [[26, null]], "engforge.attr_solver": [[27, null]], "engforge.attr_solver.AttrSolverLog": [[28, null]], "engforge.attr_solver.Solver": [[29, null]], "engforge.attr_solver.SolverInstance": [[30, null]], "engforge.attributes": [[31, null]], "engforge.attributes.ATTRLog": [[32, null]], "engforge.attributes.ATTR_BASE": [[33, null]], "engforge.attributes.AttributeInstance": [[34, null]], "engforge.common": [[35, null]], "engforge.common.ForgeLog": [[36, null]], "engforge.common.chunks": [[37, null]], "engforge.common.get_size": [[38, null]], "engforge.common.inst_vectorize": [[39, null]], "engforge.common.is_ec2_instance": [[40, null]], "engforge.component_collections": [[41, null]], "engforge.component_collections.ComponentDict": [[42, null]], "engforge.component_collections.ComponentIter": [[43, null]], "engforge.component_collections.ComponentIterator": [[44, null]], "engforge.component_collections.check_comp_type": [[45, null]], "engforge.component_collections.iter_tkn": [[46, null]], "engforge.components": [[47, null]], "engforge.components.Component": [[48, null]], "engforge.components.SolveableInterface": [[49, null]], "engforge.configuration": [[50, null]], "engforge.configuration.ConfigLog": [[51, null]], "engforge.configuration.Configuration": [[52, null]], "engforge.configuration.comp_transform": [[53, null]], "engforge.configuration.conv_nms": [[54, null]], "engforge.configuration.forge": [[55, null]], "engforge.configuration.meta": [[56, null]], "engforge.configuration.name_generator": [[57, null]], "engforge.configuration.property_changed": [[58, null]], "engforge.configuration.signals_slots_handler": [[59, null]], "engforge.dataframe": [[60, null]], "engforge.dataframe.DataFrameLog": [[61, null]], "engforge.dataframe.DataframeMixin": [[62, null]], "engforge.dataframe.dataframe_prop": [[63, null]], "engforge.dataframe.dataframe_property": [[64, null]], "engforge.dataframe.determine_split": [[65, null]], "engforge.dataframe.df_prop": [[66, null]], "engforge.dataframe.is_uniform": [[67, null]], "engforge.dataframe.key_func": [[68, null]], "engforge.dataframe.split_dataframe": [[69, null]], "engforge.datastores": [[70, null]], "engforge.datastores.data": [[71, null]], "engforge.datastores.data.DBConnection": [[72, null]], "engforge.datastores.data.DiskCacheStore": [[73, null]], "engforge.datastores.data.addapt_numpy_array": [[74, null]], "engforge.datastores.data.addapt_numpy_float32": [[75, null]], "engforge.datastores.data.addapt_numpy_float64": [[76, null]], "engforge.datastores.data.addapt_numpy_int32": [[77, null]], "engforge.datastores.data.addapt_numpy_int64": [[78, null]], "engforge.datastores.data.autocorrelation_direct": [[79, null]], "engforge.datastores.data.autocorrelation_fft": [[80, null]], "engforge.datastores.data.autocorrelation_numpy": [[81, null]], "engforge.datastores.data.nan_to_null": [[82, null]], "engforge.dynamics": [[83, null]], "engforge.dynamics.DynamicsMixin": [[84, null]], "engforge.dynamics.GlobalDynamics": [[85, null]], "engforge.dynamics.INDEX_MAP": [[86, null]], "engforge.dynamics.valid_mtx": [[87, null]], "engforge.eng": [[88, null]], "engforge.eng.costs": [[89, null]], "engforge.eng.costs.CostLog": [[90, null]], "engforge.eng.costs.CostModel": [[91, null]], "engforge.eng.costs.Economics": [[92, null]], "engforge.eng.costs.cost_property": [[93, null]], "engforge.eng.costs.eval_slot_cost": [[94, null]], "engforge.eng.costs.gend": [[95, null]], "engforge.eng.fluid_material": [[96, null]], "engforge.eng.fluid_material.Air": [[97, null]], "engforge.eng.fluid_material.AirWaterMix": [[98, null]], "engforge.eng.fluid_material.CoolPropMaterial": [[99, null]], "engforge.eng.fluid_material.CoolPropMixture": [[100, null]], "engforge.eng.fluid_material.FluidMaterial": [[101, null]], "engforge.eng.fluid_material.Hydrogen": [[102, null]], "engforge.eng.fluid_material.IdealAir": [[103, null]], "engforge.eng.fluid_material.IdealGas": [[104, null]], "engforge.eng.fluid_material.IdealH2": [[105, null]], "engforge.eng.fluid_material.IdealOxygen": [[106, null]], "engforge.eng.fluid_material.IdealSteam": [[107, null]], "engforge.eng.fluid_material.Oxygen": [[108, null]], "engforge.eng.fluid_material.SeaWater": [[109, null]], "engforge.eng.fluid_material.Steam": [[110, null]], "engforge.eng.fluid_material.Water": [[111, null]], "engforge.eng.geometry": [[112, null]], "engforge.eng.geometry.Circle": [[113, null]], "engforge.eng.geometry.GeometryLog": [[114, null]], "engforge.eng.geometry.HollowCircle": [[115, null]], "engforge.eng.geometry.ParametricSpline": [[116, null]], "engforge.eng.geometry.Profile2D": [[117, null]], "engforge.eng.geometry.Rectangle": [[118, null]], "engforge.eng.geometry.ShapelySection": [[119, null]], "engforge.eng.geometry.Triangle": [[120, null]], "engforge.eng.geometry.calculate_stress": [[121, null]], "engforge.eng.geometry.conver_np": [[122, null]], "engforge.eng.geometry.get_mesh_size": [[123, null]], "engforge.eng.pipes": [[124, null]], "engforge.eng.pipes.FlowInput": [[125, null]], "engforge.eng.pipes.FlowNode": [[126, null]], "engforge.eng.pipes.Pipe": [[127, null]], "engforge.eng.pipes.PipeFitting": [[128, null]], "engforge.eng.pipes.PipeFlow": [[129, null]], "engforge.eng.pipes.PipeLog": [[130, null]], "engforge.eng.pipes.PipeNode": [[131, null]], "engforge.eng.pipes.PipeSystem": [[132, null]], "engforge.eng.pipes.Pump": [[133, null]], "engforge.eng.prediction": [[134, null]], "engforge.eng.prediction.PredictionMixin": [[135, null]], "engforge.eng.solid_materials": [[136, null]], "engforge.eng.solid_materials.ANSI_4130": [[137, null]], "engforge.eng.solid_materials.ANSI_4340": [[138, null]], "engforge.eng.solid_materials.Aluminum": [[139, null]], "engforge.eng.solid_materials.CarbonFiber": [[140, null]], "engforge.eng.solid_materials.Concrete": [[141, null]], "engforge.eng.solid_materials.DrySoil": [[142, null]], "engforge.eng.solid_materials.Rock": [[143, null]], "engforge.eng.solid_materials.Rubber": [[144, null]], "engforge.eng.solid_materials.SS_316": [[145, null]], "engforge.eng.solid_materials.SolidMaterial": [[146, null]], "engforge.eng.solid_materials.WetSoil": [[147, null]], "engforge.eng.solid_materials.ih": [[148, null]], "engforge.eng.solid_materials.random_color": [[149, null]], "engforge.eng.structure_beams": [[150, null]], "engforge.eng.structure_beams.Beam": [[151, null]], "engforge.eng.structure_beams.rotation_matrix_from_vectors": [[152, null]], "engforge.eng.thermodynamics": [[153, null]], "engforge.eng.thermodynamics.SimpleCompressor": [[154, null]], "engforge.eng.thermodynamics.SimpleHeatExchanger": [[155, null]], "engforge.eng.thermodynamics.SimplePump": [[156, null]], "engforge.eng.thermodynamics.SimpleTurbine": [[157, null]], "engforge.eng.thermodynamics.dp_he_core": [[158, null]], "engforge.eng.thermodynamics.dp_he_entrance": [[159, null]], "engforge.eng.thermodynamics.dp_he_exit": [[160, null]], "engforge.eng.thermodynamics.dp_he_gas_losses": [[161, null]], "engforge.eng.thermodynamics.fanning_friction_factor": [[162, null]], "engforge.engforge_attributes": [[163, null]], "engforge.engforge_attributes.AttributedBaseMixin": [[164, null]], "engforge.engforge_attributes.EngAttr": [[165, null]], "engforge.engforge_attributes.get_attributes_of": [[166, null]], "engforge.env_var": [[167, null]], "engforge.env_var.EnvVariable": [[168, null]], "engforge.env_var.parse_bool": [[169, null]], "engforge.locations": [[170, null]], "engforge.locations.client_path": [[171, null]], "engforge.logging": [[172, null]], "engforge.logging.Log": [[173, null]], "engforge.logging.LoggingMixin": [[174, null]], "engforge.logging.change_all_log_levels": [[175, null]], "engforge.patterns": [[176, null]], "engforge.patterns.InputSingletonMeta": [[177, null]], "engforge.patterns.Singleton": [[178, null]], "engforge.patterns.SingletonMeta": [[179, null]], "engforge.patterns.chunks": [[180, null]], "engforge.patterns.flat2gen": [[181, null]], "engforge.patterns.flatten": [[182, null]], "engforge.patterns.inst_vectorize": [[183, null]], "engforge.patterns.singleton_meta_object": [[184, null]], "engforge.problem_context": [[185, null]], "engforge.problem_context.IllegalArgument": [[186, null]], "engforge.problem_context.ProbLog": [[187, null]], "engforge.problem_context.Problem": [[188, null]], "engforge.problem_context.ProblemExec": [[189, null]], "engforge.problem_context.ProblemExit": [[190, null]], "engforge.problem_context.ProblemExitAtLevel": [[191, null]], "engforge.properties": [[192, null]], "engforge.properties.PropertyLog": [[193, null]], "engforge.properties.cache_prop": [[194, null]], "engforge.properties.cached_sys_prop": [[195, null]], "engforge.properties.cached_system_prop": [[196, null]], "engforge.properties.cached_system_property": [[197, null]], "engforge.properties.class_cache": [[198, null]], "engforge.properties.engforge_prop": [[199, null]], "engforge.properties.instance_cached": [[200, null]], "engforge.properties.solver_cached": [[201, null]], "engforge.properties.sys_prop": [[202, null]], "engforge.properties.system_prop": [[203, null]], "engforge.properties.system_property": [[204, null]], "engforge.reporting": [[205, null]], "engforge.reporting.CSVReporter": [[206, null]], "engforge.reporting.DiskPlotReporter": [[207, null]], "engforge.reporting.DiskReporterMixin": [[208, null]], "engforge.reporting.ExcelReporter": [[209, null]], "engforge.reporting.GdriveReporter": [[210, null]], "engforge.reporting.GsheetsReporter": [[211, null]], "engforge.reporting.PlotReporter": [[212, null]], "engforge.reporting.Reporter": [[213, null]], "engforge.reporting.TableReporter": [[214, null]], "engforge.reporting.TemporalReporterMixin": [[215, null]], "engforge.reporting.path_exist_validator": [[216, null]], "engforge.solveable": [[217, null]], "engforge.solveable.SolvableLog": [[218, null]], "engforge.solveable.SolveableMixin": [[219, null]], "engforge.solver": [[220, null]], "engforge.solver.SolverLog": [[221, null]], "engforge.solver.SolverMixin": [[222, null]], "engforge.solver_utils": [[223, null]], "engforge.solver_utils.SolverUtilLog": [[224, null]], "engforge.solver_utils.arg_var_compare": [[225, null]], "engforge.solver_utils.combo_filter": [[226, null]], "engforge.solver_utils.create_constraint": [[227, null]], "engforge.solver_utils.ext_str_list": [[228, null]], "engforge.solver_utils.f_lin_min": [[229, null]], "engforge.solver_utils.filt_active": [[230, null]], "engforge.solver_utils.filter_combos": [[231, null]], "engforge.solver_utils.filter_vals": [[232, null]], "engforge.solver_utils.handle_normalize": [[233, null]], "engforge.solver_utils.objectify": [[234, null]], "engforge.solver_utils.ref_to_val_constraint": [[235, null]], "engforge.solver_utils.refmin_solve": [[236, null]], "engforge.solver_utils.secondary_obj": [[237, null]], "engforge.solver_utils.str_list_f": [[238, null]], "engforge.system": [[239, null]], "engforge.system.System": [[240, null]], "engforge.system.SystemsLog": [[241, null]], "engforge.system_reference": [[242, null]], "engforge.system_reference.Ref": [[243, null]], "engforge.system_reference.RefLog": [[244, null]], "engforge.system_reference.eval_ref": [[245, null]], "engforge.system_reference.maybe_attr_inst": [[246, null]], "engforge.system_reference.maybe_ref": [[247, null]], "engforge.system_reference.refset_get": [[248, null]], "engforge.system_reference.refset_input": [[249, null]], "engforge.system_reference.scale_val": [[250, null]], "engforge.tabulation": [[251, null]], "engforge.tabulation.TableLog": [[252, null]], "engforge.tabulation.TabulationMixin": [[253, null]], "engforge.typing": [[254, null]], "engforge.typing.NUMERIC_NAN_VALIDATOR": [[255, null]], "engforge.typing.NUMERIC_VALIDATOR": [[256, null]], "engforge.typing.Options": [[257, null]], "engforge.typing.STR_VALIDATOR": [[258, null]], "examples": [[259, null]], "examples.air_filter": [[260, null]], "examples.spring_mass": [[261, null]], "test": [[262, null]], "test.test_airfilter": [[263, null]], "test.test_comp_iter": [[264, null]], "test.test_composition": [[265, null]], "test.test_costs": [[266, null]], "test.test_dynamics": [[267, null]], "test.test_dynamics_spaces": [[268, null]], "test.test_four_bar": [[269, null]], "test.test_modules": [[270, null]], "test.test_performance": [[271, null]], "test.test_pipes": [[272, null]], "test.test_problem_deepscoping": [[273, null]], "test.test_slider_crank": [[274, null]], "test.test_solver": [[275, null]], "test.test_tabulation": [[276, null]]}, "docnames": ["_autosummary/engforge", "_autosummary/engforge.analysis", "_autosummary/engforge.analysis.Analysis", "_autosummary/engforge.analysis.make_reporter_check", "_autosummary/engforge.attr_dynamics", "_autosummary/engforge.attr_dynamics.IntegratorInstance", "_autosummary/engforge.attr_dynamics.TRANSIENT", "_autosummary/engforge.attr_dynamics.Time", "_autosummary/engforge.attr_plotting", "_autosummary/engforge.attr_plotting.PLOT", "_autosummary/engforge.attr_plotting.PlotBase", "_autosummary/engforge.attr_plotting.PlotInstance", "_autosummary/engforge.attr_plotting.PlotLog", "_autosummary/engforge.attr_plotting.PlottingMixin", "_autosummary/engforge.attr_plotting.Trace", "_autosummary/engforge.attr_plotting.TraceInstance", "_autosummary/engforge.attr_plotting.conv_ctx", "_autosummary/engforge.attr_plotting.conv_maps", "_autosummary/engforge.attr_plotting.conv_theme", "_autosummary/engforge.attr_plotting.install_seaborn", "_autosummary/engforge.attr_plotting.save_all_figures_to_pdf", "_autosummary/engforge.attr_signals", "_autosummary/engforge.attr_signals.Signal", "_autosummary/engforge.attr_signals.SignalInstance", "_autosummary/engforge.attr_slots", "_autosummary/engforge.attr_slots.Slot", "_autosummary/engforge.attr_slots.SlotLog", "_autosummary/engforge.attr_solver", "_autosummary/engforge.attr_solver.AttrSolverLog", "_autosummary/engforge.attr_solver.Solver", "_autosummary/engforge.attr_solver.SolverInstance", "_autosummary/engforge.attributes", "_autosummary/engforge.attributes.ATTRLog", "_autosummary/engforge.attributes.ATTR_BASE", "_autosummary/engforge.attributes.AttributeInstance", "_autosummary/engforge.common", "_autosummary/engforge.common.ForgeLog", "_autosummary/engforge.common.chunks", "_autosummary/engforge.common.get_size", "_autosummary/engforge.common.inst_vectorize", "_autosummary/engforge.common.is_ec2_instance", "_autosummary/engforge.component_collections", "_autosummary/engforge.component_collections.ComponentDict", "_autosummary/engforge.component_collections.ComponentIter", "_autosummary/engforge.component_collections.ComponentIterator", "_autosummary/engforge.component_collections.check_comp_type", "_autosummary/engforge.component_collections.iter_tkn", "_autosummary/engforge.components", "_autosummary/engforge.components.Component", "_autosummary/engforge.components.SolveableInterface", "_autosummary/engforge.configuration", "_autosummary/engforge.configuration.ConfigLog", "_autosummary/engforge.configuration.Configuration", "_autosummary/engforge.configuration.comp_transform", "_autosummary/engforge.configuration.conv_nms", "_autosummary/engforge.configuration.forge", "_autosummary/engforge.configuration.meta", "_autosummary/engforge.configuration.name_generator", "_autosummary/engforge.configuration.property_changed", "_autosummary/engforge.configuration.signals_slots_handler", "_autosummary/engforge.dataframe", "_autosummary/engforge.dataframe.DataFrameLog", "_autosummary/engforge.dataframe.DataframeMixin", "_autosummary/engforge.dataframe.dataframe_prop", "_autosummary/engforge.dataframe.dataframe_property", "_autosummary/engforge.dataframe.determine_split", "_autosummary/engforge.dataframe.df_prop", "_autosummary/engforge.dataframe.is_uniform", "_autosummary/engforge.dataframe.key_func", "_autosummary/engforge.dataframe.split_dataframe", "_autosummary/engforge.datastores", "_autosummary/engforge.datastores.data", "_autosummary/engforge.datastores.data.DBConnection", "_autosummary/engforge.datastores.data.DiskCacheStore", "_autosummary/engforge.datastores.data.addapt_numpy_array", "_autosummary/engforge.datastores.data.addapt_numpy_float32", "_autosummary/engforge.datastores.data.addapt_numpy_float64", "_autosummary/engforge.datastores.data.addapt_numpy_int32", "_autosummary/engforge.datastores.data.addapt_numpy_int64", "_autosummary/engforge.datastores.data.autocorrelation_direct", "_autosummary/engforge.datastores.data.autocorrelation_fft", "_autosummary/engforge.datastores.data.autocorrelation_numpy", "_autosummary/engforge.datastores.data.nan_to_null", "_autosummary/engforge.dynamics", "_autosummary/engforge.dynamics.DynamicsMixin", "_autosummary/engforge.dynamics.GlobalDynamics", "_autosummary/engforge.dynamics.INDEX_MAP", "_autosummary/engforge.dynamics.valid_mtx", "_autosummary/engforge.eng", "_autosummary/engforge.eng.costs", "_autosummary/engforge.eng.costs.CostLog", "_autosummary/engforge.eng.costs.CostModel", "_autosummary/engforge.eng.costs.Economics", "_autosummary/engforge.eng.costs.cost_property", "_autosummary/engforge.eng.costs.eval_slot_cost", "_autosummary/engforge.eng.costs.gend", "_autosummary/engforge.eng.fluid_material", "_autosummary/engforge.eng.fluid_material.Air", "_autosummary/engforge.eng.fluid_material.AirWaterMix", "_autosummary/engforge.eng.fluid_material.CoolPropMaterial", "_autosummary/engforge.eng.fluid_material.CoolPropMixture", "_autosummary/engforge.eng.fluid_material.FluidMaterial", "_autosummary/engforge.eng.fluid_material.Hydrogen", "_autosummary/engforge.eng.fluid_material.IdealAir", "_autosummary/engforge.eng.fluid_material.IdealGas", "_autosummary/engforge.eng.fluid_material.IdealH2", "_autosummary/engforge.eng.fluid_material.IdealOxygen", "_autosummary/engforge.eng.fluid_material.IdealSteam", "_autosummary/engforge.eng.fluid_material.Oxygen", "_autosummary/engforge.eng.fluid_material.SeaWater", "_autosummary/engforge.eng.fluid_material.Steam", "_autosummary/engforge.eng.fluid_material.Water", "_autosummary/engforge.eng.geometry", "_autosummary/engforge.eng.geometry.Circle", "_autosummary/engforge.eng.geometry.GeometryLog", "_autosummary/engforge.eng.geometry.HollowCircle", "_autosummary/engforge.eng.geometry.ParametricSpline", "_autosummary/engforge.eng.geometry.Profile2D", "_autosummary/engforge.eng.geometry.Rectangle", "_autosummary/engforge.eng.geometry.ShapelySection", "_autosummary/engforge.eng.geometry.Triangle", "_autosummary/engforge.eng.geometry.calculate_stress", "_autosummary/engforge.eng.geometry.conver_np", "_autosummary/engforge.eng.geometry.get_mesh_size", "_autosummary/engforge.eng.pipes", "_autosummary/engforge.eng.pipes.FlowInput", "_autosummary/engforge.eng.pipes.FlowNode", "_autosummary/engforge.eng.pipes.Pipe", "_autosummary/engforge.eng.pipes.PipeFitting", "_autosummary/engforge.eng.pipes.PipeFlow", "_autosummary/engforge.eng.pipes.PipeLog", "_autosummary/engforge.eng.pipes.PipeNode", "_autosummary/engforge.eng.pipes.PipeSystem", "_autosummary/engforge.eng.pipes.Pump", "_autosummary/engforge.eng.prediction", "_autosummary/engforge.eng.prediction.PredictionMixin", "_autosummary/engforge.eng.solid_materials", "_autosummary/engforge.eng.solid_materials.ANSI_4130", "_autosummary/engforge.eng.solid_materials.ANSI_4340", "_autosummary/engforge.eng.solid_materials.Aluminum", "_autosummary/engforge.eng.solid_materials.CarbonFiber", "_autosummary/engforge.eng.solid_materials.Concrete", "_autosummary/engforge.eng.solid_materials.DrySoil", "_autosummary/engforge.eng.solid_materials.Rock", "_autosummary/engforge.eng.solid_materials.Rubber", "_autosummary/engforge.eng.solid_materials.SS_316", "_autosummary/engforge.eng.solid_materials.SolidMaterial", "_autosummary/engforge.eng.solid_materials.WetSoil", "_autosummary/engforge.eng.solid_materials.ih", "_autosummary/engforge.eng.solid_materials.random_color", "_autosummary/engforge.eng.structure_beams", "_autosummary/engforge.eng.structure_beams.Beam", "_autosummary/engforge.eng.structure_beams.rotation_matrix_from_vectors", "_autosummary/engforge.eng.thermodynamics", "_autosummary/engforge.eng.thermodynamics.SimpleCompressor", "_autosummary/engforge.eng.thermodynamics.SimpleHeatExchanger", "_autosummary/engforge.eng.thermodynamics.SimplePump", "_autosummary/engforge.eng.thermodynamics.SimpleTurbine", "_autosummary/engforge.eng.thermodynamics.dp_he_core", "_autosummary/engforge.eng.thermodynamics.dp_he_entrance", "_autosummary/engforge.eng.thermodynamics.dp_he_exit", "_autosummary/engforge.eng.thermodynamics.dp_he_gas_losses", "_autosummary/engforge.eng.thermodynamics.fanning_friction_factor", "_autosummary/engforge.engforge_attributes", "_autosummary/engforge.engforge_attributes.AttributedBaseMixin", "_autosummary/engforge.engforge_attributes.EngAttr", "_autosummary/engforge.engforge_attributes.get_attributes_of", "_autosummary/engforge.env_var", "_autosummary/engforge.env_var.EnvVariable", "_autosummary/engforge.env_var.parse_bool", "_autosummary/engforge.locations", "_autosummary/engforge.locations.client_path", "_autosummary/engforge.logging", "_autosummary/engforge.logging.Log", "_autosummary/engforge.logging.LoggingMixin", "_autosummary/engforge.logging.change_all_log_levels", "_autosummary/engforge.patterns", "_autosummary/engforge.patterns.InputSingletonMeta", "_autosummary/engforge.patterns.Singleton", "_autosummary/engforge.patterns.SingletonMeta", "_autosummary/engforge.patterns.chunks", "_autosummary/engforge.patterns.flat2gen", "_autosummary/engforge.patterns.flatten", "_autosummary/engforge.patterns.inst_vectorize", "_autosummary/engforge.patterns.singleton_meta_object", "_autosummary/engforge.problem_context", "_autosummary/engforge.problem_context.IllegalArgument", "_autosummary/engforge.problem_context.ProbLog", "_autosummary/engforge.problem_context.Problem", "_autosummary/engforge.problem_context.ProblemExec", "_autosummary/engforge.problem_context.ProblemExit", "_autosummary/engforge.problem_context.ProblemExitAtLevel", "_autosummary/engforge.properties", "_autosummary/engforge.properties.PropertyLog", "_autosummary/engforge.properties.cache_prop", "_autosummary/engforge.properties.cached_sys_prop", "_autosummary/engforge.properties.cached_system_prop", "_autosummary/engforge.properties.cached_system_property", "_autosummary/engforge.properties.class_cache", "_autosummary/engforge.properties.engforge_prop", "_autosummary/engforge.properties.instance_cached", "_autosummary/engforge.properties.solver_cached", "_autosummary/engforge.properties.sys_prop", "_autosummary/engforge.properties.system_prop", "_autosummary/engforge.properties.system_property", "_autosummary/engforge.reporting", "_autosummary/engforge.reporting.CSVReporter", "_autosummary/engforge.reporting.DiskPlotReporter", "_autosummary/engforge.reporting.DiskReporterMixin", "_autosummary/engforge.reporting.ExcelReporter", "_autosummary/engforge.reporting.GdriveReporter", "_autosummary/engforge.reporting.GsheetsReporter", "_autosummary/engforge.reporting.PlotReporter", "_autosummary/engforge.reporting.Reporter", "_autosummary/engforge.reporting.TableReporter", "_autosummary/engforge.reporting.TemporalReporterMixin", "_autosummary/engforge.reporting.path_exist_validator", "_autosummary/engforge.solveable", "_autosummary/engforge.solveable.SolvableLog", "_autosummary/engforge.solveable.SolveableMixin", "_autosummary/engforge.solver", "_autosummary/engforge.solver.SolverLog", "_autosummary/engforge.solver.SolverMixin", "_autosummary/engforge.solver_utils", "_autosummary/engforge.solver_utils.SolverUtilLog", "_autosummary/engforge.solver_utils.arg_var_compare", "_autosummary/engforge.solver_utils.combo_filter", "_autosummary/engforge.solver_utils.create_constraint", "_autosummary/engforge.solver_utils.ext_str_list", "_autosummary/engforge.solver_utils.f_lin_min", "_autosummary/engforge.solver_utils.filt_active", "_autosummary/engforge.solver_utils.filter_combos", "_autosummary/engforge.solver_utils.filter_vals", "_autosummary/engforge.solver_utils.handle_normalize", "_autosummary/engforge.solver_utils.objectify", "_autosummary/engforge.solver_utils.ref_to_val_constraint", "_autosummary/engforge.solver_utils.refmin_solve", "_autosummary/engforge.solver_utils.secondary_obj", "_autosummary/engforge.solver_utils.str_list_f", "_autosummary/engforge.system", "_autosummary/engforge.system.System", "_autosummary/engforge.system.SystemsLog", "_autosummary/engforge.system_reference", "_autosummary/engforge.system_reference.Ref", "_autosummary/engforge.system_reference.RefLog", "_autosummary/engforge.system_reference.eval_ref", "_autosummary/engforge.system_reference.maybe_attr_inst", "_autosummary/engforge.system_reference.maybe_ref", "_autosummary/engforge.system_reference.refset_get", "_autosummary/engforge.system_reference.refset_input", "_autosummary/engforge.system_reference.scale_val", "_autosummary/engforge.tabulation", "_autosummary/engforge.tabulation.TableLog", "_autosummary/engforge.tabulation.TabulationMixin", "_autosummary/engforge.typing", "_autosummary/engforge.typing.NUMERIC_NAN_VALIDATOR", "_autosummary/engforge.typing.NUMERIC_VALIDATOR", "_autosummary/engforge.typing.Options", "_autosummary/engforge.typing.STR_VALIDATOR", "_autosummary/examples", "_autosummary/examples.air_filter", "_autosummary/examples.spring_mass", "_autosummary/test", "_autosummary/test.test_airfilter", "_autosummary/test.test_comp_iter", "_autosummary/test.test_composition", "_autosummary/test.test_costs", "_autosummary/test.test_dynamics", "_autosummary/test.test_dynamics_spaces", "_autosummary/test.test_four_bar", "_autosummary/test.test_modules", "_autosummary/test.test_performance", "_autosummary/test.test_pipes", "_autosummary/test.test_problem_deepscoping", "_autosummary/test.test_slider_crank", "_autosummary/test.test_solver", "_autosummary/test.test_tabulation", "api", "examples", "index", "tests", "tutorials"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1}, "filenames": ["_autosummary/engforge.rst", "_autosummary/engforge.analysis.rst", "_autosummary/engforge.analysis.Analysis.rst", "_autosummary/engforge.analysis.make_reporter_check.rst", "_autosummary/engforge.attr_dynamics.rst", "_autosummary/engforge.attr_dynamics.IntegratorInstance.rst", "_autosummary/engforge.attr_dynamics.TRANSIENT.rst", "_autosummary/engforge.attr_dynamics.Time.rst", "_autosummary/engforge.attr_plotting.rst", "_autosummary/engforge.attr_plotting.PLOT.rst", "_autosummary/engforge.attr_plotting.PlotBase.rst", "_autosummary/engforge.attr_plotting.PlotInstance.rst", "_autosummary/engforge.attr_plotting.PlotLog.rst", "_autosummary/engforge.attr_plotting.PlottingMixin.rst", "_autosummary/engforge.attr_plotting.Trace.rst", "_autosummary/engforge.attr_plotting.TraceInstance.rst", "_autosummary/engforge.attr_plotting.conv_ctx.rst", "_autosummary/engforge.attr_plotting.conv_maps.rst", "_autosummary/engforge.attr_plotting.conv_theme.rst", "_autosummary/engforge.attr_plotting.install_seaborn.rst", "_autosummary/engforge.attr_plotting.save_all_figures_to_pdf.rst", "_autosummary/engforge.attr_signals.rst", "_autosummary/engforge.attr_signals.Signal.rst", "_autosummary/engforge.attr_signals.SignalInstance.rst", "_autosummary/engforge.attr_slots.rst", "_autosummary/engforge.attr_slots.Slot.rst", "_autosummary/engforge.attr_slots.SlotLog.rst", "_autosummary/engforge.attr_solver.rst", "_autosummary/engforge.attr_solver.AttrSolverLog.rst", "_autosummary/engforge.attr_solver.Solver.rst", "_autosummary/engforge.attr_solver.SolverInstance.rst", "_autosummary/engforge.attributes.rst", "_autosummary/engforge.attributes.ATTRLog.rst", "_autosummary/engforge.attributes.ATTR_BASE.rst", "_autosummary/engforge.attributes.AttributeInstance.rst", "_autosummary/engforge.common.rst", "_autosummary/engforge.common.ForgeLog.rst", "_autosummary/engforge.common.chunks.rst", "_autosummary/engforge.common.get_size.rst", "_autosummary/engforge.common.inst_vectorize.rst", "_autosummary/engforge.common.is_ec2_instance.rst", "_autosummary/engforge.component_collections.rst", "_autosummary/engforge.component_collections.ComponentDict.rst", "_autosummary/engforge.component_collections.ComponentIter.rst", "_autosummary/engforge.component_collections.ComponentIterator.rst", "_autosummary/engforge.component_collections.check_comp_type.rst", "_autosummary/engforge.component_collections.iter_tkn.rst", "_autosummary/engforge.components.rst", "_autosummary/engforge.components.Component.rst", "_autosummary/engforge.components.SolveableInterface.rst", "_autosummary/engforge.configuration.rst", "_autosummary/engforge.configuration.ConfigLog.rst", "_autosummary/engforge.configuration.Configuration.rst", "_autosummary/engforge.configuration.comp_transform.rst", "_autosummary/engforge.configuration.conv_nms.rst", "_autosummary/engforge.configuration.forge.rst", "_autosummary/engforge.configuration.meta.rst", "_autosummary/engforge.configuration.name_generator.rst", "_autosummary/engforge.configuration.property_changed.rst", "_autosummary/engforge.configuration.signals_slots_handler.rst", "_autosummary/engforge.dataframe.rst", "_autosummary/engforge.dataframe.DataFrameLog.rst", "_autosummary/engforge.dataframe.DataframeMixin.rst", "_autosummary/engforge.dataframe.dataframe_prop.rst", "_autosummary/engforge.dataframe.dataframe_property.rst", "_autosummary/engforge.dataframe.determine_split.rst", "_autosummary/engforge.dataframe.df_prop.rst", "_autosummary/engforge.dataframe.is_uniform.rst", "_autosummary/engforge.dataframe.key_func.rst", "_autosummary/engforge.dataframe.split_dataframe.rst", "_autosummary/engforge.datastores.rst", "_autosummary/engforge.datastores.data.rst", "_autosummary/engforge.datastores.data.DBConnection.rst", "_autosummary/engforge.datastores.data.DiskCacheStore.rst", "_autosummary/engforge.datastores.data.addapt_numpy_array.rst", "_autosummary/engforge.datastores.data.addapt_numpy_float32.rst", "_autosummary/engforge.datastores.data.addapt_numpy_float64.rst", "_autosummary/engforge.datastores.data.addapt_numpy_int32.rst", "_autosummary/engforge.datastores.data.addapt_numpy_int64.rst", "_autosummary/engforge.datastores.data.autocorrelation_direct.rst", "_autosummary/engforge.datastores.data.autocorrelation_fft.rst", "_autosummary/engforge.datastores.data.autocorrelation_numpy.rst", "_autosummary/engforge.datastores.data.nan_to_null.rst", "_autosummary/engforge.dynamics.rst", "_autosummary/engforge.dynamics.DynamicsMixin.rst", "_autosummary/engforge.dynamics.GlobalDynamics.rst", "_autosummary/engforge.dynamics.INDEX_MAP.rst", "_autosummary/engforge.dynamics.valid_mtx.rst", "_autosummary/engforge.eng.rst", "_autosummary/engforge.eng.costs.rst", "_autosummary/engforge.eng.costs.CostLog.rst", "_autosummary/engforge.eng.costs.CostModel.rst", "_autosummary/engforge.eng.costs.Economics.rst", "_autosummary/engforge.eng.costs.cost_property.rst", "_autosummary/engforge.eng.costs.eval_slot_cost.rst", "_autosummary/engforge.eng.costs.gend.rst", "_autosummary/engforge.eng.fluid_material.rst", "_autosummary/engforge.eng.fluid_material.Air.rst", "_autosummary/engforge.eng.fluid_material.AirWaterMix.rst", "_autosummary/engforge.eng.fluid_material.CoolPropMaterial.rst", "_autosummary/engforge.eng.fluid_material.CoolPropMixture.rst", "_autosummary/engforge.eng.fluid_material.FluidMaterial.rst", "_autosummary/engforge.eng.fluid_material.Hydrogen.rst", "_autosummary/engforge.eng.fluid_material.IdealAir.rst", "_autosummary/engforge.eng.fluid_material.IdealGas.rst", "_autosummary/engforge.eng.fluid_material.IdealH2.rst", "_autosummary/engforge.eng.fluid_material.IdealOxygen.rst", "_autosummary/engforge.eng.fluid_material.IdealSteam.rst", "_autosummary/engforge.eng.fluid_material.Oxygen.rst", "_autosummary/engforge.eng.fluid_material.SeaWater.rst", "_autosummary/engforge.eng.fluid_material.Steam.rst", "_autosummary/engforge.eng.fluid_material.Water.rst", "_autosummary/engforge.eng.geometry.rst", "_autosummary/engforge.eng.geometry.Circle.rst", "_autosummary/engforge.eng.geometry.GeometryLog.rst", "_autosummary/engforge.eng.geometry.HollowCircle.rst", "_autosummary/engforge.eng.geometry.ParametricSpline.rst", "_autosummary/engforge.eng.geometry.Profile2D.rst", "_autosummary/engforge.eng.geometry.Rectangle.rst", "_autosummary/engforge.eng.geometry.ShapelySection.rst", "_autosummary/engforge.eng.geometry.Triangle.rst", "_autosummary/engforge.eng.geometry.calculate_stress.rst", "_autosummary/engforge.eng.geometry.conver_np.rst", "_autosummary/engforge.eng.geometry.get_mesh_size.rst", "_autosummary/engforge.eng.pipes.rst", "_autosummary/engforge.eng.pipes.FlowInput.rst", "_autosummary/engforge.eng.pipes.FlowNode.rst", "_autosummary/engforge.eng.pipes.Pipe.rst", "_autosummary/engforge.eng.pipes.PipeFitting.rst", "_autosummary/engforge.eng.pipes.PipeFlow.rst", "_autosummary/engforge.eng.pipes.PipeLog.rst", "_autosummary/engforge.eng.pipes.PipeNode.rst", "_autosummary/engforge.eng.pipes.PipeSystem.rst", "_autosummary/engforge.eng.pipes.Pump.rst", "_autosummary/engforge.eng.prediction.rst", "_autosummary/engforge.eng.prediction.PredictionMixin.rst", "_autosummary/engforge.eng.solid_materials.rst", "_autosummary/engforge.eng.solid_materials.ANSI_4130.rst", "_autosummary/engforge.eng.solid_materials.ANSI_4340.rst", "_autosummary/engforge.eng.solid_materials.Aluminum.rst", "_autosummary/engforge.eng.solid_materials.CarbonFiber.rst", "_autosummary/engforge.eng.solid_materials.Concrete.rst", "_autosummary/engforge.eng.solid_materials.DrySoil.rst", "_autosummary/engforge.eng.solid_materials.Rock.rst", "_autosummary/engforge.eng.solid_materials.Rubber.rst", "_autosummary/engforge.eng.solid_materials.SS_316.rst", "_autosummary/engforge.eng.solid_materials.SolidMaterial.rst", "_autosummary/engforge.eng.solid_materials.WetSoil.rst", "_autosummary/engforge.eng.solid_materials.ih.rst", "_autosummary/engforge.eng.solid_materials.random_color.rst", "_autosummary/engforge.eng.structure_beams.rst", "_autosummary/engforge.eng.structure_beams.Beam.rst", "_autosummary/engforge.eng.structure_beams.rotation_matrix_from_vectors.rst", "_autosummary/engforge.eng.thermodynamics.rst", "_autosummary/engforge.eng.thermodynamics.SimpleCompressor.rst", "_autosummary/engforge.eng.thermodynamics.SimpleHeatExchanger.rst", "_autosummary/engforge.eng.thermodynamics.SimplePump.rst", "_autosummary/engforge.eng.thermodynamics.SimpleTurbine.rst", "_autosummary/engforge.eng.thermodynamics.dp_he_core.rst", "_autosummary/engforge.eng.thermodynamics.dp_he_entrance.rst", "_autosummary/engforge.eng.thermodynamics.dp_he_exit.rst", "_autosummary/engforge.eng.thermodynamics.dp_he_gas_losses.rst", "_autosummary/engforge.eng.thermodynamics.fanning_friction_factor.rst", "_autosummary/engforge.engforge_attributes.rst", "_autosummary/engforge.engforge_attributes.AttributedBaseMixin.rst", "_autosummary/engforge.engforge_attributes.EngAttr.rst", "_autosummary/engforge.engforge_attributes.get_attributes_of.rst", "_autosummary/engforge.env_var.rst", "_autosummary/engforge.env_var.EnvVariable.rst", "_autosummary/engforge.env_var.parse_bool.rst", "_autosummary/engforge.locations.rst", "_autosummary/engforge.locations.client_path.rst", "_autosummary/engforge.logging.rst", "_autosummary/engforge.logging.Log.rst", "_autosummary/engforge.logging.LoggingMixin.rst", "_autosummary/engforge.logging.change_all_log_levels.rst", "_autosummary/engforge.patterns.rst", "_autosummary/engforge.patterns.InputSingletonMeta.rst", "_autosummary/engforge.patterns.Singleton.rst", "_autosummary/engforge.patterns.SingletonMeta.rst", "_autosummary/engforge.patterns.chunks.rst", "_autosummary/engforge.patterns.flat2gen.rst", "_autosummary/engforge.patterns.flatten.rst", "_autosummary/engforge.patterns.inst_vectorize.rst", "_autosummary/engforge.patterns.singleton_meta_object.rst", "_autosummary/engforge.problem_context.rst", "_autosummary/engforge.problem_context.IllegalArgument.rst", "_autosummary/engforge.problem_context.ProbLog.rst", "_autosummary/engforge.problem_context.Problem.rst", "_autosummary/engforge.problem_context.ProblemExec.rst", "_autosummary/engforge.problem_context.ProblemExit.rst", "_autosummary/engforge.problem_context.ProblemExitAtLevel.rst", "_autosummary/engforge.properties.rst", "_autosummary/engforge.properties.PropertyLog.rst", "_autosummary/engforge.properties.cache_prop.rst", "_autosummary/engforge.properties.cached_sys_prop.rst", "_autosummary/engforge.properties.cached_system_prop.rst", "_autosummary/engforge.properties.cached_system_property.rst", "_autosummary/engforge.properties.class_cache.rst", "_autosummary/engforge.properties.engforge_prop.rst", "_autosummary/engforge.properties.instance_cached.rst", "_autosummary/engforge.properties.solver_cached.rst", "_autosummary/engforge.properties.sys_prop.rst", "_autosummary/engforge.properties.system_prop.rst", "_autosummary/engforge.properties.system_property.rst", "_autosummary/engforge.reporting.rst", "_autosummary/engforge.reporting.CSVReporter.rst", "_autosummary/engforge.reporting.DiskPlotReporter.rst", "_autosummary/engforge.reporting.DiskReporterMixin.rst", "_autosummary/engforge.reporting.ExcelReporter.rst", "_autosummary/engforge.reporting.GdriveReporter.rst", "_autosummary/engforge.reporting.GsheetsReporter.rst", "_autosummary/engforge.reporting.PlotReporter.rst", "_autosummary/engforge.reporting.Reporter.rst", "_autosummary/engforge.reporting.TableReporter.rst", "_autosummary/engforge.reporting.TemporalReporterMixin.rst", "_autosummary/engforge.reporting.path_exist_validator.rst", "_autosummary/engforge.solveable.rst", "_autosummary/engforge.solveable.SolvableLog.rst", "_autosummary/engforge.solveable.SolveableMixin.rst", "_autosummary/engforge.solver.rst", "_autosummary/engforge.solver.SolverLog.rst", "_autosummary/engforge.solver.SolverMixin.rst", "_autosummary/engforge.solver_utils.rst", "_autosummary/engforge.solver_utils.SolverUtilLog.rst", "_autosummary/engforge.solver_utils.arg_var_compare.rst", "_autosummary/engforge.solver_utils.combo_filter.rst", "_autosummary/engforge.solver_utils.create_constraint.rst", "_autosummary/engforge.solver_utils.ext_str_list.rst", "_autosummary/engforge.solver_utils.f_lin_min.rst", "_autosummary/engforge.solver_utils.filt_active.rst", "_autosummary/engforge.solver_utils.filter_combos.rst", "_autosummary/engforge.solver_utils.filter_vals.rst", "_autosummary/engforge.solver_utils.handle_normalize.rst", "_autosummary/engforge.solver_utils.objectify.rst", "_autosummary/engforge.solver_utils.ref_to_val_constraint.rst", "_autosummary/engforge.solver_utils.refmin_solve.rst", "_autosummary/engforge.solver_utils.secondary_obj.rst", "_autosummary/engforge.solver_utils.str_list_f.rst", "_autosummary/engforge.system.rst", "_autosummary/engforge.system.System.rst", "_autosummary/engforge.system.SystemsLog.rst", "_autosummary/engforge.system_reference.rst", "_autosummary/engforge.system_reference.Ref.rst", "_autosummary/engforge.system_reference.RefLog.rst", "_autosummary/engforge.system_reference.eval_ref.rst", "_autosummary/engforge.system_reference.maybe_attr_inst.rst", "_autosummary/engforge.system_reference.maybe_ref.rst", "_autosummary/engforge.system_reference.refset_get.rst", "_autosummary/engforge.system_reference.refset_input.rst", "_autosummary/engforge.system_reference.scale_val.rst", "_autosummary/engforge.tabulation.rst", "_autosummary/engforge.tabulation.TableLog.rst", "_autosummary/engforge.tabulation.TabulationMixin.rst", "_autosummary/engforge.typing.rst", "_autosummary/engforge.typing.NUMERIC_NAN_VALIDATOR.rst", "_autosummary/engforge.typing.NUMERIC_VALIDATOR.rst", "_autosummary/engforge.typing.Options.rst", "_autosummary/engforge.typing.STR_VALIDATOR.rst", "_autosummary/examples.rst", "_autosummary/examples.air_filter.rst", "_autosummary/examples.spring_mass.rst", "_autosummary/test.rst", "_autosummary/test.test_airfilter.rst", "_autosummary/test.test_comp_iter.rst", "_autosummary/test.test_composition.rst", "_autosummary/test.test_costs.rst", "_autosummary/test.test_dynamics.rst", "_autosummary/test.test_dynamics_spaces.rst", "_autosummary/test.test_four_bar.rst", "_autosummary/test.test_modules.rst", "_autosummary/test.test_performance.rst", "_autosummary/test.test_pipes.rst", "_autosummary/test.test_problem_deepscoping.rst", "_autosummary/test.test_slider_crank.rst", "_autosummary/test.test_solver.rst", "_autosummary/test.test_tabulation.rst", "api.rst", "examples.rst", "index.rst", "tests.rst", "tutorials.rst"], "indexentries": {"__call__() (air method)": [[97, "engforge.eng.fluid_material.Air.__call__", false]], "__call__() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.__call__", false]], "__call__() (cache_prop method)": [[194, "engforge.properties.cache_prop.__call__", false]], "__call__() (cached_system_property method)": [[197, "engforge.properties.cached_system_property.__call__", false]], "__call__() (class_cache method)": [[198, "engforge.properties.class_cache.__call__", false]], "__call__() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.__call__", false]], "__call__() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.__call__", false]], "__call__() (cost_property method)": [[93, "engforge.eng.costs.cost_property.__call__", false]], "__call__() (dataframe_property method)": [[64, "engforge.dataframe.dataframe_property.__call__", false]], "__call__() (engforge_prop method)": [[199, "engforge.properties.engforge_prop.__call__", false]], "__call__() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.__call__", false]], "__call__() (index_map method)": [[86, "engforge.dynamics.INDEX_MAP.__call__", false]], "__call__() (inputsingletonmeta method)": [[177, "engforge.patterns.InputSingletonMeta.__call__", false]], "__call__() (inst_vectorize method)": [[39, "engforge.common.inst_vectorize.__call__", false], [183, "engforge.patterns.inst_vectorize.__call__", false]], "__call__() (instance_cached method)": [[200, "engforge.properties.instance_cached.__call__", false]], "__call__() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.__call__", false]], "__call__() (plotinstance method)": [[11, "engforge.attr_plotting.PlotInstance.__call__", false]], "__call__() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.__call__", false]], "__call__() (singleton method)": [[178, "engforge.patterns.Singleton.__call__", false]], "__call__() (singletonmeta method)": [[179, "engforge.patterns.SingletonMeta.__call__", false]], "__call__() (solver_cached method)": [[201, "engforge.properties.solver_cached.__call__", false]], "__call__() (steam method)": [[110, "engforge.eng.fluid_material.Steam.__call__", false]], "__call__() (system_property method)": [[204, "engforge.properties.system_property.__call__", false]], "__call__() (traceinstance method)": [[15, "engforge.attr_plotting.TraceInstance.__call__", false]], "__call__() (water method)": [[111, "engforge.eng.fluid_material.Water.__call__", false]], "add_fields() (air method)": [[97, "engforge.eng.fluid_material.Air.add_fields", false]], "add_fields() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.add_fields", false]], "add_fields() (aluminum method)": [[139, "engforge.eng.solid_materials.Aluminum.add_fields", false]], "add_fields() (analysis method)": [[2, "engforge.analysis.Analysis.add_fields", false]], "add_fields() (ansi_4130 method)": [[137, "engforge.eng.solid_materials.ANSI_4130.add_fields", false]], "add_fields() (ansi_4340 method)": [[138, "engforge.eng.solid_materials.ANSI_4340.add_fields", false]], "add_fields() (attributedbasemixin method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.add_fields", false]], "add_fields() (attrlog method)": [[32, "engforge.attributes.ATTRLog.add_fields", false]], "add_fields() (attrsolverlog method)": [[28, "engforge.attr_solver.AttrSolverLog.add_fields", false]], "add_fields() (beam method)": [[151, "engforge.eng.structure_beams.Beam.add_fields", false]], "add_fields() (carbonfiber method)": [[140, "engforge.eng.solid_materials.CarbonFiber.add_fields", false]], "add_fields() (circle method)": [[113, "engforge.eng.geometry.Circle.add_fields", false]], "add_fields() (component method)": [[48, "engforge.components.Component.add_fields", false]], "add_fields() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.add_fields", false]], "add_fields() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.add_fields", false]], "add_fields() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.add_fields", false]], "add_fields() (concrete method)": [[141, "engforge.eng.solid_materials.Concrete.add_fields", false]], "add_fields() (configlog method)": [[51, "engforge.configuration.ConfigLog.add_fields", false]], "add_fields() (configuration method)": [[52, "engforge.configuration.Configuration.add_fields", false]], "add_fields() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.add_fields", false]], "add_fields() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.add_fields", false]], "add_fields() (costlog method)": [[90, "engforge.eng.costs.CostLog.add_fields", false]], "add_fields() (costmodel method)": [[91, "engforge.eng.costs.CostModel.add_fields", false]], "add_fields() (csvreporter method)": [[206, "engforge.reporting.CSVReporter.add_fields", false]], "add_fields() (dataframelog method)": [[61, "engforge.dataframe.DataFrameLog.add_fields", false]], "add_fields() (dbconnection method)": [[72, "engforge.datastores.data.DBConnection.add_fields", false]], "add_fields() (diskcachestore method)": [[73, "engforge.datastores.data.DiskCacheStore.add_fields", false]], "add_fields() (diskplotreporter method)": [[207, "engforge.reporting.DiskPlotReporter.add_fields", false]], "add_fields() (diskreportermixin method)": [[208, "engforge.reporting.DiskReporterMixin.add_fields", false]], "add_fields() (drysoil method)": [[142, "engforge.eng.solid_materials.DrySoil.add_fields", false]], "add_fields() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.add_fields", false]], "add_fields() (economics method)": [[92, "engforge.eng.costs.Economics.add_fields", false]], "add_fields() (engattr method)": [[165, "engforge.engforge_attributes.EngAttr.add_fields", false]], "add_fields() (envvariable method)": [[168, "engforge.env_var.EnvVariable.add_fields", false]], "add_fields() (excelreporter method)": [[209, "engforge.reporting.ExcelReporter.add_fields", false]], "add_fields() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.add_fields", false]], "add_fields() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.add_fields", false]], "add_fields() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.add_fields", false]], "add_fields() (forgelog method)": [[36, "engforge.common.ForgeLog.add_fields", false]], "add_fields() (gdrivereporter method)": [[210, "engforge.reporting.GdriveReporter.add_fields", false]], "add_fields() (geometrylog method)": [[114, "engforge.eng.geometry.GeometryLog.add_fields", false]], "add_fields() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.add_fields", false]], "add_fields() (gsheetsreporter method)": [[211, "engforge.reporting.GsheetsReporter.add_fields", false]], "add_fields() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.add_fields", false]], "add_fields() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.add_fields", false]], "add_fields() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.add_fields", false]], "add_fields() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.add_fields", false]], "add_fields() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.add_fields", false]], "add_fields() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.add_fields", false]], "add_fields() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.add_fields", false]], "add_fields() (log method)": [[173, "engforge.logging.Log.add_fields", false]], "add_fields() (loggingmixin method)": [[174, "engforge.logging.LoggingMixin.add_fields", false]], "add_fields() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.add_fields", false]], "add_fields() (pipe method)": [[127, "engforge.eng.pipes.Pipe.add_fields", false]], "add_fields() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.add_fields", false]], "add_fields() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.add_fields", false]], "add_fields() (pipelog method)": [[130, "engforge.eng.pipes.PipeLog.add_fields", false]], "add_fields() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.add_fields", false]], "add_fields() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.add_fields", false]], "add_fields() (plotlog method)": [[12, "engforge.attr_plotting.PlotLog.add_fields", false]], "add_fields() (plotreporter method)": [[212, "engforge.reporting.PlotReporter.add_fields", false]], "add_fields() (problog method)": [[187, "engforge.problem_context.ProbLog.add_fields", false]], "add_fields() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.add_fields", false]], "add_fields() (propertylog method)": [[193, "engforge.properties.PropertyLog.add_fields", false]], "add_fields() (pump method)": [[133, "engforge.eng.pipes.Pump.add_fields", false]], "add_fields() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.add_fields", false]], "add_fields() (reflog method)": [[244, "engforge.system_reference.RefLog.add_fields", false]], "add_fields() (reporter method)": [[213, "engforge.reporting.Reporter.add_fields", false]], "add_fields() (rock method)": [[143, "engforge.eng.solid_materials.Rock.add_fields", false]], "add_fields() (rubber method)": [[144, "engforge.eng.solid_materials.Rubber.add_fields", false]], "add_fields() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.add_fields", false]], "add_fields() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.add_fields", false]], "add_fields() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.add_fields", false]], "add_fields() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.add_fields", false]], "add_fields() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.add_fields", false]], "add_fields() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.add_fields", false]], "add_fields() (slotlog method)": [[26, "engforge.attr_slots.SlotLog.add_fields", false]], "add_fields() (solidmaterial method)": [[146, "engforge.eng.solid_materials.SolidMaterial.add_fields", false]], "add_fields() (solvablelog method)": [[218, "engforge.solveable.SolvableLog.add_fields", false]], "add_fields() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.add_fields", false]], "add_fields() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.add_fields", false]], "add_fields() (solverlog method)": [[221, "engforge.solver.SolverLog.add_fields", false]], "add_fields() (solvermixin method)": [[222, "engforge.solver.SolverMixin.add_fields", false]], "add_fields() (solverutillog method)": [[224, "engforge.solver_utils.SolverUtilLog.add_fields", false]], "add_fields() (ss_316 method)": [[145, "engforge.eng.solid_materials.SS_316.add_fields", false]], "add_fields() (steam method)": [[110, "engforge.eng.fluid_material.Steam.add_fields", false]], "add_fields() (system method)": [[240, "engforge.system.System.add_fields", false]], "add_fields() (systemslog method)": [[241, "engforge.system.SystemsLog.add_fields", false]], "add_fields() (tablelog method)": [[252, "engforge.tabulation.TableLog.add_fields", false]], "add_fields() (tablereporter method)": [[214, "engforge.reporting.TableReporter.add_fields", false]], "add_fields() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.add_fields", false]], "add_fields() (temporalreportermixin method)": [[215, "engforge.reporting.TemporalReporterMixin.add_fields", false]], "add_fields() (triangle method)": [[120, "engforge.eng.geometry.Triangle.add_fields", false]], "add_fields() (water method)": [[111, "engforge.eng.fluid_material.Water.add_fields", false]], "add_fields() (wetsoil method)": [[147, "engforge.eng.solid_materials.WetSoil.add_fields", false]], "add_prediction_record() (circle method)": [[113, "engforge.eng.geometry.Circle.add_prediction_record", false]], "add_prediction_record() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.add_prediction_record", false]], "add_prediction_record() (predictionmixin method)": [[135, "engforge.eng.prediction.PredictionMixin.add_prediction_record", false]], "add_prediction_record() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.add_prediction_record", false]], "add_prediction_record() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.add_prediction_record", false]], "add_prediction_record() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.add_prediction_record", false]], "add_prediction_record() (triangle method)": [[120, "engforge.eng.geometry.Triangle.add_prediction_record", false]], "add_to_graph() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.add_to_graph", false]], "add_var_constraint() (solver class method)": [[29, "engforge.attr_solver.Solver.add_var_constraint", false]], "add_var_constraint() (time class method)": [[7, "engforge.attr_dynamics.Time.add_var_constraint", false]], "addapt_numpy_array() (in module engforge.datastores.data)": [[74, "engforge.datastores.data.addapt_numpy_array", false]], "addapt_numpy_float32() (in module engforge.datastores.data)": [[75, "engforge.datastores.data.addapt_numpy_float32", false]], "addapt_numpy_float64() (in module engforge.datastores.data)": [[76, "engforge.datastores.data.addapt_numpy_float64", false]], "addapt_numpy_int32() (in module engforge.datastores.data)": [[77, "engforge.datastores.data.addapt_numpy_int32", false]], "addapt_numpy_int64() (in module engforge.datastores.data)": [[78, "engforge.datastores.data.addapt_numpy_int64", false]], "air (class in engforge.eng.fluid_material)": [[97, "engforge.eng.fluid_material.Air", false]], "airwatermix (class in engforge.eng.fluid_material)": [[98, "engforge.eng.fluid_material.AirWaterMix", false]], "all_components (problem property)": [[188, "engforge.problem_context.Problem.all_components", false]], "all_components (problemexec property)": [[189, "engforge.problem_context.ProblemExec.all_components", false]], "all_comps (problem property)": [[188, "engforge.problem_context.Problem.all_comps", false]], "all_comps (problemexec property)": [[189, "engforge.problem_context.ProblemExec.all_comps", false]], "all_problem_vars (problem property)": [[188, "engforge.problem_context.Problem.all_problem_vars", false]], "all_problem_vars (problemexec property)": [[189, "engforge.problem_context.ProblemExec.all_problem_vars", false]], "all_variables (problem property)": [[188, "engforge.problem_context.Problem.all_variables", false]], "all_variables (problemexec property)": [[189, "engforge.problem_context.ProblemExec.all_variables", false]], "aluminum (class in engforge.eng.solid_materials)": [[139, "engforge.eng.solid_materials.Aluminum", false]], "analysis (class in engforge.analysis)": [[2, "engforge.analysis.Analysis", false]], "ansi_4130 (class in engforge.eng.solid_materials)": [[137, "engforge.eng.solid_materials.ANSI_4130", false]], "ansi_4340 (class in engforge.eng.solid_materials)": [[138, "engforge.eng.solid_materials.ANSI_4340", false]], "anything_changed (air property)": [[97, "engforge.eng.fluid_material.Air.anything_changed", false]], "anything_changed (airwatermix property)": [[98, "engforge.eng.fluid_material.AirWaterMix.anything_changed", false]], "anything_changed (analysis property)": [[2, "engforge.analysis.Analysis.anything_changed", false]], "anything_changed (beam property)": [[151, "engforge.eng.structure_beams.Beam.anything_changed", false]], "anything_changed (component property)": [[48, "engforge.components.Component.anything_changed", false]], "anything_changed (componentdict property)": [[42, "engforge.component_collections.ComponentDict.anything_changed", false]], "anything_changed (componentiter property)": [[43, "engforge.component_collections.ComponentIter.anything_changed", false]], "anything_changed (componentiterator property)": [[44, "engforge.component_collections.ComponentIterator.anything_changed", false]], "anything_changed (coolpropmaterial property)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.anything_changed", false]], "anything_changed (coolpropmixture property)": [[100, "engforge.eng.fluid_material.CoolPropMixture.anything_changed", false]], "anything_changed (costmodel property)": [[91, "engforge.eng.costs.CostModel.anything_changed", false]], "anything_changed (economics property)": [[92, "engforge.eng.costs.Economics.anything_changed", false]], "anything_changed (flowinput property)": [[125, "engforge.eng.pipes.FlowInput.anything_changed", false]], "anything_changed (flownode property)": [[126, "engforge.eng.pipes.FlowNode.anything_changed", false]], "anything_changed (fluidmaterial property)": [[101, "engforge.eng.fluid_material.FluidMaterial.anything_changed", false]], "anything_changed (hydrogen property)": [[102, "engforge.eng.fluid_material.Hydrogen.anything_changed", false]], "anything_changed (idealair property)": [[103, "engforge.eng.fluid_material.IdealAir.anything_changed", false]], "anything_changed (idealgas property)": [[104, "engforge.eng.fluid_material.IdealGas.anything_changed", false]], "anything_changed (idealh2 property)": [[105, "engforge.eng.fluid_material.IdealH2.anything_changed", false]], "anything_changed (idealoxygen property)": [[106, "engforge.eng.fluid_material.IdealOxygen.anything_changed", false]], "anything_changed (idealsteam property)": [[107, "engforge.eng.fluid_material.IdealSteam.anything_changed", false]], "anything_changed (oxygen property)": [[108, "engforge.eng.fluid_material.Oxygen.anything_changed", false]], "anything_changed (pipe property)": [[127, "engforge.eng.pipes.Pipe.anything_changed", false]], "anything_changed (pipefitting property)": [[128, "engforge.eng.pipes.PipeFitting.anything_changed", false]], "anything_changed (pipeflow property)": [[129, "engforge.eng.pipes.PipeFlow.anything_changed", false]], "anything_changed (pipenode property)": [[131, "engforge.eng.pipes.PipeNode.anything_changed", false]], "anything_changed (pipesystem property)": [[132, "engforge.eng.pipes.PipeSystem.anything_changed", false]], "anything_changed (pump property)": [[133, "engforge.eng.pipes.Pump.anything_changed", false]], "anything_changed (seawater property)": [[109, "engforge.eng.fluid_material.SeaWater.anything_changed", false]], "anything_changed (simplecompressor property)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.anything_changed", false]], "anything_changed (simpleheatexchanger property)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.anything_changed", false]], "anything_changed (simplepump property)": [[156, "engforge.eng.thermodynamics.SimplePump.anything_changed", false]], "anything_changed (simpleturbine property)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.anything_changed", false]], "anything_changed (solveableinterface property)": [[49, "engforge.components.SolveableInterface.anything_changed", false]], "anything_changed (steam property)": [[110, "engforge.eng.fluid_material.Steam.anything_changed", false]], "anything_changed (system property)": [[240, "engforge.system.System.anything_changed", false]], "anything_changed (tabulationmixin property)": [[253, "engforge.tabulation.TabulationMixin.anything_changed", false]], "anything_changed (water property)": [[111, "engforge.eng.fluid_material.Water.anything_changed", false]], "ao (beam property)": [[151, "engforge.eng.structure_beams.Beam.Ao", false]], "ao (circle property)": [[113, "engforge.eng.geometry.Circle.Ao", false]], "ao (hollowcircle property)": [[115, "engforge.eng.geometry.HollowCircle.Ao", false]], "ao (profile2d property)": [[117, "engforge.eng.geometry.Profile2D.Ao", false]], "ao (rectangle property)": [[118, "engforge.eng.geometry.Rectangle.Ao", false]], "ao (shapelysection property)": [[119, "engforge.eng.geometry.ShapelySection.Ao", false]], "ao (triangle property)": [[120, "engforge.eng.geometry.Triangle.Ao", false]], "append() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.append", false]], "apply() (signalinstance method)": [[23, "engforge.attr_signals.SignalInstance.apply", false]], "apply_distributed_load() (beam method)": [[151, "engforge.eng.structure_beams.Beam.apply_distributed_load", false]], "apply_local_distributed_load() (beam method)": [[151, "engforge.eng.structure_beams.Beam.apply_local_distributed_load", false]], "apply_local_pt_load() (beam method)": [[151, "engforge.eng.structure_beams.Beam.apply_local_pt_load", false]], "apply_post_signals() (problem method)": [[188, "engforge.problem_context.Problem.apply_post_signals", false]], "apply_post_signals() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.apply_post_signals", false]], "apply_pre_signals() (problem method)": [[188, "engforge.problem_context.Problem.apply_pre_signals", false]], "apply_pre_signals() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.apply_pre_signals", false]], "apply_pt_load() (beam method)": [[151, "engforge.eng.structure_beams.Beam.apply_pt_load", false]], "arg_var_compare() (in module engforge.solver_utils)": [[225, "engforge.solver_utils.arg_var_compare", false]], "as_dict (air property)": [[97, "engforge.eng.fluid_material.Air.as_dict", false]], "as_dict (airwatermix property)": [[98, "engforge.eng.fluid_material.AirWaterMix.as_dict", false]], "as_dict (aluminum property)": [[139, "engforge.eng.solid_materials.Aluminum.as_dict", false]], "as_dict (analysis property)": [[2, "engforge.analysis.Analysis.as_dict", false]], "as_dict (ansi_4130 property)": [[137, "engforge.eng.solid_materials.ANSI_4130.as_dict", false]], "as_dict (ansi_4340 property)": [[138, "engforge.eng.solid_materials.ANSI_4340.as_dict", false]], "as_dict (attributedbasemixin property)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.as_dict", false]], "as_dict (beam property)": [[151, "engforge.eng.structure_beams.Beam.as_dict", false]], "as_dict (carbonfiber property)": [[140, "engforge.eng.solid_materials.CarbonFiber.as_dict", false]], "as_dict (circle property)": [[113, "engforge.eng.geometry.Circle.as_dict", false]], "as_dict (component property)": [[48, "engforge.components.Component.as_dict", false]], "as_dict (componentdict property)": [[42, "engforge.component_collections.ComponentDict.as_dict", false]], "as_dict (componentiter property)": [[43, "engforge.component_collections.ComponentIter.as_dict", false]], "as_dict (componentiterator property)": [[44, "engforge.component_collections.ComponentIterator.as_dict", false]], "as_dict (concrete property)": [[141, "engforge.eng.solid_materials.Concrete.as_dict", false]], "as_dict (configuration property)": [[52, "engforge.configuration.Configuration.as_dict", false]], "as_dict (coolpropmaterial property)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.as_dict", false]], "as_dict (coolpropmixture property)": [[100, "engforge.eng.fluid_material.CoolPropMixture.as_dict", false]], "as_dict (costmodel property)": [[91, "engforge.eng.costs.CostModel.as_dict", false]], "as_dict (drysoil property)": [[142, "engforge.eng.solid_materials.DrySoil.as_dict", false]], "as_dict (dynamicsmixin property)": [[84, "engforge.dynamics.DynamicsMixin.as_dict", false]], "as_dict (economics property)": [[92, "engforge.eng.costs.Economics.as_dict", false]], "as_dict (flowinput property)": [[125, "engforge.eng.pipes.FlowInput.as_dict", false]], "as_dict (flownode property)": [[126, "engforge.eng.pipes.FlowNode.as_dict", false]], "as_dict (fluidmaterial property)": [[101, "engforge.eng.fluid_material.FluidMaterial.as_dict", false]], "as_dict (globaldynamics property)": [[85, "engforge.dynamics.GlobalDynamics.as_dict", false]], "as_dict (hollowcircle property)": [[115, "engforge.eng.geometry.HollowCircle.as_dict", false]], "as_dict (hydrogen property)": [[102, "engforge.eng.fluid_material.Hydrogen.as_dict", false]], "as_dict (idealair property)": [[103, "engforge.eng.fluid_material.IdealAir.as_dict", false]], "as_dict (idealgas property)": [[104, "engforge.eng.fluid_material.IdealGas.as_dict", false]], "as_dict (idealh2 property)": [[105, "engforge.eng.fluid_material.IdealH2.as_dict", false]], "as_dict (idealoxygen property)": [[106, "engforge.eng.fluid_material.IdealOxygen.as_dict", false]], "as_dict (idealsteam property)": [[107, "engforge.eng.fluid_material.IdealSteam.as_dict", false]], "as_dict (oxygen property)": [[108, "engforge.eng.fluid_material.Oxygen.as_dict", false]], "as_dict (pipe property)": [[127, "engforge.eng.pipes.Pipe.as_dict", false]], "as_dict (pipefitting property)": [[128, "engforge.eng.pipes.PipeFitting.as_dict", false]], "as_dict (pipeflow property)": [[129, "engforge.eng.pipes.PipeFlow.as_dict", false]], "as_dict (pipenode property)": [[131, "engforge.eng.pipes.PipeNode.as_dict", false]], "as_dict (pipesystem property)": [[132, "engforge.eng.pipes.PipeSystem.as_dict", false]], "as_dict (profile2d property)": [[117, "engforge.eng.geometry.Profile2D.as_dict", false]], "as_dict (pump property)": [[133, "engforge.eng.pipes.Pump.as_dict", false]], "as_dict (rectangle property)": [[118, "engforge.eng.geometry.Rectangle.as_dict", false]], "as_dict (rock property)": [[143, "engforge.eng.solid_materials.Rock.as_dict", false]], "as_dict (rubber property)": [[144, "engforge.eng.solid_materials.Rubber.as_dict", false]], "as_dict (seawater property)": [[109, "engforge.eng.fluid_material.SeaWater.as_dict", false]], "as_dict (shapelysection property)": [[119, "engforge.eng.geometry.ShapelySection.as_dict", false]], "as_dict (simplecompressor property)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.as_dict", false]], "as_dict (simpleheatexchanger property)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.as_dict", false]], "as_dict (simplepump property)": [[156, "engforge.eng.thermodynamics.SimplePump.as_dict", false]], "as_dict (simpleturbine property)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.as_dict", false]], "as_dict (solidmaterial property)": [[146, "engforge.eng.solid_materials.SolidMaterial.as_dict", false]], "as_dict (solveableinterface property)": [[49, "engforge.components.SolveableInterface.as_dict", false]], "as_dict (solveablemixin property)": [[219, "engforge.solveable.SolveableMixin.as_dict", false]], "as_dict (solvermixin property)": [[222, "engforge.solver.SolverMixin.as_dict", false]], "as_dict (ss_316 property)": [[145, "engforge.eng.solid_materials.SS_316.as_dict", false]], "as_dict (steam property)": [[110, "engforge.eng.fluid_material.Steam.as_dict", false]], "as_dict (system property)": [[240, "engforge.system.System.as_dict", false]], "as_dict (tabulationmixin property)": [[253, "engforge.tabulation.TabulationMixin.as_dict", false]], "as_dict (triangle property)": [[120, "engforge.eng.geometry.Triangle.as_dict", false]], "as_dict (water property)": [[111, "engforge.eng.fluid_material.Water.as_dict", false]], "as_dict (wetsoil property)": [[147, "engforge.eng.solid_materials.WetSoil.as_dict", false]], "attr_base (class in engforge.attributes)": [[33, "engforge.attributes.ATTR_BASE", false]], "attributedbasemixin (class in engforge.engforge_attributes)": [[164, "engforge.engforge_attributes.AttributedBaseMixin", false]], "attributeinstance (class in engforge.attributes)": [[34, "engforge.attributes.AttributeInstance", false]], "attrlog (class in engforge.attributes)": [[32, "engforge.attributes.ATTRLog", false]], "attrsolverlog (class in engforge.attr_solver)": [[28, "engforge.attr_solver.AttrSolverLog", false]], "autocorrelation_direct() (in module engforge.datastores.data)": [[79, "engforge.datastores.data.autocorrelation_direct", false]], "autocorrelation_fft() (in module engforge.datastores.data)": [[80, "engforge.datastores.data.autocorrelation_fft", false]], "autocorrelation_numpy() (in module engforge.datastores.data)": [[81, "engforge.datastores.data.autocorrelation_numpy", false]], "basis_expand() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.basis_expand", false]], "beam (class in engforge.eng.structure_beams)": [[151, "engforge.eng.structure_beams.Beam", false]], "cache_class (diskcachestore attribute)": [[73, "engforge.datastores.data.DiskCacheStore.cache_class", false]], "cache_prop (class in engforge.properties)": [[194, "engforge.properties.cache_prop", false]], "cached_sys_prop (in module engforge.properties)": [[195, "engforge.properties.cached_sys_prop", false]], "cached_system_prop (in module engforge.properties)": [[196, "engforge.properties.cached_system_prop", false]], "cached_system_property (class in engforge.properties)": [[197, "engforge.properties.cached_system_property", false]], "calculate_costs() (economics method)": [[92, "engforge.eng.costs.Economics.calculate_costs", false]], "calculate_item_cost() (beam method)": [[151, "engforge.eng.structure_beams.Beam.calculate_item_cost", false]], "calculate_item_cost() (costmodel method)": [[91, "engforge.eng.costs.CostModel.calculate_item_cost", false]], "calculate_production() (economics method)": [[92, "engforge.eng.costs.Economics.calculate_production", false]], "calculate_stress() (beam method)": [[151, "engforge.eng.structure_beams.Beam.calculate_stress", false]], "calculate_stress() (in module engforge.eng.geometry)": [[121, "engforge.eng.geometry.calculate_stress", false]], "carbonfiber (class in engforge.eng.solid_materials)": [[140, "engforge.eng.solid_materials.CarbonFiber", false]], "cg_relative_inertia (beam property)": [[151, "engforge.eng.structure_beams.Beam.CG_RELATIVE_INERTIA", false]], "change_all_log_levels() (in module engforge.logging)": [[175, "engforge.logging.change_all_log_levels", false]], "check_and_retrain() (circle method)": [[113, "engforge.eng.geometry.Circle.check_and_retrain", false]], "check_and_retrain() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.check_and_retrain", false]], "check_and_retrain() (predictionmixin method)": [[135, "engforge.eng.prediction.PredictionMixin.check_and_retrain", false]], "check_and_retrain() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.check_and_retrain", false]], "check_and_retrain() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.check_and_retrain", false]], "check_and_retrain() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.check_and_retrain", false]], "check_and_retrain() (triangle method)": [[120, "engforge.eng.geometry.Triangle.check_and_retrain", false]], "check_comp_type() (in module engforge.component_collections)": [[45, "engforge.component_collections.check_comp_type", false]], "check_config() (csvreporter method)": [[206, "engforge.reporting.CSVReporter.check_config", false]], "check_config() (diskplotreporter method)": [[207, "engforge.reporting.DiskPlotReporter.check_config", false]], "check_config() (diskreportermixin method)": [[208, "engforge.reporting.DiskReporterMixin.check_config", false]], "check_config() (excelreporter method)": [[209, "engforge.reporting.ExcelReporter.check_config", false]], "check_config() (gdrivereporter method)": [[210, "engforge.reporting.GdriveReporter.check_config", false]], "check_config() (gsheetsreporter method)": [[211, "engforge.reporting.GsheetsReporter.check_config", false]], "check_config() (plotreporter method)": [[212, "engforge.reporting.PlotReporter.check_config", false]], "check_config() (reporter method)": [[213, "engforge.reporting.Reporter.check_config", false]], "check_config() (tablereporter method)": [[214, "engforge.reporting.TableReporter.check_config", false]], "check_config() (temporalreportermixin method)": [[215, "engforge.reporting.TemporalReporterMixin.check_config", false]], "check_out_of_domain() (circle method)": [[113, "engforge.eng.geometry.Circle.check_out_of_domain", false]], "check_out_of_domain() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.check_out_of_domain", false]], "check_out_of_domain() (predictionmixin method)": [[135, "engforge.eng.prediction.PredictionMixin.check_out_of_domain", false]], "check_out_of_domain() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.check_out_of_domain", false]], "check_out_of_domain() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.check_out_of_domain", false]], "check_out_of_domain() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.check_out_of_domain", false]], "check_out_of_domain() (triangle method)": [[120, "engforge.eng.geometry.Triangle.check_out_of_domain", false]], "check_ref_slot_type() (air class method)": [[97, "engforge.eng.fluid_material.Air.check_ref_slot_type", false]], "check_ref_slot_type() (airwatermix class method)": [[98, "engforge.eng.fluid_material.AirWaterMix.check_ref_slot_type", false]], "check_ref_slot_type() (aluminum class method)": [[139, "engforge.eng.solid_materials.Aluminum.check_ref_slot_type", false]], "check_ref_slot_type() (analysis class method)": [[2, "engforge.analysis.Analysis.check_ref_slot_type", false]], "check_ref_slot_type() (ansi_4130 class method)": [[137, "engforge.eng.solid_materials.ANSI_4130.check_ref_slot_type", false]], "check_ref_slot_type() (ansi_4340 class method)": [[138, "engforge.eng.solid_materials.ANSI_4340.check_ref_slot_type", false]], "check_ref_slot_type() (attributedbasemixin class method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.check_ref_slot_type", false]], "check_ref_slot_type() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.check_ref_slot_type", false]], "check_ref_slot_type() (carbonfiber class method)": [[140, "engforge.eng.solid_materials.CarbonFiber.check_ref_slot_type", false]], "check_ref_slot_type() (circle class method)": [[113, "engforge.eng.geometry.Circle.check_ref_slot_type", false]], "check_ref_slot_type() (component class method)": [[48, "engforge.components.Component.check_ref_slot_type", false]], "check_ref_slot_type() (componentdict class method)": [[42, "engforge.component_collections.ComponentDict.check_ref_slot_type", false]], "check_ref_slot_type() (componentiter class method)": [[43, "engforge.component_collections.ComponentIter.check_ref_slot_type", false]], "check_ref_slot_type() (componentiterator class method)": [[44, "engforge.component_collections.ComponentIterator.check_ref_slot_type", false]], "check_ref_slot_type() (concrete class method)": [[141, "engforge.eng.solid_materials.Concrete.check_ref_slot_type", false]], "check_ref_slot_type() (configuration class method)": [[52, "engforge.configuration.Configuration.check_ref_slot_type", false]], "check_ref_slot_type() (coolpropmaterial class method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.check_ref_slot_type", false]], "check_ref_slot_type() (coolpropmixture class method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.check_ref_slot_type", false]], "check_ref_slot_type() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.check_ref_slot_type", false]], "check_ref_slot_type() (drysoil class method)": [[142, "engforge.eng.solid_materials.DrySoil.check_ref_slot_type", false]], "check_ref_slot_type() (dynamicsmixin class method)": [[84, "engforge.dynamics.DynamicsMixin.check_ref_slot_type", false]], "check_ref_slot_type() (economics class method)": [[92, "engforge.eng.costs.Economics.check_ref_slot_type", false]], "check_ref_slot_type() (flowinput class method)": [[125, "engforge.eng.pipes.FlowInput.check_ref_slot_type", false]], "check_ref_slot_type() (flownode class method)": [[126, "engforge.eng.pipes.FlowNode.check_ref_slot_type", false]], "check_ref_slot_type() (fluidmaterial class method)": [[101, "engforge.eng.fluid_material.FluidMaterial.check_ref_slot_type", false]], "check_ref_slot_type() (globaldynamics class method)": [[85, "engforge.dynamics.GlobalDynamics.check_ref_slot_type", false]], "check_ref_slot_type() (hollowcircle class method)": [[115, "engforge.eng.geometry.HollowCircle.check_ref_slot_type", false]], "check_ref_slot_type() (hydrogen class method)": [[102, "engforge.eng.fluid_material.Hydrogen.check_ref_slot_type", false]], "check_ref_slot_type() (idealair class method)": [[103, "engforge.eng.fluid_material.IdealAir.check_ref_slot_type", false]], "check_ref_slot_type() (idealgas class method)": [[104, "engforge.eng.fluid_material.IdealGas.check_ref_slot_type", false]], "check_ref_slot_type() (idealh2 class method)": [[105, "engforge.eng.fluid_material.IdealH2.check_ref_slot_type", false]], "check_ref_slot_type() (idealoxygen class method)": [[106, "engforge.eng.fluid_material.IdealOxygen.check_ref_slot_type", false]], "check_ref_slot_type() (idealsteam class method)": [[107, "engforge.eng.fluid_material.IdealSteam.check_ref_slot_type", false]], "check_ref_slot_type() (oxygen class method)": [[108, "engforge.eng.fluid_material.Oxygen.check_ref_slot_type", false]], "check_ref_slot_type() (pipe class method)": [[127, "engforge.eng.pipes.Pipe.check_ref_slot_type", false]], "check_ref_slot_type() (pipefitting class method)": [[128, "engforge.eng.pipes.PipeFitting.check_ref_slot_type", false]], "check_ref_slot_type() (pipeflow class method)": [[129, "engforge.eng.pipes.PipeFlow.check_ref_slot_type", false]], "check_ref_slot_type() (pipenode class method)": [[131, "engforge.eng.pipes.PipeNode.check_ref_slot_type", false]], "check_ref_slot_type() (pipesystem class method)": [[132, "engforge.eng.pipes.PipeSystem.check_ref_slot_type", false]], "check_ref_slot_type() (profile2d class method)": [[117, "engforge.eng.geometry.Profile2D.check_ref_slot_type", false]], "check_ref_slot_type() (pump class method)": [[133, "engforge.eng.pipes.Pump.check_ref_slot_type", false]], "check_ref_slot_type() (rectangle class method)": [[118, "engforge.eng.geometry.Rectangle.check_ref_slot_type", false]], "check_ref_slot_type() (rock class method)": [[143, "engforge.eng.solid_materials.Rock.check_ref_slot_type", false]], "check_ref_slot_type() (rubber class method)": [[144, "engforge.eng.solid_materials.Rubber.check_ref_slot_type", false]], "check_ref_slot_type() (seawater class method)": [[109, "engforge.eng.fluid_material.SeaWater.check_ref_slot_type", false]], "check_ref_slot_type() (shapelysection class method)": [[119, "engforge.eng.geometry.ShapelySection.check_ref_slot_type", false]], "check_ref_slot_type() (simplecompressor class method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.check_ref_slot_type", false]], "check_ref_slot_type() (simpleheatexchanger class method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.check_ref_slot_type", false]], "check_ref_slot_type() (simplepump class method)": [[156, "engforge.eng.thermodynamics.SimplePump.check_ref_slot_type", false]], "check_ref_slot_type() (simpleturbine class method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.check_ref_slot_type", false]], "check_ref_slot_type() (solidmaterial class method)": [[146, "engforge.eng.solid_materials.SolidMaterial.check_ref_slot_type", false]], "check_ref_slot_type() (solveableinterface class method)": [[49, "engforge.components.SolveableInterface.check_ref_slot_type", false]], "check_ref_slot_type() (solveablemixin class method)": [[219, "engforge.solveable.SolveableMixin.check_ref_slot_type", false]], "check_ref_slot_type() (solvermixin class method)": [[222, "engforge.solver.SolverMixin.check_ref_slot_type", false]], "check_ref_slot_type() (ss_316 class method)": [[145, "engforge.eng.solid_materials.SS_316.check_ref_slot_type", false]], "check_ref_slot_type() (steam class method)": [[110, "engforge.eng.fluid_material.Steam.check_ref_slot_type", false]], "check_ref_slot_type() (system class method)": [[240, "engforge.system.System.check_ref_slot_type", false]], "check_ref_slot_type() (tabulationmixin class method)": [[253, "engforge.tabulation.TabulationMixin.check_ref_slot_type", false]], "check_ref_slot_type() (triangle class method)": [[120, "engforge.eng.geometry.Triangle.check_ref_slot_type", false]], "check_ref_slot_type() (water class method)": [[111, "engforge.eng.fluid_material.Water.check_ref_slot_type", false]], "check_ref_slot_type() (wetsoil class method)": [[147, "engforge.eng.solid_materials.WetSoil.check_ref_slot_type", false]], "check_symmetric() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.check_symmetric", false]], "chunks() (in module engforge.common)": [[37, "engforge.common.chunks", false]], "chunks() (in module engforge.patterns)": [[180, "engforge.patterns.chunks", false]], "circle (class in engforge.eng.geometry)": [[113, "engforge.eng.geometry.Circle", false]], "class_cache (class in engforge.properties)": [[198, "engforge.properties.class_cache", false]], "class_cache (problem attribute)": [[188, "engforge.problem_context.Problem.class_cache", false]], "class_cache (problemexec attribute)": [[189, "engforge.problem_context.ProblemExec.class_cache", false]], "class_cost_properties() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.class_cost_properties", false]], "class_cost_properties() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.class_cost_properties", false]], "class_validate() (attr_base class method)": [[33, "engforge.attributes.ATTR_BASE.class_validate", false]], "class_validate() (plot class method)": [[9, "engforge.attr_plotting.Plot.class_validate", false]], "class_validate() (plotbase class method)": [[10, "engforge.attr_plotting.PlotBase.class_validate", false]], "class_validate() (signal class method)": [[22, "engforge.attr_signals.Signal.class_validate", false]], "class_validate() (slot class method)": [[25, "engforge.attr_slots.Slot.class_validate", false]], "class_validate() (solver class method)": [[29, "engforge.attr_solver.Solver.class_validate", false]], "class_validate() (time class method)": [[7, "engforge.attr_dynamics.Time.class_validate", false]], "class_validate() (trace class method)": [[14, "engforge.attr_plotting.Trace.class_validate", false]], "classname (air property)": [[97, "engforge.eng.fluid_material.Air.classname", false]], "classname (airwatermix property)": [[98, "engforge.eng.fluid_material.AirWaterMix.classname", false]], "classname (aluminum property)": [[139, "engforge.eng.solid_materials.Aluminum.classname", false]], "classname (analysis property)": [[2, "engforge.analysis.Analysis.classname", false]], "classname (ansi_4130 property)": [[137, "engforge.eng.solid_materials.ANSI_4130.classname", false]], "classname (ansi_4340 property)": [[138, "engforge.eng.solid_materials.ANSI_4340.classname", false]], "classname (beam property)": [[151, "engforge.eng.structure_beams.Beam.classname", false]], "classname (carbonfiber property)": [[140, "engforge.eng.solid_materials.CarbonFiber.classname", false]], "classname (circle property)": [[113, "engforge.eng.geometry.Circle.classname", false]], "classname (component property)": [[48, "engforge.components.Component.classname", false]], "classname (componentdict property)": [[42, "engforge.component_collections.ComponentDict.classname", false]], "classname (componentiter property)": [[43, "engforge.component_collections.ComponentIter.classname", false]], "classname (componentiterator property)": [[44, "engforge.component_collections.ComponentIterator.classname", false]], "classname (concrete property)": [[141, "engforge.eng.solid_materials.Concrete.classname", false]], "classname (configuration property)": [[52, "engforge.configuration.Configuration.classname", false]], "classname (coolpropmaterial property)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.classname", false]], "classname (coolpropmixture property)": [[100, "engforge.eng.fluid_material.CoolPropMixture.classname", false]], "classname (costmodel property)": [[91, "engforge.eng.costs.CostModel.classname", false]], "classname (drysoil property)": [[142, "engforge.eng.solid_materials.DrySoil.classname", false]], "classname (dynamicsmixin property)": [[84, "engforge.dynamics.DynamicsMixin.classname", false]], "classname (economics property)": [[92, "engforge.eng.costs.Economics.classname", false]], "classname (flowinput property)": [[125, "engforge.eng.pipes.FlowInput.classname", false]], "classname (flownode property)": [[126, "engforge.eng.pipes.FlowNode.classname", false]], "classname (fluidmaterial property)": [[101, "engforge.eng.fluid_material.FluidMaterial.classname", false]], "classname (globaldynamics property)": [[85, "engforge.dynamics.GlobalDynamics.classname", false]], "classname (hollowcircle property)": [[115, "engforge.eng.geometry.HollowCircle.classname", false]], "classname (hydrogen property)": [[102, "engforge.eng.fluid_material.Hydrogen.classname", false]], "classname (idealair property)": [[103, "engforge.eng.fluid_material.IdealAir.classname", false]], "classname (idealgas property)": [[104, "engforge.eng.fluid_material.IdealGas.classname", false]], "classname (idealh2 property)": [[105, "engforge.eng.fluid_material.IdealH2.classname", false]], "classname (idealoxygen property)": [[106, "engforge.eng.fluid_material.IdealOxygen.classname", false]], "classname (idealsteam property)": [[107, "engforge.eng.fluid_material.IdealSteam.classname", false]], "classname (oxygen property)": [[108, "engforge.eng.fluid_material.Oxygen.classname", false]], "classname (pipe property)": [[127, "engforge.eng.pipes.Pipe.classname", false]], "classname (pipefitting property)": [[128, "engforge.eng.pipes.PipeFitting.classname", false]], "classname (pipeflow property)": [[129, "engforge.eng.pipes.PipeFlow.classname", false]], "classname (pipenode property)": [[131, "engforge.eng.pipes.PipeNode.classname", false]], "classname (pipesystem property)": [[132, "engforge.eng.pipes.PipeSystem.classname", false]], "classname (profile2d property)": [[117, "engforge.eng.geometry.Profile2D.classname", false]], "classname (pump property)": [[133, "engforge.eng.pipes.Pump.classname", false]], "classname (rectangle property)": [[118, "engforge.eng.geometry.Rectangle.classname", false]], "classname (rock property)": [[143, "engforge.eng.solid_materials.Rock.classname", false]], "classname (rubber property)": [[144, "engforge.eng.solid_materials.Rubber.classname", false]], "classname (seawater property)": [[109, "engforge.eng.fluid_material.SeaWater.classname", false]], "classname (shapelysection property)": [[119, "engforge.eng.geometry.ShapelySection.classname", false]], "classname (simplecompressor property)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.classname", false]], "classname (simpleheatexchanger property)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.classname", false]], "classname (simplepump property)": [[156, "engforge.eng.thermodynamics.SimplePump.classname", false]], "classname (simpleturbine property)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.classname", false]], "classname (solidmaterial property)": [[146, "engforge.eng.solid_materials.SolidMaterial.classname", false]], "classname (solveableinterface property)": [[49, "engforge.components.SolveableInterface.classname", false]], "classname (ss_316 property)": [[145, "engforge.eng.solid_materials.SS_316.classname", false]], "classname (steam property)": [[110, "engforge.eng.fluid_material.Steam.classname", false]], "classname (system property)": [[240, "engforge.system.System.classname", false]], "classname (triangle property)": [[120, "engforge.eng.geometry.Triangle.classname", false]], "classname (water property)": [[111, "engforge.eng.fluid_material.Water.classname", false]], "classname (wetsoil property)": [[147, "engforge.eng.solid_materials.WetSoil.classname", false]], "clear() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.clear", false]], "clear() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.clear", false]], "client_path() (in module engforge.locations)": [[171, "engforge.locations.client_path", false]], "clone() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.clone", false]], "clone() (system method)": [[240, "engforge.system.System.clone", false]], "cls_compile() (air class method)": [[97, "engforge.eng.fluid_material.Air.cls_compile", false]], "cls_compile() (airwatermix class method)": [[98, "engforge.eng.fluid_material.AirWaterMix.cls_compile", false]], "cls_compile() (aluminum class method)": [[139, "engforge.eng.solid_materials.Aluminum.cls_compile", false]], "cls_compile() (analysis class method)": [[2, "engforge.analysis.Analysis.cls_compile", false]], "cls_compile() (ansi_4130 class method)": [[137, "engforge.eng.solid_materials.ANSI_4130.cls_compile", false]], "cls_compile() (ansi_4340 class method)": [[138, "engforge.eng.solid_materials.ANSI_4340.cls_compile", false]], "cls_compile() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.cls_compile", false]], "cls_compile() (carbonfiber class method)": [[140, "engforge.eng.solid_materials.CarbonFiber.cls_compile", false]], "cls_compile() (circle class method)": [[113, "engforge.eng.geometry.Circle.cls_compile", false]], "cls_compile() (component class method)": [[48, "engforge.components.Component.cls_compile", false]], "cls_compile() (componentdict class method)": [[42, "engforge.component_collections.ComponentDict.cls_compile", false]], "cls_compile() (componentiter class method)": [[43, "engforge.component_collections.ComponentIter.cls_compile", false]], "cls_compile() (componentiterator class method)": [[44, "engforge.component_collections.ComponentIterator.cls_compile", false]], "cls_compile() (concrete class method)": [[141, "engforge.eng.solid_materials.Concrete.cls_compile", false]], "cls_compile() (configuration class method)": [[52, "engforge.configuration.Configuration.cls_compile", false]], "cls_compile() (coolpropmaterial class method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.cls_compile", false]], "cls_compile() (coolpropmixture class method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.cls_compile", false]], "cls_compile() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.cls_compile", false]], "cls_compile() (drysoil class method)": [[142, "engforge.eng.solid_materials.DrySoil.cls_compile", false]], "cls_compile() (dynamicsmixin class method)": [[84, "engforge.dynamics.DynamicsMixin.cls_compile", false]], "cls_compile() (economics class method)": [[92, "engforge.eng.costs.Economics.cls_compile", false]], "cls_compile() (flowinput class method)": [[125, "engforge.eng.pipes.FlowInput.cls_compile", false]], "cls_compile() (flownode class method)": [[126, "engforge.eng.pipes.FlowNode.cls_compile", false]], "cls_compile() (fluidmaterial class method)": [[101, "engforge.eng.fluid_material.FluidMaterial.cls_compile", false]], "cls_compile() (globaldynamics class method)": [[85, "engforge.dynamics.GlobalDynamics.cls_compile", false]], "cls_compile() (hollowcircle class method)": [[115, "engforge.eng.geometry.HollowCircle.cls_compile", false]], "cls_compile() (hydrogen class method)": [[102, "engforge.eng.fluid_material.Hydrogen.cls_compile", false]], "cls_compile() (idealair class method)": [[103, "engforge.eng.fluid_material.IdealAir.cls_compile", false]], "cls_compile() (idealgas class method)": [[104, "engforge.eng.fluid_material.IdealGas.cls_compile", false]], "cls_compile() (idealh2 class method)": [[105, "engforge.eng.fluid_material.IdealH2.cls_compile", false]], "cls_compile() (idealoxygen class method)": [[106, "engforge.eng.fluid_material.IdealOxygen.cls_compile", false]], "cls_compile() (idealsteam class method)": [[107, "engforge.eng.fluid_material.IdealSteam.cls_compile", false]], "cls_compile() (oxygen class method)": [[108, "engforge.eng.fluid_material.Oxygen.cls_compile", false]], "cls_compile() (pipe class method)": [[127, "engforge.eng.pipes.Pipe.cls_compile", false]], "cls_compile() (pipefitting class method)": [[128, "engforge.eng.pipes.PipeFitting.cls_compile", false]], "cls_compile() (pipeflow class method)": [[129, "engforge.eng.pipes.PipeFlow.cls_compile", false]], "cls_compile() (pipenode class method)": [[131, "engforge.eng.pipes.PipeNode.cls_compile", false]], "cls_compile() (pipesystem class method)": [[132, "engforge.eng.pipes.PipeSystem.cls_compile", false]], "cls_compile() (profile2d class method)": [[117, "engforge.eng.geometry.Profile2D.cls_compile", false]], "cls_compile() (pump class method)": [[133, "engforge.eng.pipes.Pump.cls_compile", false]], "cls_compile() (rectangle class method)": [[118, "engforge.eng.geometry.Rectangle.cls_compile", false]], "cls_compile() (rock class method)": [[143, "engforge.eng.solid_materials.Rock.cls_compile", false]], "cls_compile() (rubber class method)": [[144, "engforge.eng.solid_materials.Rubber.cls_compile", false]], "cls_compile() (seawater class method)": [[109, "engforge.eng.fluid_material.SeaWater.cls_compile", false]], "cls_compile() (shapelysection class method)": [[119, "engforge.eng.geometry.ShapelySection.cls_compile", false]], "cls_compile() (simplecompressor class method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.cls_compile", false]], "cls_compile() (simpleheatexchanger class method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.cls_compile", false]], "cls_compile() (simplepump class method)": [[156, "engforge.eng.thermodynamics.SimplePump.cls_compile", false]], "cls_compile() (simpleturbine class method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.cls_compile", false]], "cls_compile() (solidmaterial class method)": [[146, "engforge.eng.solid_materials.SolidMaterial.cls_compile", false]], "cls_compile() (solveableinterface class method)": [[49, "engforge.components.SolveableInterface.cls_compile", false]], "cls_compile() (ss_316 class method)": [[145, "engforge.eng.solid_materials.SS_316.cls_compile", false]], "cls_compile() (steam class method)": [[110, "engforge.eng.fluid_material.Steam.cls_compile", false]], "cls_compile() (system class method)": [[240, "engforge.system.System.cls_compile", false]], "cls_compile() (triangle class method)": [[120, "engforge.eng.geometry.Triangle.cls_compile", false]], "cls_compile() (water class method)": [[111, "engforge.eng.fluid_material.Water.cls_compile", false]], "cls_compile() (wetsoil class method)": [[147, "engforge.eng.solid_materials.WetSoil.cls_compile", false]], "collect_all_attributes() (air class method)": [[97, "engforge.eng.fluid_material.Air.collect_all_attributes", false]], "collect_all_attributes() (airwatermix class method)": [[98, "engforge.eng.fluid_material.AirWaterMix.collect_all_attributes", false]], "collect_all_attributes() (aluminum class method)": [[139, "engforge.eng.solid_materials.Aluminum.collect_all_attributes", false]], "collect_all_attributes() (analysis class method)": [[2, "engforge.analysis.Analysis.collect_all_attributes", false]], "collect_all_attributes() (ansi_4130 class method)": [[137, "engforge.eng.solid_materials.ANSI_4130.collect_all_attributes", false]], "collect_all_attributes() (ansi_4340 class method)": [[138, "engforge.eng.solid_materials.ANSI_4340.collect_all_attributes", false]], "collect_all_attributes() (attributedbasemixin class method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.collect_all_attributes", false]], "collect_all_attributes() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.collect_all_attributes", false]], "collect_all_attributes() (carbonfiber class method)": [[140, "engforge.eng.solid_materials.CarbonFiber.collect_all_attributes", false]], "collect_all_attributes() (circle class method)": [[113, "engforge.eng.geometry.Circle.collect_all_attributes", false]], "collect_all_attributes() (component class method)": [[48, "engforge.components.Component.collect_all_attributes", false]], "collect_all_attributes() (componentdict class method)": [[42, "engforge.component_collections.ComponentDict.collect_all_attributes", false]], "collect_all_attributes() (componentiter class method)": [[43, "engforge.component_collections.ComponentIter.collect_all_attributes", false]], "collect_all_attributes() (componentiterator class method)": [[44, "engforge.component_collections.ComponentIterator.collect_all_attributes", false]], "collect_all_attributes() (concrete class method)": [[141, "engforge.eng.solid_materials.Concrete.collect_all_attributes", false]], "collect_all_attributes() (configuration class method)": [[52, "engforge.configuration.Configuration.collect_all_attributes", false]], "collect_all_attributes() (coolpropmaterial class method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.collect_all_attributes", false]], "collect_all_attributes() (coolpropmixture class method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.collect_all_attributes", false]], "collect_all_attributes() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.collect_all_attributes", false]], "collect_all_attributes() (drysoil class method)": [[142, "engforge.eng.solid_materials.DrySoil.collect_all_attributes", false]], "collect_all_attributes() (dynamicsmixin class method)": [[84, "engforge.dynamics.DynamicsMixin.collect_all_attributes", false]], "collect_all_attributes() (economics class method)": [[92, "engforge.eng.costs.Economics.collect_all_attributes", false]], "collect_all_attributes() (flowinput class method)": [[125, "engforge.eng.pipes.FlowInput.collect_all_attributes", false]], "collect_all_attributes() (flownode class method)": [[126, "engforge.eng.pipes.FlowNode.collect_all_attributes", false]], "collect_all_attributes() (fluidmaterial class method)": [[101, "engforge.eng.fluid_material.FluidMaterial.collect_all_attributes", false]], "collect_all_attributes() (globaldynamics class method)": [[85, "engforge.dynamics.GlobalDynamics.collect_all_attributes", false]], "collect_all_attributes() (hollowcircle class method)": [[115, "engforge.eng.geometry.HollowCircle.collect_all_attributes", false]], "collect_all_attributes() (hydrogen class method)": [[102, "engforge.eng.fluid_material.Hydrogen.collect_all_attributes", false]], "collect_all_attributes() (idealair class method)": [[103, "engforge.eng.fluid_material.IdealAir.collect_all_attributes", false]], "collect_all_attributes() (idealgas class method)": [[104, "engforge.eng.fluid_material.IdealGas.collect_all_attributes", false]], "collect_all_attributes() (idealh2 class method)": [[105, "engforge.eng.fluid_material.IdealH2.collect_all_attributes", false]], "collect_all_attributes() (idealoxygen class method)": [[106, "engforge.eng.fluid_material.IdealOxygen.collect_all_attributes", false]], "collect_all_attributes() (idealsteam class method)": [[107, "engforge.eng.fluid_material.IdealSteam.collect_all_attributes", false]], "collect_all_attributes() (oxygen class method)": [[108, "engforge.eng.fluid_material.Oxygen.collect_all_attributes", false]], "collect_all_attributes() (pipe class method)": [[127, "engforge.eng.pipes.Pipe.collect_all_attributes", false]], "collect_all_attributes() (pipefitting class method)": [[128, "engforge.eng.pipes.PipeFitting.collect_all_attributes", false]], "collect_all_attributes() (pipeflow class method)": [[129, "engforge.eng.pipes.PipeFlow.collect_all_attributes", false]], "collect_all_attributes() (pipenode class method)": [[131, "engforge.eng.pipes.PipeNode.collect_all_attributes", false]], "collect_all_attributes() (pipesystem class method)": [[132, "engforge.eng.pipes.PipeSystem.collect_all_attributes", false]], "collect_all_attributes() (profile2d class method)": [[117, "engforge.eng.geometry.Profile2D.collect_all_attributes", false]], "collect_all_attributes() (pump class method)": [[133, "engforge.eng.pipes.Pump.collect_all_attributes", false]], "collect_all_attributes() (rectangle class method)": [[118, "engforge.eng.geometry.Rectangle.collect_all_attributes", false]], "collect_all_attributes() (rock class method)": [[143, "engforge.eng.solid_materials.Rock.collect_all_attributes", false]], "collect_all_attributes() (rubber class method)": [[144, "engforge.eng.solid_materials.Rubber.collect_all_attributes", false]], "collect_all_attributes() (seawater class method)": [[109, "engforge.eng.fluid_material.SeaWater.collect_all_attributes", false]], "collect_all_attributes() (shapelysection class method)": [[119, "engforge.eng.geometry.ShapelySection.collect_all_attributes", false]], "collect_all_attributes() (simplecompressor class method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.collect_all_attributes", false]], "collect_all_attributes() (simpleheatexchanger class method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.collect_all_attributes", false]], "collect_all_attributes() (simplepump class method)": [[156, "engforge.eng.thermodynamics.SimplePump.collect_all_attributes", false]], "collect_all_attributes() (simpleturbine class method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.collect_all_attributes", false]], "collect_all_attributes() (solidmaterial class method)": [[146, "engforge.eng.solid_materials.SolidMaterial.collect_all_attributes", false]], "collect_all_attributes() (solveableinterface class method)": [[49, "engforge.components.SolveableInterface.collect_all_attributes", false]], "collect_all_attributes() (solveablemixin class method)": [[219, "engforge.solveable.SolveableMixin.collect_all_attributes", false]], "collect_all_attributes() (solvermixin class method)": [[222, "engforge.solver.SolverMixin.collect_all_attributes", false]], "collect_all_attributes() (ss_316 class method)": [[145, "engforge.eng.solid_materials.SS_316.collect_all_attributes", false]], "collect_all_attributes() (steam class method)": [[110, "engforge.eng.fluid_material.Steam.collect_all_attributes", false]], "collect_all_attributes() (system class method)": [[240, "engforge.system.System.collect_all_attributes", false]], "collect_all_attributes() (tabulationmixin class method)": [[253, "engforge.tabulation.TabulationMixin.collect_all_attributes", false]], "collect_all_attributes() (triangle class method)": [[120, "engforge.eng.geometry.Triangle.collect_all_attributes", false]], "collect_all_attributes() (water class method)": [[111, "engforge.eng.fluid_material.Water.collect_all_attributes", false]], "collect_all_attributes() (wetsoil class method)": [[147, "engforge.eng.solid_materials.WetSoil.collect_all_attributes", false]], "collect_attr_inst() (attr_base class method)": [[33, "engforge.attributes.ATTR_BASE.collect_attr_inst", false]], "collect_attr_inst() (plot class method)": [[9, "engforge.attr_plotting.Plot.collect_attr_inst", false]], "collect_attr_inst() (plotbase class method)": [[10, "engforge.attr_plotting.PlotBase.collect_attr_inst", false]], "collect_attr_inst() (signal class method)": [[22, "engforge.attr_signals.Signal.collect_attr_inst", false]], "collect_attr_inst() (slot class method)": [[25, "engforge.attr_slots.Slot.collect_attr_inst", false]], "collect_attr_inst() (solver class method)": [[29, "engforge.attr_solver.Solver.collect_attr_inst", false]], "collect_attr_inst() (time class method)": [[7, "engforge.attr_dynamics.Time.collect_attr_inst", false]], "collect_attr_inst() (trace class method)": [[14, "engforge.attr_plotting.Trace.collect_attr_inst", false]], "collect_cls() (attr_base class method)": [[33, "engforge.attributes.ATTR_BASE.collect_cls", false]], "collect_cls() (plot class method)": [[9, "engforge.attr_plotting.Plot.collect_cls", false]], "collect_cls() (plotbase class method)": [[10, "engforge.attr_plotting.PlotBase.collect_cls", false]], "collect_cls() (signal class method)": [[22, "engforge.attr_signals.Signal.collect_cls", false]], "collect_cls() (slot class method)": [[25, "engforge.attr_slots.Slot.collect_cls", false]], "collect_cls() (solver class method)": [[29, "engforge.attr_solver.Solver.collect_cls", false]], "collect_cls() (time class method)": [[7, "engforge.attr_dynamics.Time.collect_cls", false]], "collect_cls() (trace class method)": [[14, "engforge.attr_plotting.Trace.collect_cls", false]], "collect_comp_refs() (air method)": [[97, "engforge.eng.fluid_material.Air.collect_comp_refs", false]], "collect_comp_refs() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.collect_comp_refs", false]], "collect_comp_refs() (analysis method)": [[2, "engforge.analysis.Analysis.collect_comp_refs", false]], "collect_comp_refs() (beam method)": [[151, "engforge.eng.structure_beams.Beam.collect_comp_refs", false]], "collect_comp_refs() (component method)": [[48, "engforge.components.Component.collect_comp_refs", false]], "collect_comp_refs() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.collect_comp_refs", false]], "collect_comp_refs() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.collect_comp_refs", false]], "collect_comp_refs() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.collect_comp_refs", false]], "collect_comp_refs() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.collect_comp_refs", false]], "collect_comp_refs() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.collect_comp_refs", false]], "collect_comp_refs() (costmodel method)": [[91, "engforge.eng.costs.CostModel.collect_comp_refs", false]], "collect_comp_refs() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.collect_comp_refs", false]], "collect_comp_refs() (economics method)": [[92, "engforge.eng.costs.Economics.collect_comp_refs", false]], "collect_comp_refs() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.collect_comp_refs", false]], "collect_comp_refs() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.collect_comp_refs", false]], "collect_comp_refs() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.collect_comp_refs", false]], "collect_comp_refs() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.collect_comp_refs", false]], "collect_comp_refs() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.collect_comp_refs", false]], "collect_comp_refs() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.collect_comp_refs", false]], "collect_comp_refs() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.collect_comp_refs", false]], "collect_comp_refs() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.collect_comp_refs", false]], "collect_comp_refs() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.collect_comp_refs", false]], "collect_comp_refs() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.collect_comp_refs", false]], "collect_comp_refs() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.collect_comp_refs", false]], "collect_comp_refs() (pipe method)": [[127, "engforge.eng.pipes.Pipe.collect_comp_refs", false]], "collect_comp_refs() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.collect_comp_refs", false]], "collect_comp_refs() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.collect_comp_refs", false]], "collect_comp_refs() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.collect_comp_refs", false]], "collect_comp_refs() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.collect_comp_refs", false]], "collect_comp_refs() (pump method)": [[133, "engforge.eng.pipes.Pump.collect_comp_refs", false]], "collect_comp_refs() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.collect_comp_refs", false]], "collect_comp_refs() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.collect_comp_refs", false]], "collect_comp_refs() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.collect_comp_refs", false]], "collect_comp_refs() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.collect_comp_refs", false]], "collect_comp_refs() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.collect_comp_refs", false]], "collect_comp_refs() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.collect_comp_refs", false]], "collect_comp_refs() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.collect_comp_refs", false]], "collect_comp_refs() (solvermixin method)": [[222, "engforge.solver.SolverMixin.collect_comp_refs", false]], "collect_comp_refs() (steam method)": [[110, "engforge.eng.fluid_material.Steam.collect_comp_refs", false]], "collect_comp_refs() (system method)": [[240, "engforge.system.System.collect_comp_refs", false]], "collect_comp_refs() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.collect_comp_refs", false]], "collect_comp_refs() (water method)": [[111, "engforge.eng.fluid_material.Water.collect_comp_refs", false]], "collect_dynamic_refs() (air method)": [[97, "engforge.eng.fluid_material.Air.collect_dynamic_refs", false]], "collect_dynamic_refs() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.collect_dynamic_refs", false]], "collect_dynamic_refs() (analysis method)": [[2, "engforge.analysis.Analysis.collect_dynamic_refs", false]], "collect_dynamic_refs() (beam method)": [[151, "engforge.eng.structure_beams.Beam.collect_dynamic_refs", false]], "collect_dynamic_refs() (component method)": [[48, "engforge.components.Component.collect_dynamic_refs", false]], "collect_dynamic_refs() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.collect_dynamic_refs", false]], "collect_dynamic_refs() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.collect_dynamic_refs", false]], "collect_dynamic_refs() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.collect_dynamic_refs", false]], "collect_dynamic_refs() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.collect_dynamic_refs", false]], "collect_dynamic_refs() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.collect_dynamic_refs", false]], "collect_dynamic_refs() (costmodel method)": [[91, "engforge.eng.costs.CostModel.collect_dynamic_refs", false]], "collect_dynamic_refs() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.collect_dynamic_refs", false]], "collect_dynamic_refs() (economics method)": [[92, "engforge.eng.costs.Economics.collect_dynamic_refs", false]], "collect_dynamic_refs() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.collect_dynamic_refs", false]], "collect_dynamic_refs() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.collect_dynamic_refs", false]], "collect_dynamic_refs() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.collect_dynamic_refs", false]], "collect_dynamic_refs() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.collect_dynamic_refs", false]], "collect_dynamic_refs() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.collect_dynamic_refs", false]], "collect_dynamic_refs() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.collect_dynamic_refs", false]], "collect_dynamic_refs() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.collect_dynamic_refs", false]], "collect_dynamic_refs() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.collect_dynamic_refs", false]], "collect_dynamic_refs() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.collect_dynamic_refs", false]], "collect_dynamic_refs() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.collect_dynamic_refs", false]], "collect_dynamic_refs() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.collect_dynamic_refs", false]], "collect_dynamic_refs() (pipe method)": [[127, "engforge.eng.pipes.Pipe.collect_dynamic_refs", false]], "collect_dynamic_refs() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.collect_dynamic_refs", false]], "collect_dynamic_refs() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.collect_dynamic_refs", false]], "collect_dynamic_refs() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.collect_dynamic_refs", false]], "collect_dynamic_refs() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.collect_dynamic_refs", false]], "collect_dynamic_refs() (pump method)": [[133, "engforge.eng.pipes.Pump.collect_dynamic_refs", false]], "collect_dynamic_refs() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.collect_dynamic_refs", false]], "collect_dynamic_refs() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.collect_dynamic_refs", false]], "collect_dynamic_refs() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.collect_dynamic_refs", false]], "collect_dynamic_refs() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.collect_dynamic_refs", false]], "collect_dynamic_refs() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.collect_dynamic_refs", false]], "collect_dynamic_refs() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.collect_dynamic_refs", false]], "collect_dynamic_refs() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.collect_dynamic_refs", false]], "collect_dynamic_refs() (solvermixin method)": [[222, "engforge.solver.SolverMixin.collect_dynamic_refs", false]], "collect_dynamic_refs() (steam method)": [[110, "engforge.eng.fluid_material.Steam.collect_dynamic_refs", false]], "collect_dynamic_refs() (system method)": [[240, "engforge.system.System.collect_dynamic_refs", false]], "collect_dynamic_refs() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.collect_dynamic_refs", false]], "collect_dynamic_refs() (water method)": [[111, "engforge.eng.fluid_material.Water.collect_dynamic_refs", false]], "collect_inst_attributes() (air method)": [[97, "engforge.eng.fluid_material.Air.collect_inst_attributes", false]], "collect_inst_attributes() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.collect_inst_attributes", false]], "collect_inst_attributes() (aluminum method)": [[139, "engforge.eng.solid_materials.Aluminum.collect_inst_attributes", false]], "collect_inst_attributes() (analysis method)": [[2, "engforge.analysis.Analysis.collect_inst_attributes", false]], "collect_inst_attributes() (ansi_4130 method)": [[137, "engforge.eng.solid_materials.ANSI_4130.collect_inst_attributes", false]], "collect_inst_attributes() (ansi_4340 method)": [[138, "engforge.eng.solid_materials.ANSI_4340.collect_inst_attributes", false]], "collect_inst_attributes() (attributedbasemixin method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.collect_inst_attributes", false]], "collect_inst_attributes() (beam method)": [[151, "engforge.eng.structure_beams.Beam.collect_inst_attributes", false]], "collect_inst_attributes() (carbonfiber method)": [[140, "engforge.eng.solid_materials.CarbonFiber.collect_inst_attributes", false]], "collect_inst_attributes() (circle method)": [[113, "engforge.eng.geometry.Circle.collect_inst_attributes", false]], "collect_inst_attributes() (component method)": [[48, "engforge.components.Component.collect_inst_attributes", false]], "collect_inst_attributes() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.collect_inst_attributes", false]], "collect_inst_attributes() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.collect_inst_attributes", false]], "collect_inst_attributes() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.collect_inst_attributes", false]], "collect_inst_attributes() (concrete method)": [[141, "engforge.eng.solid_materials.Concrete.collect_inst_attributes", false]], "collect_inst_attributes() (configuration method)": [[52, "engforge.configuration.Configuration.collect_inst_attributes", false]], "collect_inst_attributes() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.collect_inst_attributes", false]], "collect_inst_attributes() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.collect_inst_attributes", false]], "collect_inst_attributes() (costmodel method)": [[91, "engforge.eng.costs.CostModel.collect_inst_attributes", false]], "collect_inst_attributes() (drysoil method)": [[142, "engforge.eng.solid_materials.DrySoil.collect_inst_attributes", false]], "collect_inst_attributes() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.collect_inst_attributes", false]], "collect_inst_attributes() (economics method)": [[92, "engforge.eng.costs.Economics.collect_inst_attributes", false]], "collect_inst_attributes() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.collect_inst_attributes", false]], "collect_inst_attributes() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.collect_inst_attributes", false]], "collect_inst_attributes() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.collect_inst_attributes", false]], "collect_inst_attributes() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.collect_inst_attributes", false]], "collect_inst_attributes() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.collect_inst_attributes", false]], "collect_inst_attributes() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.collect_inst_attributes", false]], "collect_inst_attributes() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.collect_inst_attributes", false]], "collect_inst_attributes() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.collect_inst_attributes", false]], "collect_inst_attributes() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.collect_inst_attributes", false]], "collect_inst_attributes() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.collect_inst_attributes", false]], "collect_inst_attributes() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.collect_inst_attributes", false]], "collect_inst_attributes() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.collect_inst_attributes", false]], "collect_inst_attributes() (pipe method)": [[127, "engforge.eng.pipes.Pipe.collect_inst_attributes", false]], "collect_inst_attributes() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.collect_inst_attributes", false]], "collect_inst_attributes() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.collect_inst_attributes", false]], "collect_inst_attributes() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.collect_inst_attributes", false]], "collect_inst_attributes() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.collect_inst_attributes", false]], "collect_inst_attributes() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.collect_inst_attributes", false]], "collect_inst_attributes() (pump method)": [[133, "engforge.eng.pipes.Pump.collect_inst_attributes", false]], "collect_inst_attributes() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.collect_inst_attributes", false]], "collect_inst_attributes() (rock method)": [[143, "engforge.eng.solid_materials.Rock.collect_inst_attributes", false]], "collect_inst_attributes() (rubber method)": [[144, "engforge.eng.solid_materials.Rubber.collect_inst_attributes", false]], "collect_inst_attributes() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.collect_inst_attributes", false]], "collect_inst_attributes() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.collect_inst_attributes", false]], "collect_inst_attributes() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.collect_inst_attributes", false]], "collect_inst_attributes() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.collect_inst_attributes", false]], "collect_inst_attributes() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.collect_inst_attributes", false]], "collect_inst_attributes() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.collect_inst_attributes", false]], "collect_inst_attributes() (solidmaterial method)": [[146, "engforge.eng.solid_materials.SolidMaterial.collect_inst_attributes", false]], "collect_inst_attributes() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.collect_inst_attributes", false]], "collect_inst_attributes() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.collect_inst_attributes", false]], "collect_inst_attributes() (solvermixin method)": [[222, "engforge.solver.SolverMixin.collect_inst_attributes", false]], "collect_inst_attributes() (ss_316 method)": [[145, "engforge.eng.solid_materials.SS_316.collect_inst_attributes", false]], "collect_inst_attributes() (steam method)": [[110, "engforge.eng.fluid_material.Steam.collect_inst_attributes", false]], "collect_inst_attributes() (system method)": [[240, "engforge.system.System.collect_inst_attributes", false]], "collect_inst_attributes() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.collect_inst_attributes", false]], "collect_inst_attributes() (triangle method)": [[120, "engforge.eng.geometry.Triangle.collect_inst_attributes", false]], "collect_inst_attributes() (water method)": [[111, "engforge.eng.fluid_material.Water.collect_inst_attributes", false]], "collect_inst_attributes() (wetsoil method)": [[147, "engforge.eng.solid_materials.WetSoil.collect_inst_attributes", false]], "collect_post_update_refs() (air method)": [[97, "engforge.eng.fluid_material.Air.collect_post_update_refs", false]], "collect_post_update_refs() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.collect_post_update_refs", false]], "collect_post_update_refs() (analysis method)": [[2, "engforge.analysis.Analysis.collect_post_update_refs", false]], "collect_post_update_refs() (beam method)": [[151, "engforge.eng.structure_beams.Beam.collect_post_update_refs", false]], "collect_post_update_refs() (component method)": [[48, "engforge.components.Component.collect_post_update_refs", false]], "collect_post_update_refs() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.collect_post_update_refs", false]], "collect_post_update_refs() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.collect_post_update_refs", false]], "collect_post_update_refs() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.collect_post_update_refs", false]], "collect_post_update_refs() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.collect_post_update_refs", false]], "collect_post_update_refs() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.collect_post_update_refs", false]], "collect_post_update_refs() (costmodel method)": [[91, "engforge.eng.costs.CostModel.collect_post_update_refs", false]], "collect_post_update_refs() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.collect_post_update_refs", false]], "collect_post_update_refs() (economics method)": [[92, "engforge.eng.costs.Economics.collect_post_update_refs", false]], "collect_post_update_refs() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.collect_post_update_refs", false]], "collect_post_update_refs() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.collect_post_update_refs", false]], "collect_post_update_refs() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.collect_post_update_refs", false]], "collect_post_update_refs() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.collect_post_update_refs", false]], "collect_post_update_refs() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.collect_post_update_refs", false]], "collect_post_update_refs() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.collect_post_update_refs", false]], "collect_post_update_refs() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.collect_post_update_refs", false]], "collect_post_update_refs() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.collect_post_update_refs", false]], "collect_post_update_refs() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.collect_post_update_refs", false]], "collect_post_update_refs() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.collect_post_update_refs", false]], "collect_post_update_refs() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.collect_post_update_refs", false]], "collect_post_update_refs() (pipe method)": [[127, "engforge.eng.pipes.Pipe.collect_post_update_refs", false]], "collect_post_update_refs() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.collect_post_update_refs", false]], "collect_post_update_refs() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.collect_post_update_refs", false]], "collect_post_update_refs() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.collect_post_update_refs", false]], "collect_post_update_refs() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.collect_post_update_refs", false]], "collect_post_update_refs() (pump method)": [[133, "engforge.eng.pipes.Pump.collect_post_update_refs", false]], "collect_post_update_refs() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.collect_post_update_refs", false]], "collect_post_update_refs() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.collect_post_update_refs", false]], "collect_post_update_refs() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.collect_post_update_refs", false]], "collect_post_update_refs() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.collect_post_update_refs", false]], "collect_post_update_refs() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.collect_post_update_refs", false]], "collect_post_update_refs() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.collect_post_update_refs", false]], "collect_post_update_refs() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.collect_post_update_refs", false]], "collect_post_update_refs() (solvermixin method)": [[222, "engforge.solver.SolverMixin.collect_post_update_refs", false]], "collect_post_update_refs() (steam method)": [[110, "engforge.eng.fluid_material.Steam.collect_post_update_refs", false]], "collect_post_update_refs() (system method)": [[240, "engforge.system.System.collect_post_update_refs", false]], "collect_post_update_refs() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.collect_post_update_refs", false]], "collect_post_update_refs() (water method)": [[111, "engforge.eng.fluid_material.Water.collect_post_update_refs", false]], "collect_solver_refs() (air method)": [[97, "engforge.eng.fluid_material.Air.collect_solver_refs", false]], "collect_solver_refs() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.collect_solver_refs", false]], "collect_solver_refs() (analysis method)": [[2, "engforge.analysis.Analysis.collect_solver_refs", false]], "collect_solver_refs() (beam method)": [[151, "engforge.eng.structure_beams.Beam.collect_solver_refs", false]], "collect_solver_refs() (component method)": [[48, "engforge.components.Component.collect_solver_refs", false]], "collect_solver_refs() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.collect_solver_refs", false]], "collect_solver_refs() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.collect_solver_refs", false]], "collect_solver_refs() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.collect_solver_refs", false]], "collect_solver_refs() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.collect_solver_refs", false]], "collect_solver_refs() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.collect_solver_refs", false]], "collect_solver_refs() (costmodel method)": [[91, "engforge.eng.costs.CostModel.collect_solver_refs", false]], "collect_solver_refs() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.collect_solver_refs", false]], "collect_solver_refs() (economics method)": [[92, "engforge.eng.costs.Economics.collect_solver_refs", false]], "collect_solver_refs() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.collect_solver_refs", false]], "collect_solver_refs() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.collect_solver_refs", false]], "collect_solver_refs() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.collect_solver_refs", false]], "collect_solver_refs() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.collect_solver_refs", false]], "collect_solver_refs() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.collect_solver_refs", false]], "collect_solver_refs() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.collect_solver_refs", false]], "collect_solver_refs() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.collect_solver_refs", false]], "collect_solver_refs() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.collect_solver_refs", false]], "collect_solver_refs() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.collect_solver_refs", false]], "collect_solver_refs() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.collect_solver_refs", false]], "collect_solver_refs() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.collect_solver_refs", false]], "collect_solver_refs() (pipe method)": [[127, "engforge.eng.pipes.Pipe.collect_solver_refs", false]], "collect_solver_refs() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.collect_solver_refs", false]], "collect_solver_refs() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.collect_solver_refs", false]], "collect_solver_refs() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.collect_solver_refs", false]], "collect_solver_refs() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.collect_solver_refs", false]], "collect_solver_refs() (pump method)": [[133, "engforge.eng.pipes.Pump.collect_solver_refs", false]], "collect_solver_refs() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.collect_solver_refs", false]], "collect_solver_refs() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.collect_solver_refs", false]], "collect_solver_refs() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.collect_solver_refs", false]], "collect_solver_refs() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.collect_solver_refs", false]], "collect_solver_refs() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.collect_solver_refs", false]], "collect_solver_refs() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.collect_solver_refs", false]], "collect_solver_refs() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.collect_solver_refs", false]], "collect_solver_refs() (solvermixin method)": [[222, "engforge.solver.SolverMixin.collect_solver_refs", false]], "collect_solver_refs() (steam method)": [[110, "engforge.eng.fluid_material.Steam.collect_solver_refs", false]], "collect_solver_refs() (system method)": [[240, "engforge.system.System.collect_solver_refs", false]], "collect_solver_refs() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.collect_solver_refs", false]], "collect_solver_refs() (water method)": [[111, "engforge.eng.fluid_material.Water.collect_solver_refs", false]], "collect_update_refs() (air method)": [[97, "engforge.eng.fluid_material.Air.collect_update_refs", false]], "collect_update_refs() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.collect_update_refs", false]], "collect_update_refs() (analysis method)": [[2, "engforge.analysis.Analysis.collect_update_refs", false]], "collect_update_refs() (beam method)": [[151, "engforge.eng.structure_beams.Beam.collect_update_refs", false]], "collect_update_refs() (component method)": [[48, "engforge.components.Component.collect_update_refs", false]], "collect_update_refs() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.collect_update_refs", false]], "collect_update_refs() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.collect_update_refs", false]], "collect_update_refs() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.collect_update_refs", false]], "collect_update_refs() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.collect_update_refs", false]], "collect_update_refs() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.collect_update_refs", false]], "collect_update_refs() (costmodel method)": [[91, "engforge.eng.costs.CostModel.collect_update_refs", false]], "collect_update_refs() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.collect_update_refs", false]], "collect_update_refs() (economics method)": [[92, "engforge.eng.costs.Economics.collect_update_refs", false]], "collect_update_refs() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.collect_update_refs", false]], "collect_update_refs() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.collect_update_refs", false]], "collect_update_refs() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.collect_update_refs", false]], "collect_update_refs() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.collect_update_refs", false]], "collect_update_refs() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.collect_update_refs", false]], "collect_update_refs() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.collect_update_refs", false]], "collect_update_refs() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.collect_update_refs", false]], "collect_update_refs() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.collect_update_refs", false]], "collect_update_refs() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.collect_update_refs", false]], "collect_update_refs() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.collect_update_refs", false]], "collect_update_refs() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.collect_update_refs", false]], "collect_update_refs() (pipe method)": [[127, "engforge.eng.pipes.Pipe.collect_update_refs", false]], "collect_update_refs() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.collect_update_refs", false]], "collect_update_refs() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.collect_update_refs", false]], "collect_update_refs() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.collect_update_refs", false]], "collect_update_refs() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.collect_update_refs", false]], "collect_update_refs() (pump method)": [[133, "engforge.eng.pipes.Pump.collect_update_refs", false]], "collect_update_refs() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.collect_update_refs", false]], "collect_update_refs() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.collect_update_refs", false]], "collect_update_refs() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.collect_update_refs", false]], "collect_update_refs() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.collect_update_refs", false]], "collect_update_refs() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.collect_update_refs", false]], "collect_update_refs() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.collect_update_refs", false]], "collect_update_refs() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.collect_update_refs", false]], "collect_update_refs() (solvermixin method)": [[222, "engforge.solver.SolverMixin.collect_update_refs", false]], "collect_update_refs() (steam method)": [[110, "engforge.eng.fluid_material.Steam.collect_update_refs", false]], "collect_update_refs() (system method)": [[240, "engforge.system.System.collect_update_refs", false]], "collect_update_refs() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.collect_update_refs", false]], "collect_update_refs() (water method)": [[111, "engforge.eng.fluid_material.Water.collect_update_refs", false]], "combo_filter() (in module engforge.solver_utils)": [[226, "engforge.solver_utils.combo_filter", false]], "comp_references() (air method)": [[97, "engforge.eng.fluid_material.Air.comp_references", false]], "comp_references() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.comp_references", false]], "comp_references() (analysis method)": [[2, "engforge.analysis.Analysis.comp_references", false]], "comp_references() (beam method)": [[151, "engforge.eng.structure_beams.Beam.comp_references", false]], "comp_references() (component method)": [[48, "engforge.components.Component.comp_references", false]], "comp_references() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.comp_references", false]], "comp_references() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.comp_references", false]], "comp_references() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.comp_references", false]], "comp_references() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.comp_references", false]], "comp_references() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.comp_references", false]], "comp_references() (costmodel method)": [[91, "engforge.eng.costs.CostModel.comp_references", false]], "comp_references() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.comp_references", false]], "comp_references() (economics method)": [[92, "engforge.eng.costs.Economics.comp_references", false]], "comp_references() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.comp_references", false]], "comp_references() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.comp_references", false]], "comp_references() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.comp_references", false]], "comp_references() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.comp_references", false]], "comp_references() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.comp_references", false]], "comp_references() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.comp_references", false]], "comp_references() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.comp_references", false]], "comp_references() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.comp_references", false]], "comp_references() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.comp_references", false]], "comp_references() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.comp_references", false]], "comp_references() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.comp_references", false]], "comp_references() (pipe method)": [[127, "engforge.eng.pipes.Pipe.comp_references", false]], "comp_references() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.comp_references", false]], "comp_references() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.comp_references", false]], "comp_references() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.comp_references", false]], "comp_references() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.comp_references", false]], "comp_references() (pump method)": [[133, "engforge.eng.pipes.Pump.comp_references", false]], "comp_references() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.comp_references", false]], "comp_references() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.comp_references", false]], "comp_references() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.comp_references", false]], "comp_references() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.comp_references", false]], "comp_references() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.comp_references", false]], "comp_references() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.comp_references", false]], "comp_references() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.comp_references", false]], "comp_references() (solvermixin method)": [[222, "engforge.solver.SolverMixin.comp_references", false]], "comp_references() (steam method)": [[110, "engforge.eng.fluid_material.Steam.comp_references", false]], "comp_references() (system method)": [[240, "engforge.system.System.comp_references", false]], "comp_references() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.comp_references", false]], "comp_references() (water method)": [[111, "engforge.eng.fluid_material.Water.comp_references", false]], "comp_transform() (in module engforge.configuration)": [[53, "engforge.configuration.comp_transform", false]], "compile() (solverinstance method)": [[30, "engforge.attr_solver.SolverInstance.compile", false]], "compile_classes() (air class method)": [[97, "engforge.eng.fluid_material.Air.compile_classes", false]], "compile_classes() (airwatermix class method)": [[98, "engforge.eng.fluid_material.AirWaterMix.compile_classes", false]], "compile_classes() (aluminum class method)": [[139, "engforge.eng.solid_materials.Aluminum.compile_classes", false]], "compile_classes() (analysis class method)": [[2, "engforge.analysis.Analysis.compile_classes", false]], "compile_classes() (ansi_4130 class method)": [[137, "engforge.eng.solid_materials.ANSI_4130.compile_classes", false]], "compile_classes() (ansi_4340 class method)": [[138, "engforge.eng.solid_materials.ANSI_4340.compile_classes", false]], "compile_classes() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.compile_classes", false]], "compile_classes() (carbonfiber class method)": [[140, "engforge.eng.solid_materials.CarbonFiber.compile_classes", false]], "compile_classes() (circle class method)": [[113, "engforge.eng.geometry.Circle.compile_classes", false]], "compile_classes() (component class method)": [[48, "engforge.components.Component.compile_classes", false]], "compile_classes() (componentdict class method)": [[42, "engforge.component_collections.ComponentDict.compile_classes", false]], "compile_classes() (componentiter class method)": [[43, "engforge.component_collections.ComponentIter.compile_classes", false]], "compile_classes() (componentiterator class method)": [[44, "engforge.component_collections.ComponentIterator.compile_classes", false]], "compile_classes() (concrete class method)": [[141, "engforge.eng.solid_materials.Concrete.compile_classes", false]], "compile_classes() (configuration class method)": [[52, "engforge.configuration.Configuration.compile_classes", false]], "compile_classes() (coolpropmaterial class method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.compile_classes", false]], "compile_classes() (coolpropmixture class method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.compile_classes", false]], "compile_classes() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.compile_classes", false]], "compile_classes() (drysoil class method)": [[142, "engforge.eng.solid_materials.DrySoil.compile_classes", false]], "compile_classes() (dynamicsmixin class method)": [[84, "engforge.dynamics.DynamicsMixin.compile_classes", false]], "compile_classes() (economics class method)": [[92, "engforge.eng.costs.Economics.compile_classes", false]], "compile_classes() (flowinput class method)": [[125, "engforge.eng.pipes.FlowInput.compile_classes", false]], "compile_classes() (flownode class method)": [[126, "engforge.eng.pipes.FlowNode.compile_classes", false]], "compile_classes() (fluidmaterial class method)": [[101, "engforge.eng.fluid_material.FluidMaterial.compile_classes", false]], "compile_classes() (globaldynamics class method)": [[85, "engforge.dynamics.GlobalDynamics.compile_classes", false]], "compile_classes() (hollowcircle class method)": [[115, "engforge.eng.geometry.HollowCircle.compile_classes", false]], "compile_classes() (hydrogen class method)": [[102, "engforge.eng.fluid_material.Hydrogen.compile_classes", false]], "compile_classes() (idealair class method)": [[103, "engforge.eng.fluid_material.IdealAir.compile_classes", false]], "compile_classes() (idealgas class method)": [[104, "engforge.eng.fluid_material.IdealGas.compile_classes", false]], "compile_classes() (idealh2 class method)": [[105, "engforge.eng.fluid_material.IdealH2.compile_classes", false]], "compile_classes() (idealoxygen class method)": [[106, "engforge.eng.fluid_material.IdealOxygen.compile_classes", false]], "compile_classes() (idealsteam class method)": [[107, "engforge.eng.fluid_material.IdealSteam.compile_classes", false]], "compile_classes() (oxygen class method)": [[108, "engforge.eng.fluid_material.Oxygen.compile_classes", false]], "compile_classes() (pipe class method)": [[127, "engforge.eng.pipes.Pipe.compile_classes", false]], "compile_classes() (pipefitting class method)": [[128, "engforge.eng.pipes.PipeFitting.compile_classes", false]], "compile_classes() (pipeflow class method)": [[129, "engforge.eng.pipes.PipeFlow.compile_classes", false]], "compile_classes() (pipenode class method)": [[131, "engforge.eng.pipes.PipeNode.compile_classes", false]], "compile_classes() (pipesystem class method)": [[132, "engforge.eng.pipes.PipeSystem.compile_classes", false]], "compile_classes() (profile2d class method)": [[117, "engforge.eng.geometry.Profile2D.compile_classes", false]], "compile_classes() (pump class method)": [[133, "engforge.eng.pipes.Pump.compile_classes", false]], "compile_classes() (rectangle class method)": [[118, "engforge.eng.geometry.Rectangle.compile_classes", false]], "compile_classes() (rock class method)": [[143, "engforge.eng.solid_materials.Rock.compile_classes", false]], "compile_classes() (rubber class method)": [[144, "engforge.eng.solid_materials.Rubber.compile_classes", false]], "compile_classes() (seawater class method)": [[109, "engforge.eng.fluid_material.SeaWater.compile_classes", false]], "compile_classes() (shapelysection class method)": [[119, "engforge.eng.geometry.ShapelySection.compile_classes", false]], "compile_classes() (simplecompressor class method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.compile_classes", false]], "compile_classes() (simpleheatexchanger class method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.compile_classes", false]], "compile_classes() (simplepump class method)": [[156, "engforge.eng.thermodynamics.SimplePump.compile_classes", false]], "compile_classes() (simpleturbine class method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.compile_classes", false]], "compile_classes() (solidmaterial class method)": [[146, "engforge.eng.solid_materials.SolidMaterial.compile_classes", false]], "compile_classes() (solveableinterface class method)": [[49, "engforge.components.SolveableInterface.compile_classes", false]], "compile_classes() (ss_316 class method)": [[145, "engforge.eng.solid_materials.SS_316.compile_classes", false]], "compile_classes() (steam class method)": [[110, "engforge.eng.fluid_material.Steam.compile_classes", false]], "compile_classes() (system class method)": [[240, "engforge.system.System.compile_classes", false]], "compile_classes() (triangle class method)": [[120, "engforge.eng.geometry.Triangle.compile_classes", false]], "compile_classes() (water class method)": [[111, "engforge.eng.fluid_material.Water.compile_classes", false]], "compile_classes() (wetsoil class method)": [[147, "engforge.eng.solid_materials.WetSoil.compile_classes", false]], "component (class in engforge.components)": [[48, "engforge.components.Component", false]], "componentdict (class in engforge.component_collections)": [[42, "engforge.component_collections.ComponentDict", false]], "componentiter (class in engforge.component_collections)": [[43, "engforge.component_collections.ComponentIter", false]], "componentiterator (class in engforge.component_collections)": [[44, "engforge.component_collections.ComponentIterator", false]], "con_eq() (solver class method)": [[29, "engforge.attr_solver.Solver.con_eq", false]], "con_ineq() (solver class method)": [[29, "engforge.attr_solver.Solver.con_ineq", false]], "concrete (class in engforge.eng.solid_materials)": [[141, "engforge.eng.solid_materials.Concrete", false]], "configlog (class in engforge.configuration)": [[51, "engforge.configuration.ConfigLog", false]], "configuration (class in engforge.configuration)": [[52, "engforge.configuration.Configuration", false]], "configure() (dbconnection method)": [[72, "engforge.datastores.data.DBConnection.configure", false]], "configure_for_system() (attr_base class method)": [[33, "engforge.attributes.ATTR_BASE.configure_for_system", false]], "configure_for_system() (plot class method)": [[9, "engforge.attr_plotting.Plot.configure_for_system", false]], "configure_for_system() (plotbase class method)": [[10, "engforge.attr_plotting.PlotBase.configure_for_system", false]], "configure_for_system() (signal class method)": [[22, "engforge.attr_signals.Signal.configure_for_system", false]], "configure_for_system() (slot class method)": [[25, "engforge.attr_slots.Slot.configure_for_system", false]], "configure_for_system() (solver class method)": [[29, "engforge.attr_solver.Solver.configure_for_system", false]], "configure_for_system() (time class method)": [[7, "engforge.attr_dynamics.Time.configure_for_system", false]], "configure_for_system() (trace class method)": [[14, "engforge.attr_plotting.Trace.configure_for_system", false]], "configure_instance() (attr_base class method)": [[33, "engforge.attributes.ATTR_BASE.configure_instance", false]], "configure_instance() (plot class method)": [[9, "engforge.attr_plotting.Plot.configure_instance", false]], "configure_instance() (plotbase class method)": [[10, "engforge.attr_plotting.PlotBase.configure_instance", false]], "configure_instance() (signal class method)": [[22, "engforge.attr_signals.Signal.configure_instance", false]], "configure_instance() (slot class method)": [[25, "engforge.attr_slots.Slot.configure_instance", false]], "configure_instance() (solver class method)": [[29, "engforge.attr_solver.Solver.configure_instance", false]], "configure_instance() (time class method)": [[7, "engforge.attr_dynamics.Time.configure_instance", false]], "configure_instance() (trace class method)": [[14, "engforge.attr_plotting.Trace.configure_instance", false]], "constraint_equality() (solver class method)": [[29, "engforge.attr_solver.Solver.constraint_equality", false]], "constraint_exists() (solver class method)": [[29, "engforge.attr_solver.Solver.constraint_exists", false]], "constraint_exists() (time class method)": [[7, "engforge.attr_dynamics.Time.constraint_exists", false]], "constraint_inequality() (solver class method)": [[29, "engforge.attr_solver.Solver.constraint_inequality", false]], "conv_ctx() (in module engforge.attr_plotting)": [[16, "engforge.attr_plotting.conv_ctx", false]], "conv_maps() (in module engforge.attr_plotting)": [[17, "engforge.attr_plotting.conv_maps", false]], "conv_nms() (in module engforge.configuration)": [[54, "engforge.configuration.conv_nms", false]], "conv_theme() (in module engforge.attr_plotting)": [[18, "engforge.attr_plotting.conv_theme", false]], "conver_np() (in module engforge.eng.geometry)": [[122, "engforge.eng.geometry.conver_np", false]], "coolpropmaterial (class in engforge.eng.fluid_material)": [[99, "engforge.eng.fluid_material.CoolPropMaterial", false]], "coolpropmixture (class in engforge.eng.fluid_material)": [[100, "engforge.eng.fluid_material.CoolPropMixture", false]], "copy() (ref method)": [[243, "engforge.system_reference.Ref.copy", false]], "copy_config_at_state() (air method)": [[97, "engforge.eng.fluid_material.Air.copy_config_at_state", false]], "copy_config_at_state() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.copy_config_at_state", false]], "copy_config_at_state() (aluminum method)": [[139, "engforge.eng.solid_materials.Aluminum.copy_config_at_state", false]], "copy_config_at_state() (analysis method)": [[2, "engforge.analysis.Analysis.copy_config_at_state", false]], "copy_config_at_state() (ansi_4130 method)": [[137, "engforge.eng.solid_materials.ANSI_4130.copy_config_at_state", false]], "copy_config_at_state() (ansi_4340 method)": [[138, "engforge.eng.solid_materials.ANSI_4340.copy_config_at_state", false]], "copy_config_at_state() (beam method)": [[151, "engforge.eng.structure_beams.Beam.copy_config_at_state", false]], "copy_config_at_state() (carbonfiber method)": [[140, "engforge.eng.solid_materials.CarbonFiber.copy_config_at_state", false]], "copy_config_at_state() (circle method)": [[113, "engforge.eng.geometry.Circle.copy_config_at_state", false]], "copy_config_at_state() (component method)": [[48, "engforge.components.Component.copy_config_at_state", false]], "copy_config_at_state() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.copy_config_at_state", false]], "copy_config_at_state() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.copy_config_at_state", false]], "copy_config_at_state() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.copy_config_at_state", false]], "copy_config_at_state() (concrete method)": [[141, "engforge.eng.solid_materials.Concrete.copy_config_at_state", false]], "copy_config_at_state() (configuration method)": [[52, "engforge.configuration.Configuration.copy_config_at_state", false]], "copy_config_at_state() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.copy_config_at_state", false]], "copy_config_at_state() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.copy_config_at_state", false]], "copy_config_at_state() (costmodel method)": [[91, "engforge.eng.costs.CostModel.copy_config_at_state", false]], "copy_config_at_state() (drysoil method)": [[142, "engforge.eng.solid_materials.DrySoil.copy_config_at_state", false]], "copy_config_at_state() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.copy_config_at_state", false]], "copy_config_at_state() (economics method)": [[92, "engforge.eng.costs.Economics.copy_config_at_state", false]], "copy_config_at_state() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.copy_config_at_state", false]], "copy_config_at_state() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.copy_config_at_state", false]], "copy_config_at_state() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.copy_config_at_state", false]], "copy_config_at_state() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.copy_config_at_state", false]], "copy_config_at_state() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.copy_config_at_state", false]], "copy_config_at_state() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.copy_config_at_state", false]], "copy_config_at_state() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.copy_config_at_state", false]], "copy_config_at_state() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.copy_config_at_state", false]], "copy_config_at_state() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.copy_config_at_state", false]], "copy_config_at_state() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.copy_config_at_state", false]], "copy_config_at_state() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.copy_config_at_state", false]], "copy_config_at_state() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.copy_config_at_state", false]], "copy_config_at_state() (pipe method)": [[127, "engforge.eng.pipes.Pipe.copy_config_at_state", false]], "copy_config_at_state() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.copy_config_at_state", false]], "copy_config_at_state() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.copy_config_at_state", false]], "copy_config_at_state() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.copy_config_at_state", false]], "copy_config_at_state() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.copy_config_at_state", false]], "copy_config_at_state() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.copy_config_at_state", false]], "copy_config_at_state() (pump method)": [[133, "engforge.eng.pipes.Pump.copy_config_at_state", false]], "copy_config_at_state() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.copy_config_at_state", false]], "copy_config_at_state() (rock method)": [[143, "engforge.eng.solid_materials.Rock.copy_config_at_state", false]], "copy_config_at_state() (rubber method)": [[144, "engforge.eng.solid_materials.Rubber.copy_config_at_state", false]], "copy_config_at_state() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.copy_config_at_state", false]], "copy_config_at_state() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.copy_config_at_state", false]], "copy_config_at_state() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.copy_config_at_state", false]], "copy_config_at_state() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.copy_config_at_state", false]], "copy_config_at_state() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.copy_config_at_state", false]], "copy_config_at_state() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.copy_config_at_state", false]], "copy_config_at_state() (solidmaterial method)": [[146, "engforge.eng.solid_materials.SolidMaterial.copy_config_at_state", false]], "copy_config_at_state() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.copy_config_at_state", false]], "copy_config_at_state() (ss_316 method)": [[145, "engforge.eng.solid_materials.SS_316.copy_config_at_state", false]], "copy_config_at_state() (steam method)": [[110, "engforge.eng.fluid_material.Steam.copy_config_at_state", false]], "copy_config_at_state() (system method)": [[240, "engforge.system.System.copy_config_at_state", false]], "copy_config_at_state() (triangle method)": [[120, "engforge.eng.geometry.Triangle.copy_config_at_state", false]], "copy_config_at_state() (water method)": [[111, "engforge.eng.fluid_material.Water.copy_config_at_state", false]], "copy_config_at_state() (wetsoil method)": [[147, "engforge.eng.solid_materials.WetSoil.copy_config_at_state", false]], "cost_categories (beam property)": [[151, "engforge.eng.structure_beams.Beam.cost_categories", false]], "cost_categories (costmodel property)": [[91, "engforge.eng.costs.CostModel.cost_categories", false]], "cost_properties (beam property)": [[151, "engforge.eng.structure_beams.Beam.cost_properties", false]], "cost_properties (costmodel property)": [[91, "engforge.eng.costs.CostModel.cost_properties", false]], "cost_property (class in engforge.eng.costs)": [[93, "engforge.eng.costs.cost_property", false]], "costlog (class in engforge.eng.costs)": [[90, "engforge.eng.costs.CostLog", false]], "costmodel (class in engforge.eng.costs)": [[91, "engforge.eng.costs.CostModel", false]], "costs_at_term() (beam method)": [[151, "engforge.eng.structure_beams.Beam.costs_at_term", false]], "costs_at_term() (costmodel method)": [[91, "engforge.eng.costs.CostModel.costs_at_term", false]], "count() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.count", false]], "create_constraint() (in module engforge.solver_utils)": [[227, "engforge.solver_utils.create_constraint", false]], "create_dynamic_matricies() (air method)": [[97, "engforge.eng.fluid_material.Air.create_dynamic_matricies", false]], "create_dynamic_matricies() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.create_dynamic_matricies", false]], "create_dynamic_matricies() (beam method)": [[151, "engforge.eng.structure_beams.Beam.create_dynamic_matricies", false]], "create_dynamic_matricies() (component method)": [[48, "engforge.components.Component.create_dynamic_matricies", false]], "create_dynamic_matricies() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.create_dynamic_matricies", false]], "create_dynamic_matricies() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.create_dynamic_matricies", false]], "create_dynamic_matricies() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.create_dynamic_matricies", false]], "create_dynamic_matricies() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.create_dynamic_matricies", false]], "create_dynamic_matricies() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.create_dynamic_matricies", false]], "create_dynamic_matricies() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.create_dynamic_matricies", false]], "create_dynamic_matricies() (economics method)": [[92, "engforge.eng.costs.Economics.create_dynamic_matricies", false]], "create_dynamic_matricies() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.create_dynamic_matricies", false]], "create_dynamic_matricies() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.create_dynamic_matricies", false]], "create_dynamic_matricies() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.create_dynamic_matricies", false]], "create_dynamic_matricies() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.create_dynamic_matricies", false]], "create_dynamic_matricies() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.create_dynamic_matricies", false]], "create_dynamic_matricies() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.create_dynamic_matricies", false]], "create_dynamic_matricies() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.create_dynamic_matricies", false]], "create_dynamic_matricies() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.create_dynamic_matricies", false]], "create_dynamic_matricies() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.create_dynamic_matricies", false]], "create_dynamic_matricies() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.create_dynamic_matricies", false]], "create_dynamic_matricies() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.create_dynamic_matricies", false]], "create_dynamic_matricies() (pipe method)": [[127, "engforge.eng.pipes.Pipe.create_dynamic_matricies", false]], "create_dynamic_matricies() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.create_dynamic_matricies", false]], "create_dynamic_matricies() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.create_dynamic_matricies", false]], "create_dynamic_matricies() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.create_dynamic_matricies", false]], "create_dynamic_matricies() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.create_dynamic_matricies", false]], "create_dynamic_matricies() (pump method)": [[133, "engforge.eng.pipes.Pump.create_dynamic_matricies", false]], "create_dynamic_matricies() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.create_dynamic_matricies", false]], "create_dynamic_matricies() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.create_dynamic_matricies", false]], "create_dynamic_matricies() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.create_dynamic_matricies", false]], "create_dynamic_matricies() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.create_dynamic_matricies", false]], "create_dynamic_matricies() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.create_dynamic_matricies", false]], "create_dynamic_matricies() (steam method)": [[110, "engforge.eng.fluid_material.Steam.create_dynamic_matricies", false]], "create_dynamic_matricies() (system method)": [[240, "engforge.system.System.create_dynamic_matricies", false]], "create_dynamic_matricies() (water method)": [[111, "engforge.eng.fluid_material.Water.create_dynamic_matricies", false]], "create_feedthrough_matrix() (air method)": [[97, "engforge.eng.fluid_material.Air.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (beam method)": [[151, "engforge.eng.structure_beams.Beam.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (component method)": [[48, "engforge.components.Component.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (economics method)": [[92, "engforge.eng.costs.Economics.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (pipe method)": [[127, "engforge.eng.pipes.Pipe.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (pump method)": [[133, "engforge.eng.pipes.Pump.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (steam method)": [[110, "engforge.eng.fluid_material.Steam.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (system method)": [[240, "engforge.system.System.create_feedthrough_matrix", false]], "create_feedthrough_matrix() (water method)": [[111, "engforge.eng.fluid_material.Water.create_feedthrough_matrix", false]], "create_graph_from_pipe_or_node() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.create_graph_from_pipe_or_node", false]], "create_input_matrix() (air method)": [[97, "engforge.eng.fluid_material.Air.create_input_matrix", false]], "create_input_matrix() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.create_input_matrix", false]], "create_input_matrix() (beam method)": [[151, "engforge.eng.structure_beams.Beam.create_input_matrix", false]], "create_input_matrix() (component method)": [[48, "engforge.components.Component.create_input_matrix", false]], "create_input_matrix() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.create_input_matrix", false]], "create_input_matrix() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.create_input_matrix", false]], "create_input_matrix() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.create_input_matrix", false]], "create_input_matrix() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.create_input_matrix", false]], "create_input_matrix() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.create_input_matrix", false]], "create_input_matrix() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.create_input_matrix", false]], "create_input_matrix() (economics method)": [[92, "engforge.eng.costs.Economics.create_input_matrix", false]], "create_input_matrix() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.create_input_matrix", false]], "create_input_matrix() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.create_input_matrix", false]], "create_input_matrix() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.create_input_matrix", false]], "create_input_matrix() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.create_input_matrix", false]], "create_input_matrix() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.create_input_matrix", false]], "create_input_matrix() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.create_input_matrix", false]], "create_input_matrix() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.create_input_matrix", false]], "create_input_matrix() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.create_input_matrix", false]], "create_input_matrix() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.create_input_matrix", false]], "create_input_matrix() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.create_input_matrix", false]], "create_input_matrix() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.create_input_matrix", false]], "create_input_matrix() (pipe method)": [[127, "engforge.eng.pipes.Pipe.create_input_matrix", false]], "create_input_matrix() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.create_input_matrix", false]], "create_input_matrix() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.create_input_matrix", false]], "create_input_matrix() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.create_input_matrix", false]], "create_input_matrix() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.create_input_matrix", false]], "create_input_matrix() (pump method)": [[133, "engforge.eng.pipes.Pump.create_input_matrix", false]], "create_input_matrix() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.create_input_matrix", false]], "create_input_matrix() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.create_input_matrix", false]], "create_input_matrix() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.create_input_matrix", false]], "create_input_matrix() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.create_input_matrix", false]], "create_input_matrix() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.create_input_matrix", false]], "create_input_matrix() (steam method)": [[110, "engforge.eng.fluid_material.Steam.create_input_matrix", false]], "create_input_matrix() (system method)": [[240, "engforge.system.System.create_input_matrix", false]], "create_input_matrix() (water method)": [[111, "engforge.eng.fluid_material.Water.create_input_matrix", false]], "create_instance() (attr_base class method)": [[33, "engforge.attributes.ATTR_BASE.create_instance", false]], "create_instance() (plot class method)": [[9, "engforge.attr_plotting.Plot.create_instance", false]], "create_instance() (plotbase class method)": [[10, "engforge.attr_plotting.PlotBase.create_instance", false]], "create_instance() (signal class method)": [[22, "engforge.attr_signals.Signal.create_instance", false]], "create_instance() (slot class method)": [[25, "engforge.attr_slots.Slot.create_instance", false]], "create_instance() (solver class method)": [[29, "engforge.attr_solver.Solver.create_instance", false]], "create_instance() (time class method)": [[7, "engforge.attr_dynamics.Time.create_instance", false]], "create_instance() (trace class method)": [[14, "engforge.attr_plotting.Trace.create_instance", false]], "create_output_constants() (air method)": [[97, "engforge.eng.fluid_material.Air.create_output_constants", false]], "create_output_constants() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.create_output_constants", false]], "create_output_constants() (beam method)": [[151, "engforge.eng.structure_beams.Beam.create_output_constants", false]], "create_output_constants() (component method)": [[48, "engforge.components.Component.create_output_constants", false]], "create_output_constants() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.create_output_constants", false]], "create_output_constants() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.create_output_constants", false]], "create_output_constants() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.create_output_constants", false]], "create_output_constants() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.create_output_constants", false]], "create_output_constants() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.create_output_constants", false]], "create_output_constants() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.create_output_constants", false]], "create_output_constants() (economics method)": [[92, "engforge.eng.costs.Economics.create_output_constants", false]], "create_output_constants() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.create_output_constants", false]], "create_output_constants() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.create_output_constants", false]], "create_output_constants() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.create_output_constants", false]], "create_output_constants() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.create_output_constants", false]], "create_output_constants() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.create_output_constants", false]], "create_output_constants() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.create_output_constants", false]], "create_output_constants() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.create_output_constants", false]], "create_output_constants() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.create_output_constants", false]], "create_output_constants() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.create_output_constants", false]], "create_output_constants() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.create_output_constants", false]], "create_output_constants() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.create_output_constants", false]], "create_output_constants() (pipe method)": [[127, "engforge.eng.pipes.Pipe.create_output_constants", false]], "create_output_constants() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.create_output_constants", false]], "create_output_constants() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.create_output_constants", false]], "create_output_constants() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.create_output_constants", false]], "create_output_constants() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.create_output_constants", false]], "create_output_constants() (pump method)": [[133, "engforge.eng.pipes.Pump.create_output_constants", false]], "create_output_constants() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.create_output_constants", false]], "create_output_constants() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.create_output_constants", false]], "create_output_constants() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.create_output_constants", false]], "create_output_constants() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.create_output_constants", false]], "create_output_constants() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.create_output_constants", false]], "create_output_constants() (steam method)": [[110, "engforge.eng.fluid_material.Steam.create_output_constants", false]], "create_output_constants() (system method)": [[240, "engforge.system.System.create_output_constants", false]], "create_output_constants() (water method)": [[111, "engforge.eng.fluid_material.Water.create_output_constants", false]], "create_output_matrix() (air method)": [[97, "engforge.eng.fluid_material.Air.create_output_matrix", false]], "create_output_matrix() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.create_output_matrix", false]], "create_output_matrix() (beam method)": [[151, "engforge.eng.structure_beams.Beam.create_output_matrix", false]], "create_output_matrix() (component method)": [[48, "engforge.components.Component.create_output_matrix", false]], "create_output_matrix() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.create_output_matrix", false]], "create_output_matrix() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.create_output_matrix", false]], "create_output_matrix() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.create_output_matrix", false]], "create_output_matrix() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.create_output_matrix", false]], "create_output_matrix() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.create_output_matrix", false]], "create_output_matrix() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.create_output_matrix", false]], "create_output_matrix() (economics method)": [[92, "engforge.eng.costs.Economics.create_output_matrix", false]], "create_output_matrix() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.create_output_matrix", false]], "create_output_matrix() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.create_output_matrix", false]], "create_output_matrix() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.create_output_matrix", false]], "create_output_matrix() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.create_output_matrix", false]], "create_output_matrix() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.create_output_matrix", false]], "create_output_matrix() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.create_output_matrix", false]], "create_output_matrix() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.create_output_matrix", false]], "create_output_matrix() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.create_output_matrix", false]], "create_output_matrix() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.create_output_matrix", false]], "create_output_matrix() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.create_output_matrix", false]], "create_output_matrix() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.create_output_matrix", false]], "create_output_matrix() (pipe method)": [[127, "engforge.eng.pipes.Pipe.create_output_matrix", false]], "create_output_matrix() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.create_output_matrix", false]], "create_output_matrix() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.create_output_matrix", false]], "create_output_matrix() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.create_output_matrix", false]], "create_output_matrix() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.create_output_matrix", false]], "create_output_matrix() (pump method)": [[133, "engforge.eng.pipes.Pump.create_output_matrix", false]], "create_output_matrix() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.create_output_matrix", false]], "create_output_matrix() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.create_output_matrix", false]], "create_output_matrix() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.create_output_matrix", false]], "create_output_matrix() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.create_output_matrix", false]], "create_output_matrix() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.create_output_matrix", false]], "create_output_matrix() (steam method)": [[110, "engforge.eng.fluid_material.Steam.create_output_matrix", false]], "create_output_matrix() (system method)": [[240, "engforge.system.System.create_output_matrix", false]], "create_output_matrix() (water method)": [[111, "engforge.eng.fluid_material.Water.create_output_matrix", false]], "create_state_constants() (air method)": [[97, "engforge.eng.fluid_material.Air.create_state_constants", false]], "create_state_constants() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.create_state_constants", false]], "create_state_constants() (beam method)": [[151, "engforge.eng.structure_beams.Beam.create_state_constants", false]], "create_state_constants() (component method)": [[48, "engforge.components.Component.create_state_constants", false]], "create_state_constants() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.create_state_constants", false]], "create_state_constants() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.create_state_constants", false]], "create_state_constants() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.create_state_constants", false]], "create_state_constants() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.create_state_constants", false]], "create_state_constants() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.create_state_constants", false]], "create_state_constants() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.create_state_constants", false]], "create_state_constants() (economics method)": [[92, "engforge.eng.costs.Economics.create_state_constants", false]], "create_state_constants() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.create_state_constants", false]], "create_state_constants() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.create_state_constants", false]], "create_state_constants() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.create_state_constants", false]], "create_state_constants() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.create_state_constants", false]], "create_state_constants() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.create_state_constants", false]], "create_state_constants() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.create_state_constants", false]], "create_state_constants() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.create_state_constants", false]], "create_state_constants() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.create_state_constants", false]], "create_state_constants() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.create_state_constants", false]], "create_state_constants() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.create_state_constants", false]], "create_state_constants() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.create_state_constants", false]], "create_state_constants() (pipe method)": [[127, "engforge.eng.pipes.Pipe.create_state_constants", false]], "create_state_constants() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.create_state_constants", false]], "create_state_constants() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.create_state_constants", false]], "create_state_constants() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.create_state_constants", false]], "create_state_constants() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.create_state_constants", false]], "create_state_constants() (pump method)": [[133, "engforge.eng.pipes.Pump.create_state_constants", false]], "create_state_constants() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.create_state_constants", false]], "create_state_constants() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.create_state_constants", false]], "create_state_constants() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.create_state_constants", false]], "create_state_constants() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.create_state_constants", false]], "create_state_constants() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.create_state_constants", false]], "create_state_constants() (steam method)": [[110, "engforge.eng.fluid_material.Steam.create_state_constants", false]], "create_state_constants() (system method)": [[240, "engforge.system.System.create_state_constants", false]], "create_state_constants() (water method)": [[111, "engforge.eng.fluid_material.Water.create_state_constants", false]], "create_state_matrix() (air method)": [[97, "engforge.eng.fluid_material.Air.create_state_matrix", false]], "create_state_matrix() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.create_state_matrix", false]], "create_state_matrix() (beam method)": [[151, "engforge.eng.structure_beams.Beam.create_state_matrix", false]], "create_state_matrix() (component method)": [[48, "engforge.components.Component.create_state_matrix", false]], "create_state_matrix() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.create_state_matrix", false]], "create_state_matrix() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.create_state_matrix", false]], "create_state_matrix() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.create_state_matrix", false]], "create_state_matrix() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.create_state_matrix", false]], "create_state_matrix() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.create_state_matrix", false]], "create_state_matrix() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.create_state_matrix", false]], "create_state_matrix() (economics method)": [[92, "engforge.eng.costs.Economics.create_state_matrix", false]], "create_state_matrix() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.create_state_matrix", false]], "create_state_matrix() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.create_state_matrix", false]], "create_state_matrix() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.create_state_matrix", false]], "create_state_matrix() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.create_state_matrix", false]], "create_state_matrix() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.create_state_matrix", false]], "create_state_matrix() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.create_state_matrix", false]], "create_state_matrix() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.create_state_matrix", false]], "create_state_matrix() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.create_state_matrix", false]], "create_state_matrix() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.create_state_matrix", false]], "create_state_matrix() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.create_state_matrix", false]], "create_state_matrix() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.create_state_matrix", false]], "create_state_matrix() (pipe method)": [[127, "engforge.eng.pipes.Pipe.create_state_matrix", false]], "create_state_matrix() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.create_state_matrix", false]], "create_state_matrix() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.create_state_matrix", false]], "create_state_matrix() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.create_state_matrix", false]], "create_state_matrix() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.create_state_matrix", false]], "create_state_matrix() (pump method)": [[133, "engforge.eng.pipes.Pump.create_state_matrix", false]], "create_state_matrix() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.create_state_matrix", false]], "create_state_matrix() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.create_state_matrix", false]], "create_state_matrix() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.create_state_matrix", false]], "create_state_matrix() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.create_state_matrix", false]], "create_state_matrix() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.create_state_matrix", false]], "create_state_matrix() (steam method)": [[110, "engforge.eng.fluid_material.Steam.create_state_matrix", false]], "create_state_matrix() (system method)": [[240, "engforge.system.System.create_state_matrix", false]], "create_state_matrix() (water method)": [[111, "engforge.eng.fluid_material.Water.create_state_matrix", false]], "critical() (air method)": [[97, "engforge.eng.fluid_material.Air.critical", false]], "critical() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.critical", false]], "critical() (aluminum method)": [[139, "engforge.eng.solid_materials.Aluminum.critical", false]], "critical() (analysis method)": [[2, "engforge.analysis.Analysis.critical", false]], "critical() (ansi_4130 method)": [[137, "engforge.eng.solid_materials.ANSI_4130.critical", false]], "critical() (ansi_4340 method)": [[138, "engforge.eng.solid_materials.ANSI_4340.critical", false]], "critical() (attributedbasemixin method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.critical", false]], "critical() (attrlog method)": [[32, "engforge.attributes.ATTRLog.critical", false]], "critical() (attrsolverlog method)": [[28, "engforge.attr_solver.AttrSolverLog.critical", false]], "critical() (beam method)": [[151, "engforge.eng.structure_beams.Beam.critical", false]], "critical() (carbonfiber method)": [[140, "engforge.eng.solid_materials.CarbonFiber.critical", false]], "critical() (circle method)": [[113, "engforge.eng.geometry.Circle.critical", false]], "critical() (component method)": [[48, "engforge.components.Component.critical", false]], "critical() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.critical", false]], "critical() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.critical", false]], "critical() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.critical", false]], "critical() (concrete method)": [[141, "engforge.eng.solid_materials.Concrete.critical", false]], "critical() (configlog method)": [[51, "engforge.configuration.ConfigLog.critical", false]], "critical() (configuration method)": [[52, "engforge.configuration.Configuration.critical", false]], "critical() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.critical", false]], "critical() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.critical", false]], "critical() (costlog method)": [[90, "engforge.eng.costs.CostLog.critical", false]], "critical() (costmodel method)": [[91, "engforge.eng.costs.CostModel.critical", false]], "critical() (csvreporter method)": [[206, "engforge.reporting.CSVReporter.critical", false]], "critical() (dataframelog method)": [[61, "engforge.dataframe.DataFrameLog.critical", false]], "critical() (dbconnection method)": [[72, "engforge.datastores.data.DBConnection.critical", false]], "critical() (diskcachestore method)": [[73, "engforge.datastores.data.DiskCacheStore.critical", false]], "critical() (diskplotreporter method)": [[207, "engforge.reporting.DiskPlotReporter.critical", false]], "critical() (diskreportermixin method)": [[208, "engforge.reporting.DiskReporterMixin.critical", false]], "critical() (drysoil method)": [[142, "engforge.eng.solid_materials.DrySoil.critical", false]], "critical() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.critical", false]], "critical() (economics method)": [[92, "engforge.eng.costs.Economics.critical", false]], "critical() (engattr method)": [[165, "engforge.engforge_attributes.EngAttr.critical", false]], "critical() (envvariable method)": [[168, "engforge.env_var.EnvVariable.critical", false]], "critical() (excelreporter method)": [[209, "engforge.reporting.ExcelReporter.critical", false]], "critical() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.critical", false]], "critical() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.critical", false]], "critical() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.critical", false]], "critical() (forgelog method)": [[36, "engforge.common.ForgeLog.critical", false]], "critical() (gdrivereporter method)": [[210, "engforge.reporting.GdriveReporter.critical", false]], "critical() (geometrylog method)": [[114, "engforge.eng.geometry.GeometryLog.critical", false]], "critical() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.critical", false]], "critical() (gsheetsreporter method)": [[211, "engforge.reporting.GsheetsReporter.critical", false]], "critical() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.critical", false]], "critical() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.critical", false]], "critical() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.critical", false]], "critical() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.critical", false]], "critical() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.critical", false]], "critical() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.critical", false]], "critical() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.critical", false]], "critical() (log method)": [[173, "engforge.logging.Log.critical", false]], "critical() (loggingmixin method)": [[174, "engforge.logging.LoggingMixin.critical", false]], "critical() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.critical", false]], "critical() (pipe method)": [[127, "engforge.eng.pipes.Pipe.critical", false]], "critical() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.critical", false]], "critical() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.critical", false]], "critical() (pipelog method)": [[130, "engforge.eng.pipes.PipeLog.critical", false]], "critical() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.critical", false]], "critical() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.critical", false]], "critical() (plotlog method)": [[12, "engforge.attr_plotting.PlotLog.critical", false]], "critical() (plotreporter method)": [[212, "engforge.reporting.PlotReporter.critical", false]], "critical() (problog method)": [[187, "engforge.problem_context.ProbLog.critical", false]], "critical() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.critical", false]], "critical() (propertylog method)": [[193, "engforge.properties.PropertyLog.critical", false]], "critical() (pump method)": [[133, "engforge.eng.pipes.Pump.critical", false]], "critical() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.critical", false]], "critical() (reflog method)": [[244, "engforge.system_reference.RefLog.critical", false]], "critical() (reporter method)": [[213, "engforge.reporting.Reporter.critical", false]], "critical() (rock method)": [[143, "engforge.eng.solid_materials.Rock.critical", false]], "critical() (rubber method)": [[144, "engforge.eng.solid_materials.Rubber.critical", false]], "critical() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.critical", false]], "critical() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.critical", false]], "critical() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.critical", false]], "critical() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.critical", false]], "critical() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.critical", false]], "critical() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.critical", false]], "critical() (slotlog method)": [[26, "engforge.attr_slots.SlotLog.critical", false]], "critical() (solidmaterial method)": [[146, "engforge.eng.solid_materials.SolidMaterial.critical", false]], "critical() (solvablelog method)": [[218, "engforge.solveable.SolvableLog.critical", false]], "critical() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.critical", false]], "critical() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.critical", false]], "critical() (solverlog method)": [[221, "engforge.solver.SolverLog.critical", false]], "critical() (solvermixin method)": [[222, "engforge.solver.SolverMixin.critical", false]], "critical() (solverutillog method)": [[224, "engforge.solver_utils.SolverUtilLog.critical", false]], "critical() (ss_316 method)": [[145, "engforge.eng.solid_materials.SS_316.critical", false]], "critical() (steam method)": [[110, "engforge.eng.fluid_material.Steam.critical", false]], "critical() (system method)": [[240, "engforge.system.System.critical", false]], "critical() (systemslog method)": [[241, "engforge.system.SystemsLog.critical", false]], "critical() (tablelog method)": [[252, "engforge.tabulation.TableLog.critical", false]], "critical() (tablereporter method)": [[214, "engforge.reporting.TableReporter.critical", false]], "critical() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.critical", false]], "critical() (temporalreportermixin method)": [[215, "engforge.reporting.TemporalReporterMixin.critical", false]], "critical() (triangle method)": [[120, "engforge.eng.geometry.Triangle.critical", false]], "critical() (water method)": [[111, "engforge.eng.fluid_material.Water.critical", false]], "critical() (wetsoil method)": [[147, "engforge.eng.solid_materials.WetSoil.critical", false]], "csvreporter (class in engforge.reporting)": [[206, "engforge.reporting.CSVReporter", false]], "current (componentdict property)": [[42, "engforge.component_collections.ComponentDict.current", false]], "current (componentiter property)": [[43, "engforge.component_collections.ComponentIter.current", false]], "current (componentiterator property)": [[44, "engforge.component_collections.ComponentIterator.current", false]], "custom_cost() (beam method)": [[151, "engforge.eng.structure_beams.Beam.custom_cost", false]], "custom_cost() (costmodel method)": [[91, "engforge.eng.costs.CostModel.custom_cost", false]], "data_dict (air property)": [[97, "engforge.eng.fluid_material.Air.data_dict", false]], "data_dict (airwatermix property)": [[98, "engforge.eng.fluid_material.AirWaterMix.data_dict", false]], "data_dict (analysis property)": [[2, "engforge.analysis.Analysis.data_dict", false]], "data_dict (beam property)": [[151, "engforge.eng.structure_beams.Beam.data_dict", false]], "data_dict (component property)": [[48, "engforge.components.Component.data_dict", false]], "data_dict (componentdict property)": [[42, "engforge.component_collections.ComponentDict.data_dict", false]], "data_dict (componentiter property)": [[43, "engforge.component_collections.ComponentIter.data_dict", false]], "data_dict (componentiterator property)": [[44, "engforge.component_collections.ComponentIterator.data_dict", false]], "data_dict (coolpropmaterial property)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.data_dict", false]], "data_dict (coolpropmixture property)": [[100, "engforge.eng.fluid_material.CoolPropMixture.data_dict", false]], "data_dict (costmodel property)": [[91, "engforge.eng.costs.CostModel.data_dict", false]], "data_dict (economics property)": [[92, "engforge.eng.costs.Economics.data_dict", false]], "data_dict (flowinput property)": [[125, "engforge.eng.pipes.FlowInput.data_dict", false]], "data_dict (flownode property)": [[126, "engforge.eng.pipes.FlowNode.data_dict", false]], "data_dict (fluidmaterial property)": [[101, "engforge.eng.fluid_material.FluidMaterial.data_dict", false]], "data_dict (hydrogen property)": [[102, "engforge.eng.fluid_material.Hydrogen.data_dict", false]], "data_dict (idealair property)": [[103, "engforge.eng.fluid_material.IdealAir.data_dict", false]], "data_dict (idealgas property)": [[104, "engforge.eng.fluid_material.IdealGas.data_dict", false]], "data_dict (idealh2 property)": [[105, "engforge.eng.fluid_material.IdealH2.data_dict", false]], "data_dict (idealoxygen property)": [[106, "engforge.eng.fluid_material.IdealOxygen.data_dict", false]], "data_dict (idealsteam property)": [[107, "engforge.eng.fluid_material.IdealSteam.data_dict", false]], "data_dict (oxygen property)": [[108, "engforge.eng.fluid_material.Oxygen.data_dict", false]], "data_dict (pipe property)": [[127, "engforge.eng.pipes.Pipe.data_dict", false]], "data_dict (pipefitting property)": [[128, "engforge.eng.pipes.PipeFitting.data_dict", false]], "data_dict (pipeflow property)": [[129, "engforge.eng.pipes.PipeFlow.data_dict", false]], "data_dict (pipenode property)": [[131, "engforge.eng.pipes.PipeNode.data_dict", false]], "data_dict (pump property)": [[133, "engforge.eng.pipes.Pump.data_dict", false]], "data_dict (seawater property)": [[109, "engforge.eng.fluid_material.SeaWater.data_dict", false]], "data_dict (simplecompressor property)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.data_dict", false]], "data_dict (simpleheatexchanger property)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.data_dict", false]], "data_dict (simplepump property)": [[156, "engforge.eng.thermodynamics.SimplePump.data_dict", false]], "data_dict (simpleturbine property)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.data_dict", false]], "data_dict (solveableinterface property)": [[49, "engforge.components.SolveableInterface.data_dict", false]], "data_dict (steam property)": [[110, "engforge.eng.fluid_material.Steam.data_dict", false]], "data_dict (tabulationmixin property)": [[253, "engforge.tabulation.TabulationMixin.data_dict", false]], "data_dict (water property)": [[111, "engforge.eng.fluid_material.Water.data_dict", false]], "dataframe (analysis property)": [[2, "engforge.analysis.Analysis.dataframe", false]], "dataframe (dataframemixin property)": [[62, "engforge.dataframe.DataframeMixin.dataframe", false]], "dataframe (problem property)": [[188, "engforge.problem_context.Problem.dataframe", false]], "dataframe (problemexec property)": [[189, "engforge.problem_context.ProblemExec.dataframe", false]], "dataframe_prop (in module engforge.dataframe)": [[63, "engforge.dataframe.dataframe_prop", false]], "dataframe_property (class in engforge.dataframe)": [[64, "engforge.dataframe.dataframe_property", false]], "dataframelog (class in engforge.dataframe)": [[61, "engforge.dataframe.DataFrameLog", false]], "dataframemixin (class in engforge.dataframe)": [[62, "engforge.dataframe.DataframeMixin", false]], "dbconnection (class in engforge.datastores.data)": [[72, "engforge.datastores.data.DBConnection", false]], "debug() (air method)": [[97, "engforge.eng.fluid_material.Air.debug", false]], "debug() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.debug", false]], "debug() (aluminum method)": [[139, "engforge.eng.solid_materials.Aluminum.debug", false]], "debug() (analysis method)": [[2, "engforge.analysis.Analysis.debug", false]], "debug() (ansi_4130 method)": [[137, "engforge.eng.solid_materials.ANSI_4130.debug", false]], "debug() (ansi_4340 method)": [[138, "engforge.eng.solid_materials.ANSI_4340.debug", false]], "debug() (attributedbasemixin method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.debug", false]], "debug() (attrlog method)": [[32, "engforge.attributes.ATTRLog.debug", false]], "debug() (attrsolverlog method)": [[28, "engforge.attr_solver.AttrSolverLog.debug", false]], "debug() (beam method)": [[151, "engforge.eng.structure_beams.Beam.debug", false]], "debug() (carbonfiber method)": [[140, "engforge.eng.solid_materials.CarbonFiber.debug", false]], "debug() (circle method)": [[113, "engforge.eng.geometry.Circle.debug", false]], "debug() (component method)": [[48, "engforge.components.Component.debug", false]], "debug() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.debug", false]], "debug() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.debug", false]], "debug() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.debug", false]], "debug() (concrete method)": [[141, "engforge.eng.solid_materials.Concrete.debug", false]], "debug() (configlog method)": [[51, "engforge.configuration.ConfigLog.debug", false]], "debug() (configuration method)": [[52, "engforge.configuration.Configuration.debug", false]], "debug() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.debug", false]], "debug() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.debug", false]], "debug() (costlog method)": [[90, "engforge.eng.costs.CostLog.debug", false]], "debug() (costmodel method)": [[91, "engforge.eng.costs.CostModel.debug", false]], "debug() (csvreporter method)": [[206, "engforge.reporting.CSVReporter.debug", false]], "debug() (dataframelog method)": [[61, "engforge.dataframe.DataFrameLog.debug", false]], "debug() (dbconnection method)": [[72, "engforge.datastores.data.DBConnection.debug", false]], "debug() (diskcachestore method)": [[73, "engforge.datastores.data.DiskCacheStore.debug", false]], "debug() (diskplotreporter method)": [[207, "engforge.reporting.DiskPlotReporter.debug", false]], "debug() (diskreportermixin method)": [[208, "engforge.reporting.DiskReporterMixin.debug", false]], "debug() (drysoil method)": [[142, "engforge.eng.solid_materials.DrySoil.debug", false]], "debug() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.debug", false]], "debug() (economics method)": [[92, "engforge.eng.costs.Economics.debug", false]], "debug() (engattr method)": [[165, "engforge.engforge_attributes.EngAttr.debug", false]], "debug() (envvariable method)": [[168, "engforge.env_var.EnvVariable.debug", false]], "debug() (excelreporter method)": [[209, "engforge.reporting.ExcelReporter.debug", false]], "debug() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.debug", false]], "debug() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.debug", false]], "debug() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.debug", false]], "debug() (forgelog method)": [[36, "engforge.common.ForgeLog.debug", false]], "debug() (gdrivereporter method)": [[210, "engforge.reporting.GdriveReporter.debug", false]], "debug() (geometrylog method)": [[114, "engforge.eng.geometry.GeometryLog.debug", false]], "debug() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.debug", false]], "debug() (gsheetsreporter method)": [[211, "engforge.reporting.GsheetsReporter.debug", false]], "debug() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.debug", false]], "debug() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.debug", false]], "debug() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.debug", false]], "debug() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.debug", false]], "debug() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.debug", false]], "debug() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.debug", false]], "debug() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.debug", false]], "debug() (log method)": [[173, "engforge.logging.Log.debug", false]], "debug() (loggingmixin method)": [[174, "engforge.logging.LoggingMixin.debug", false]], "debug() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.debug", false]], "debug() (pipe method)": [[127, "engforge.eng.pipes.Pipe.debug", false]], "debug() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.debug", false]], "debug() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.debug", false]], "debug() (pipelog method)": [[130, "engforge.eng.pipes.PipeLog.debug", false]], "debug() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.debug", false]], "debug() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.debug", false]], "debug() (plotlog method)": [[12, "engforge.attr_plotting.PlotLog.debug", false]], "debug() (plotreporter method)": [[212, "engforge.reporting.PlotReporter.debug", false]], "debug() (problog method)": [[187, "engforge.problem_context.ProbLog.debug", false]], "debug() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.debug", false]], "debug() (propertylog method)": [[193, "engforge.properties.PropertyLog.debug", false]], "debug() (pump method)": [[133, "engforge.eng.pipes.Pump.debug", false]], "debug() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.debug", false]], "debug() (reflog method)": [[244, "engforge.system_reference.RefLog.debug", false]], "debug() (reporter method)": [[213, "engforge.reporting.Reporter.debug", false]], "debug() (rock method)": [[143, "engforge.eng.solid_materials.Rock.debug", false]], "debug() (rubber method)": [[144, "engforge.eng.solid_materials.Rubber.debug", false]], "debug() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.debug", false]], "debug() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.debug", false]], "debug() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.debug", false]], "debug() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.debug", false]], "debug() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.debug", false]], "debug() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.debug", false]], "debug() (slotlog method)": [[26, "engforge.attr_slots.SlotLog.debug", false]], "debug() (solidmaterial method)": [[146, "engforge.eng.solid_materials.SolidMaterial.debug", false]], "debug() (solvablelog method)": [[218, "engforge.solveable.SolvableLog.debug", false]], "debug() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.debug", false]], "debug() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.debug", false]], "debug() (solverlog method)": [[221, "engforge.solver.SolverLog.debug", false]], "debug() (solvermixin method)": [[222, "engforge.solver.SolverMixin.debug", false]], "debug() (solverutillog method)": [[224, "engforge.solver_utils.SolverUtilLog.debug", false]], "debug() (ss_316 method)": [[145, "engforge.eng.solid_materials.SS_316.debug", false]], "debug() (steam method)": [[110, "engforge.eng.fluid_material.Steam.debug", false]], "debug() (system method)": [[240, "engforge.system.System.debug", false]], "debug() (systemslog method)": [[241, "engforge.system.SystemsLog.debug", false]], "debug() (tablelog method)": [[252, "engforge.tabulation.TableLog.debug", false]], "debug() (tablereporter method)": [[214, "engforge.reporting.TableReporter.debug", false]], "debug() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.debug", false]], "debug() (temporalreportermixin method)": [[215, "engforge.reporting.TemporalReporterMixin.debug", false]], "debug() (triangle method)": [[120, "engforge.eng.geometry.Triangle.debug", false]], "debug() (water method)": [[111, "engforge.eng.fluid_material.Water.debug", false]], "debug() (wetsoil method)": [[147, "engforge.eng.solid_materials.WetSoil.debug", false]], "debug_levels() (problem method)": [[188, "engforge.problem_context.Problem.debug_levels", false]], "debug_levels() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.debug_levels", false]], "declare_var() (solver class method)": [[29, "engforge.attr_solver.Solver.declare_var", false]], "default_cost() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.default_cost", false]], "default_cost() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.default_cost", false]], "define (solver attribute)": [[29, "engforge.attr_solver.Solver.define", false]], "define() (attr_base class method)": [[33, "engforge.attributes.ATTR_BASE.define", false]], "define() (plot class method)": [[9, "engforge.attr_plotting.Plot.define", false]], "define() (plotbase class method)": [[10, "engforge.attr_plotting.PlotBase.define", false]], "define() (signal class method)": [[22, "engforge.attr_signals.Signal.define", false]], "define() (slot class method)": [[25, "engforge.attr_slots.Slot.define", false]], "define() (time class method)": [[7, "engforge.attr_dynamics.Time.define", false]], "define() (trace class method)": [[14, "engforge.attr_plotting.Trace.define", false]], "define_iterator() (slot class method)": [[25, "engforge.attr_slots.Slot.define_iterator", false]], "define_validate() (attr_base class method)": [[33, "engforge.attributes.ATTR_BASE.define_validate", false]], "define_validate() (plot class method)": [[9, "engforge.attr_plotting.Plot.define_validate", false]], "define_validate() (plotbase class method)": [[10, "engforge.attr_plotting.PlotBase.define_validate", false]], "define_validate() (signal class method)": [[22, "engforge.attr_signals.Signal.define_validate", false]], "define_validate() (slot class method)": [[25, "engforge.attr_slots.Slot.define_validate", false]], "define_validate() (solver class method)": [[29, "engforge.attr_solver.Solver.define_validate", false]], "define_validate() (time class method)": [[7, "engforge.attr_dynamics.Time.define_validate", false]], "define_validate() (trace class method)": [[14, "engforge.attr_plotting.Trace.define_validate", false]], "density (fluidmaterial property)": [[101, "engforge.eng.fluid_material.FluidMaterial.density", false]], "design_flow_curve (pump property)": [[133, "engforge.eng.pipes.Pump.design_flow_curve", false]], "determine_failure_stress() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.determine_failure_stress", false]], "determine_nearest_stationary_state() (air method)": [[97, "engforge.eng.fluid_material.Air.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (beam method)": [[151, "engforge.eng.structure_beams.Beam.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (component method)": [[48, "engforge.components.Component.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (economics method)": [[92, "engforge.eng.costs.Economics.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (pipe method)": [[127, "engforge.eng.pipes.Pipe.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (pump method)": [[133, "engforge.eng.pipes.Pump.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (steam method)": [[110, "engforge.eng.fluid_material.Steam.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (system method)": [[240, "engforge.system.System.determine_nearest_stationary_state", false]], "determine_nearest_stationary_state() (water method)": [[111, "engforge.eng.fluid_material.Water.determine_nearest_stationary_state", false]], "determine_split() (in module engforge.dataframe)": [[65, "engforge.dataframe.determine_split", false]], "df_prop (in module engforge.dataframe)": [[66, "engforge.dataframe.df_prop", false]], "difference() (air method)": [[97, "engforge.eng.fluid_material.Air.difference", false]], "difference() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.difference", false]], "difference() (aluminum method)": [[139, "engforge.eng.solid_materials.Aluminum.difference", false]], "difference() (analysis method)": [[2, "engforge.analysis.Analysis.difference", false]], "difference() (ansi_4130 method)": [[137, "engforge.eng.solid_materials.ANSI_4130.difference", false]], "difference() (ansi_4340 method)": [[138, "engforge.eng.solid_materials.ANSI_4340.difference", false]], "difference() (attributedbasemixin method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.difference", false]], "difference() (beam method)": [[151, "engforge.eng.structure_beams.Beam.difference", false]], "difference() (carbonfiber method)": [[140, "engforge.eng.solid_materials.CarbonFiber.difference", false]], "difference() (circle method)": [[113, "engforge.eng.geometry.Circle.difference", false]], "difference() (component method)": [[48, "engforge.components.Component.difference", false]], "difference() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.difference", false]], "difference() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.difference", false]], "difference() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.difference", false]], "difference() (concrete method)": [[141, "engforge.eng.solid_materials.Concrete.difference", false]], "difference() (configuration method)": [[52, "engforge.configuration.Configuration.difference", false]], "difference() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.difference", false]], "difference() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.difference", false]], "difference() (costmodel method)": [[91, "engforge.eng.costs.CostModel.difference", false]], "difference() (drysoil method)": [[142, "engforge.eng.solid_materials.DrySoil.difference", false]], "difference() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.difference", false]], "difference() (economics method)": [[92, "engforge.eng.costs.Economics.difference", false]], "difference() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.difference", false]], "difference() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.difference", false]], "difference() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.difference", false]], "difference() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.difference", false]], "difference() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.difference", false]], "difference() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.difference", false]], "difference() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.difference", false]], "difference() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.difference", false]], "difference() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.difference", false]], "difference() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.difference", false]], "difference() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.difference", false]], "difference() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.difference", false]], "difference() (pipe method)": [[127, "engforge.eng.pipes.Pipe.difference", false]], "difference() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.difference", false]], "difference() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.difference", false]], "difference() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.difference", false]], "difference() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.difference", false]], "difference() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.difference", false]], "difference() (pump method)": [[133, "engforge.eng.pipes.Pump.difference", false]], "difference() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.difference", false]], "difference() (rock method)": [[143, "engforge.eng.solid_materials.Rock.difference", false]], "difference() (rubber method)": [[144, "engforge.eng.solid_materials.Rubber.difference", false]], "difference() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.difference", false]], "difference() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.difference", false]], "difference() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.difference", false]], "difference() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.difference", false]], "difference() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.difference", false]], "difference() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.difference", false]], "difference() (solidmaterial method)": [[146, "engforge.eng.solid_materials.SolidMaterial.difference", false]], "difference() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.difference", false]], "difference() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.difference", false]], "difference() (solvermixin method)": [[222, "engforge.solver.SolverMixin.difference", false]], "difference() (ss_316 method)": [[145, "engforge.eng.solid_materials.SS_316.difference", false]], "difference() (steam method)": [[110, "engforge.eng.fluid_material.Steam.difference", false]], "difference() (system method)": [[240, "engforge.system.System.difference", false]], "difference() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.difference", false]], "difference() (triangle method)": [[120, "engforge.eng.geometry.Triangle.difference", false]], "difference() (water method)": [[111, "engforge.eng.fluid_material.Water.difference", false]], "difference() (wetsoil method)": [[147, "engforge.eng.solid_materials.WetSoil.difference", false]], "discard_contexts() (problem method)": [[188, "engforge.problem_context.Problem.discard_contexts", false]], "discard_contexts() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.discard_contexts", false]], "diskcachestore (class in engforge.datastores.data)": [[73, "engforge.datastores.data.DiskCacheStore", false]], "diskplotreporter (class in engforge.reporting)": [[207, "engforge.reporting.DiskPlotReporter", false]], "diskreportermixin (class in engforge.reporting)": [[208, "engforge.reporting.DiskReporterMixin", false]], "dp_f (pipeflow property)": [[129, "engforge.eng.pipes.PipeFlow.dP_f", false]], "dp_he_core() (in module engforge.eng.thermodynamics)": [[158, "engforge.eng.thermodynamics.dp_he_core", false]], "dp_he_entrance() (in module engforge.eng.thermodynamics)": [[159, "engforge.eng.thermodynamics.dp_he_entrance", false]], "dp_he_exit() (in module engforge.eng.thermodynamics)": [[160, "engforge.eng.thermodynamics.dp_he_exit", false]], "dp_he_gas_losses() (in module engforge.eng.thermodynamics)": [[161, "engforge.eng.thermodynamics.dp_he_gas_losses", false]], "dp_p (pipeflow property)": [[129, "engforge.eng.pipes.PipeFlow.dP_p", false]], "dpressure() (pump method)": [[133, "engforge.eng.pipes.Pump.dPressure", false]], "drysoil (class in engforge.eng.solid_materials)": [[142, "engforge.eng.solid_materials.DrySoil", false]], "dxtdt_ref (air property)": [[97, "engforge.eng.fluid_material.Air.dXtdt_ref", false]], "dxtdt_ref (airwatermix property)": [[98, "engforge.eng.fluid_material.AirWaterMix.dXtdt_ref", false]], "dxtdt_ref (beam property)": [[151, "engforge.eng.structure_beams.Beam.dXtdt_ref", false]], "dxtdt_ref (component property)": [[48, "engforge.components.Component.dXtdt_ref", false]], "dxtdt_ref (componentdict property)": [[42, "engforge.component_collections.ComponentDict.dXtdt_ref", false]], "dxtdt_ref (componentiter property)": [[43, "engforge.component_collections.ComponentIter.dXtdt_ref", false]], "dxtdt_ref (componentiterator property)": [[44, "engforge.component_collections.ComponentIterator.dXtdt_ref", false]], "dxtdt_ref (coolpropmaterial property)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.dXtdt_ref", false]], "dxtdt_ref (coolpropmixture property)": [[100, "engforge.eng.fluid_material.CoolPropMixture.dXtdt_ref", false]], "dxtdt_ref (dynamicsmixin property)": [[84, "engforge.dynamics.DynamicsMixin.dXtdt_ref", false]], "dxtdt_ref (economics property)": [[92, "engforge.eng.costs.Economics.dXtdt_ref", false]], "dxtdt_ref (flowinput property)": [[125, "engforge.eng.pipes.FlowInput.dXtdt_ref", false]], "dxtdt_ref (flownode property)": [[126, "engforge.eng.pipes.FlowNode.dXtdt_ref", false]], "dxtdt_ref (fluidmaterial property)": [[101, "engforge.eng.fluid_material.FluidMaterial.dXtdt_ref", false]], "dxtdt_ref (globaldynamics property)": [[85, "engforge.dynamics.GlobalDynamics.dXtdt_ref", false]], "dxtdt_ref (hydrogen property)": [[102, "engforge.eng.fluid_material.Hydrogen.dXtdt_ref", false]], "dxtdt_ref (idealair property)": [[103, "engforge.eng.fluid_material.IdealAir.dXtdt_ref", false]], "dxtdt_ref (idealgas property)": [[104, "engforge.eng.fluid_material.IdealGas.dXtdt_ref", false]], "dxtdt_ref (idealh2 property)": [[105, "engforge.eng.fluid_material.IdealH2.dXtdt_ref", false]], "dxtdt_ref (idealoxygen property)": [[106, "engforge.eng.fluid_material.IdealOxygen.dXtdt_ref", false]], "dxtdt_ref (idealsteam property)": [[107, "engforge.eng.fluid_material.IdealSteam.dXtdt_ref", false]], "dxtdt_ref (oxygen property)": [[108, "engforge.eng.fluid_material.Oxygen.dXtdt_ref", false]], "dxtdt_ref (pipe property)": [[127, "engforge.eng.pipes.Pipe.dXtdt_ref", false]], "dxtdt_ref (pipefitting property)": [[128, "engforge.eng.pipes.PipeFitting.dXtdt_ref", false]], "dxtdt_ref (pipeflow property)": [[129, "engforge.eng.pipes.PipeFlow.dXtdt_ref", false]], "dxtdt_ref (pipenode property)": [[131, "engforge.eng.pipes.PipeNode.dXtdt_ref", false]], "dxtdt_ref (pipesystem property)": [[132, "engforge.eng.pipes.PipeSystem.dXtdt_ref", false]], "dxtdt_ref (pump property)": [[133, "engforge.eng.pipes.Pump.dXtdt_ref", false]], "dxtdt_ref (seawater property)": [[109, "engforge.eng.fluid_material.SeaWater.dXtdt_ref", false]], "dxtdt_ref (simplecompressor property)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.dXtdt_ref", false]], "dxtdt_ref (simpleheatexchanger property)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.dXtdt_ref", false]], "dxtdt_ref (simplepump property)": [[156, "engforge.eng.thermodynamics.SimplePump.dXtdt_ref", false]], "dxtdt_ref (simpleturbine property)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.dXtdt_ref", false]], "dxtdt_ref (steam property)": [[110, "engforge.eng.fluid_material.Steam.dXtdt_ref", false]], "dxtdt_ref (system property)": [[240, "engforge.system.System.dXtdt_ref", false]], "dxtdt_ref (water property)": [[111, "engforge.eng.fluid_material.Water.dXtdt_ref", false]], "dynamic_solve (problem property)": [[188, "engforge.problem_context.Problem.dynamic_solve", false]], "dynamic_solve (problemexec property)": [[189, "engforge.problem_context.ProblemExec.dynamic_solve", false]], "dynamicsmixin (class in engforge.dynamics)": [[84, "engforge.dynamics.DynamicsMixin", false]], "economics (class in engforge.eng.costs)": [[92, "engforge.eng.costs.Economics", false]], "engattr (class in engforge.engforge_attributes)": [[165, "engforge.engforge_attributes.EngAttr", false]], "engforge": [[0, "module-engforge", false]], "engforge.analysis": [[1, "module-engforge.analysis", false]], "engforge.attr_dynamics": [[4, "module-engforge.attr_dynamics", false]], "engforge.attr_plotting": [[8, "module-engforge.attr_plotting", false]], "engforge.attr_signals": [[21, "module-engforge.attr_signals", false]], "engforge.attr_slots": [[24, "module-engforge.attr_slots", false]], "engforge.attr_solver": [[27, "module-engforge.attr_solver", false]], "engforge.attributes": [[31, "module-engforge.attributes", false]], "engforge.common": [[35, "module-engforge.common", false]], "engforge.component_collections": [[41, "module-engforge.component_collections", false]], "engforge.components": [[47, "module-engforge.components", false]], "engforge.configuration": [[50, "module-engforge.configuration", false]], "engforge.dataframe": [[60, "module-engforge.dataframe", false]], "engforge.datastores": [[70, "module-engforge.datastores", false]], "engforge.datastores.data": [[71, "module-engforge.datastores.data", false]], "engforge.dynamics": [[83, "module-engforge.dynamics", false]], "engforge.eng": [[88, "module-engforge.eng", false]], "engforge.eng.costs": [[89, "module-engforge.eng.costs", false]], "engforge.eng.fluid_material": [[96, "module-engforge.eng.fluid_material", false]], "engforge.eng.geometry": [[112, "module-engforge.eng.geometry", false]], "engforge.eng.pipes": [[124, "module-engforge.eng.pipes", false]], "engforge.eng.prediction": [[134, "module-engforge.eng.prediction", false]], "engforge.eng.solid_materials": [[136, "module-engforge.eng.solid_materials", false]], "engforge.eng.structure_beams": [[150, "module-engforge.eng.structure_beams", false]], "engforge.eng.thermodynamics": [[153, "module-engforge.eng.thermodynamics", false]], "engforge.engforge_attributes": [[163, "module-engforge.engforge_attributes", false]], "engforge.env_var": [[167, "module-engforge.env_var", false]], "engforge.locations": [[170, "module-engforge.locations", false]], "engforge.logging": [[172, "module-engforge.logging", false]], "engforge.patterns": [[176, "module-engforge.patterns", false]], "engforge.problem_context": [[185, "module-engforge.problem_context", false]], "engforge.properties": [[192, "module-engforge.properties", false]], "engforge.reporting": [[205, "module-engforge.reporting", false]], "engforge.solveable": [[217, "module-engforge.solveable", false]], "engforge.solver": [[220, "module-engforge.solver", false]], "engforge.solver_utils": [[223, "module-engforge.solver_utils", false]], "engforge.system": [[239, "module-engforge.system", false]], "engforge.system_reference": [[242, "module-engforge.system_reference", false]], "engforge.tabulation": [[251, "module-engforge.tabulation", false]], "engforge.typing": [[254, "module-engforge.typing", false]], "engforge_prop (class in engforge.properties)": [[199, "engforge.properties.engforge_prop", false]], "ensure_database_exists() (dbconnection method)": [[72, "engforge.datastores.data.DBConnection.ensure_database_exists", false]], "envvariable (class in engforge.env_var)": [[168, "engforge.env_var.EnvVariable", false]], "error() (air method)": [[97, "engforge.eng.fluid_material.Air.error", false]], "error() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.error", false]], "error() (aluminum method)": [[139, "engforge.eng.solid_materials.Aluminum.error", false]], "error() (analysis method)": [[2, "engforge.analysis.Analysis.error", false]], "error() (ansi_4130 method)": [[137, "engforge.eng.solid_materials.ANSI_4130.error", false]], "error() (ansi_4340 method)": [[138, "engforge.eng.solid_materials.ANSI_4340.error", false]], "error() (attributedbasemixin method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.error", false]], "error() (attrlog method)": [[32, "engforge.attributes.ATTRLog.error", false]], "error() (attrsolverlog method)": [[28, "engforge.attr_solver.AttrSolverLog.error", false]], "error() (beam method)": [[151, "engforge.eng.structure_beams.Beam.error", false]], "error() (carbonfiber method)": [[140, "engforge.eng.solid_materials.CarbonFiber.error", false]], "error() (circle method)": [[113, "engforge.eng.geometry.Circle.error", false]], "error() (component method)": [[48, "engforge.components.Component.error", false]], "error() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.error", false]], "error() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.error", false]], "error() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.error", false]], "error() (concrete method)": [[141, "engforge.eng.solid_materials.Concrete.error", false]], "error() (configlog method)": [[51, "engforge.configuration.ConfigLog.error", false]], "error() (configuration method)": [[52, "engforge.configuration.Configuration.error", false]], "error() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.error", false]], "error() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.error", false]], "error() (costlog method)": [[90, "engforge.eng.costs.CostLog.error", false]], "error() (costmodel method)": [[91, "engforge.eng.costs.CostModel.error", false]], "error() (csvreporter method)": [[206, "engforge.reporting.CSVReporter.error", false]], "error() (dataframelog method)": [[61, "engforge.dataframe.DataFrameLog.error", false]], "error() (dbconnection method)": [[72, "engforge.datastores.data.DBConnection.error", false]], "error() (diskcachestore method)": [[73, "engforge.datastores.data.DiskCacheStore.error", false]], "error() (diskplotreporter method)": [[207, "engforge.reporting.DiskPlotReporter.error", false]], "error() (diskreportermixin method)": [[208, "engforge.reporting.DiskReporterMixin.error", false]], "error() (drysoil method)": [[142, "engforge.eng.solid_materials.DrySoil.error", false]], "error() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.error", false]], "error() (economics method)": [[92, "engforge.eng.costs.Economics.error", false]], "error() (engattr method)": [[165, "engforge.engforge_attributes.EngAttr.error", false]], "error() (envvariable method)": [[168, "engforge.env_var.EnvVariable.error", false]], "error() (excelreporter method)": [[209, "engforge.reporting.ExcelReporter.error", false]], "error() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.error", false]], "error() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.error", false]], "error() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.error", false]], "error() (forgelog method)": [[36, "engforge.common.ForgeLog.error", false]], "error() (gdrivereporter method)": [[210, "engforge.reporting.GdriveReporter.error", false]], "error() (geometrylog method)": [[114, "engforge.eng.geometry.GeometryLog.error", false]], "error() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.error", false]], "error() (gsheetsreporter method)": [[211, "engforge.reporting.GsheetsReporter.error", false]], "error() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.error", false]], "error() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.error", false]], "error() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.error", false]], "error() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.error", false]], "error() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.error", false]], "error() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.error", false]], "error() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.error", false]], "error() (log method)": [[173, "engforge.logging.Log.error", false]], "error() (loggingmixin method)": [[174, "engforge.logging.LoggingMixin.error", false]], "error() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.error", false]], "error() (pipe method)": [[127, "engforge.eng.pipes.Pipe.error", false]], "error() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.error", false]], "error() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.error", false]], "error() (pipelog method)": [[130, "engforge.eng.pipes.PipeLog.error", false]], "error() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.error", false]], "error() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.error", false]], "error() (plotlog method)": [[12, "engforge.attr_plotting.PlotLog.error", false]], "error() (plotreporter method)": [[212, "engforge.reporting.PlotReporter.error", false]], "error() (problog method)": [[187, "engforge.problem_context.ProbLog.error", false]], "error() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.error", false]], "error() (propertylog method)": [[193, "engforge.properties.PropertyLog.error", false]], "error() (pump method)": [[133, "engforge.eng.pipes.Pump.error", false]], "error() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.error", false]], "error() (reflog method)": [[244, "engforge.system_reference.RefLog.error", false]], "error() (reporter method)": [[213, "engforge.reporting.Reporter.error", false]], "error() (rock method)": [[143, "engforge.eng.solid_materials.Rock.error", false]], "error() (rubber method)": [[144, "engforge.eng.solid_materials.Rubber.error", false]], "error() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.error", false]], "error() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.error", false]], "error() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.error", false]], "error() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.error", false]], "error() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.error", false]], "error() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.error", false]], "error() (slotlog method)": [[26, "engforge.attr_slots.SlotLog.error", false]], "error() (solidmaterial method)": [[146, "engforge.eng.solid_materials.SolidMaterial.error", false]], "error() (solvablelog method)": [[218, "engforge.solveable.SolvableLog.error", false]], "error() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.error", false]], "error() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.error", false]], "error() (solverlog method)": [[221, "engforge.solver.SolverLog.error", false]], "error() (solvermixin method)": [[222, "engforge.solver.SolverMixin.error", false]], "error() (solverutillog method)": [[224, "engforge.solver_utils.SolverUtilLog.error", false]], "error() (ss_316 method)": [[145, "engforge.eng.solid_materials.SS_316.error", false]], "error() (steam method)": [[110, "engforge.eng.fluid_material.Steam.error", false]], "error() (system method)": [[240, "engforge.system.System.error", false]], "error() (systemslog method)": [[241, "engforge.system.SystemsLog.error", false]], "error() (tablelog method)": [[252, "engforge.tabulation.TableLog.error", false]], "error() (tablereporter method)": [[214, "engforge.reporting.TableReporter.error", false]], "error() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.error", false]], "error() (temporalreportermixin method)": [[215, "engforge.reporting.TemporalReporterMixin.error", false]], "error() (triangle method)": [[120, "engforge.eng.geometry.Triangle.error", false]], "error() (water method)": [[111, "engforge.eng.fluid_material.Water.error", false]], "error() (wetsoil method)": [[147, "engforge.eng.solid_materials.WetSoil.error", false]], "error_action() (problem method)": [[188, "engforge.problem_context.Problem.error_action", false]], "error_action() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.error_action", false]], "establish_system() (problem method)": [[188, "engforge.problem_context.Problem.establish_system", false]], "establish_system() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.establish_system", false]], "estimate_failure() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.estimate_failure", false]], "estimate_stress() (beam method)": [[151, "engforge.eng.structure_beams.Beam.estimate_stress", false]], "estimate_stress() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.estimate_stress", false]], "eval() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.eval", false]], "eval() (solvermixin method)": [[222, "engforge.solver.SolverMixin.eval", false]], "eval() (system method)": [[240, "engforge.system.System.eval", false]], "eval_ref() (in module engforge.system_reference)": [[245, "engforge.system_reference.eval_ref", false]], "eval_slot_cost() (in module engforge.eng.costs)": [[94, "engforge.eng.costs.eval_slot_cost", false]], "evolve() (attr_base method)": [[33, "engforge.attributes.ATTR_BASE.evolve", false]], "evolve() (plot method)": [[9, "engforge.attr_plotting.Plot.evolve", false]], "evolve() (plotbase method)": [[10, "engforge.attr_plotting.PlotBase.evolve", false]], "evolve() (signal method)": [[22, "engforge.attr_signals.Signal.evolve", false]], "evolve() (slot method)": [[25, "engforge.attr_slots.Slot.evolve", false]], "evolve() (solver method)": [[29, "engforge.attr_solver.Solver.evolve", false]], "evolve() (time method)": [[7, "engforge.attr_dynamics.Time.evolve", false]], "evolve() (trace method)": [[14, "engforge.attr_plotting.Trace.evolve", false]], "examples": [[259, "module-examples", false]], "examples.air_filter": [[260, "module-examples.air_filter", false]], "examples.spring_mass": [[261, "module-examples.spring_mass", false]], "excelreporter (class in engforge.reporting)": [[209, "engforge.reporting.ExcelReporter", false]], "execute() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.execute", false]], "execute() (solvermixin method)": [[222, "engforge.solver.SolverMixin.execute", false]], "execute() (system method)": [[240, "engforge.system.System.execute", false]], "exit_action() (problem method)": [[188, "engforge.problem_context.Problem.exit_action", false]], "exit_action() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.exit_action", false]], "expire() (diskcachestore method)": [[73, "engforge.datastores.data.DiskCacheStore.expire", false]], "ext_str_list() (in module engforge.solver_utils)": [[228, "engforge.solver_utils.ext_str_list", false]], "extend() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.extend", false]], "f_lin_min() (in module engforge.solver_utils)": [[229, "engforge.solver_utils.f_lin_min", false]], "fail_learning() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.fail_learning", false]], "fanning_friction_factor() (in module engforge.eng.thermodynamics)": [[162, "engforge.eng.thermodynamics.fanning_friction_factor", false]], "fg (beam property)": [[151, "engforge.eng.structure_beams.Beam.Fg", false]], "filename (air property)": [[97, "engforge.eng.fluid_material.Air.filename", false]], "filename (airwatermix property)": [[98, "engforge.eng.fluid_material.AirWaterMix.filename", false]], "filename (aluminum property)": [[139, "engforge.eng.solid_materials.Aluminum.filename", false]], "filename (analysis property)": [[2, "engforge.analysis.Analysis.filename", false]], "filename (ansi_4130 property)": [[137, "engforge.eng.solid_materials.ANSI_4130.filename", false]], "filename (ansi_4340 property)": [[138, "engforge.eng.solid_materials.ANSI_4340.filename", false]], "filename (beam property)": [[151, "engforge.eng.structure_beams.Beam.filename", false]], "filename (carbonfiber property)": [[140, "engforge.eng.solid_materials.CarbonFiber.filename", false]], "filename (circle property)": [[113, "engforge.eng.geometry.Circle.filename", false]], "filename (component property)": [[48, "engforge.components.Component.filename", false]], "filename (componentdict property)": [[42, "engforge.component_collections.ComponentDict.filename", false]], "filename (componentiter property)": [[43, "engforge.component_collections.ComponentIter.filename", false]], "filename (componentiterator property)": [[44, "engforge.component_collections.ComponentIterator.filename", false]], "filename (concrete property)": [[141, "engforge.eng.solid_materials.Concrete.filename", false]], "filename (configuration property)": [[52, "engforge.configuration.Configuration.filename", false]], "filename (coolpropmaterial property)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.filename", false]], "filename (coolpropmixture property)": [[100, "engforge.eng.fluid_material.CoolPropMixture.filename", false]], "filename (costmodel property)": [[91, "engforge.eng.costs.CostModel.filename", false]], "filename (drysoil property)": [[142, "engforge.eng.solid_materials.DrySoil.filename", false]], "filename (dynamicsmixin property)": [[84, "engforge.dynamics.DynamicsMixin.filename", false]], "filename (economics property)": [[92, "engforge.eng.costs.Economics.filename", false]], "filename (flowinput property)": [[125, "engforge.eng.pipes.FlowInput.filename", false]], "filename (flownode property)": [[126, "engforge.eng.pipes.FlowNode.filename", false]], "filename (fluidmaterial property)": [[101, "engforge.eng.fluid_material.FluidMaterial.filename", false]], "filename (globaldynamics property)": [[85, "engforge.dynamics.GlobalDynamics.filename", false]], "filename (hollowcircle property)": [[115, "engforge.eng.geometry.HollowCircle.filename", false]], "filename (hydrogen property)": [[102, "engforge.eng.fluid_material.Hydrogen.filename", false]], "filename (idealair property)": [[103, "engforge.eng.fluid_material.IdealAir.filename", false]], "filename (idealgas property)": [[104, "engforge.eng.fluid_material.IdealGas.filename", false]], "filename (idealh2 property)": [[105, "engforge.eng.fluid_material.IdealH2.filename", false]], "filename (idealoxygen property)": [[106, "engforge.eng.fluid_material.IdealOxygen.filename", false]], "filename (idealsteam property)": [[107, "engforge.eng.fluid_material.IdealSteam.filename", false]], "filename (oxygen property)": [[108, "engforge.eng.fluid_material.Oxygen.filename", false]], "filename (pipe property)": [[127, "engforge.eng.pipes.Pipe.filename", false]], "filename (pipefitting property)": [[128, "engforge.eng.pipes.PipeFitting.filename", false]], "filename (pipeflow property)": [[129, "engforge.eng.pipes.PipeFlow.filename", false]], "filename (pipenode property)": [[131, "engforge.eng.pipes.PipeNode.filename", false]], "filename (pipesystem property)": [[132, "engforge.eng.pipes.PipeSystem.filename", false]], "filename (profile2d property)": [[117, "engforge.eng.geometry.Profile2D.filename", false]], "filename (pump property)": [[133, "engforge.eng.pipes.Pump.filename", false]], "filename (rectangle property)": [[118, "engforge.eng.geometry.Rectangle.filename", false]], "filename (rock property)": [[143, "engforge.eng.solid_materials.Rock.filename", false]], "filename (rubber property)": [[144, "engforge.eng.solid_materials.Rubber.filename", false]], "filename (seawater property)": [[109, "engforge.eng.fluid_material.SeaWater.filename", false]], "filename (shapelysection property)": [[119, "engforge.eng.geometry.ShapelySection.filename", false]], "filename (simplecompressor property)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.filename", false]], "filename (simpleheatexchanger property)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.filename", false]], "filename (simplepump property)": [[156, "engforge.eng.thermodynamics.SimplePump.filename", false]], "filename (simpleturbine property)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.filename", false]], "filename (solidmaterial property)": [[146, "engforge.eng.solid_materials.SolidMaterial.filename", false]], "filename (solveableinterface property)": [[49, "engforge.components.SolveableInterface.filename", false]], "filename (ss_316 property)": [[145, "engforge.eng.solid_materials.SS_316.filename", false]], "filename (steam property)": [[110, "engforge.eng.fluid_material.Steam.filename", false]], "filename (system property)": [[240, "engforge.system.System.filename", false]], "filename (triangle property)": [[120, "engforge.eng.geometry.Triangle.filename", false]], "filename (water property)": [[111, "engforge.eng.fluid_material.Water.filename", false]], "filename (wetsoil property)": [[147, "engforge.eng.solid_materials.WetSoil.filename", false]], "filt_active() (in module engforge.solver_utils)": [[230, "engforge.solver_utils.filt_active", false]], "filter() (air method)": [[97, "engforge.eng.fluid_material.Air.filter", false]], "filter() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.filter", false]], "filter() (aluminum method)": [[139, "engforge.eng.solid_materials.Aluminum.filter", false]], "filter() (analysis method)": [[2, "engforge.analysis.Analysis.filter", false]], "filter() (ansi_4130 method)": [[137, "engforge.eng.solid_materials.ANSI_4130.filter", false]], "filter() (ansi_4340 method)": [[138, "engforge.eng.solid_materials.ANSI_4340.filter", false]], "filter() (attributedbasemixin method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.filter", false]], "filter() (attrlog method)": [[32, "engforge.attributes.ATTRLog.filter", false]], "filter() (attrsolverlog method)": [[28, "engforge.attr_solver.AttrSolverLog.filter", false]], "filter() (beam method)": [[151, "engforge.eng.structure_beams.Beam.filter", false]], "filter() (carbonfiber method)": [[140, "engforge.eng.solid_materials.CarbonFiber.filter", false]], "filter() (circle method)": [[113, "engforge.eng.geometry.Circle.filter", false]], "filter() (component method)": [[48, "engforge.components.Component.filter", false]], "filter() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.filter", false]], "filter() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.filter", false]], "filter() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.filter", false]], "filter() (concrete method)": [[141, "engforge.eng.solid_materials.Concrete.filter", false]], "filter() (configlog method)": [[51, "engforge.configuration.ConfigLog.filter", false]], "filter() (configuration method)": [[52, "engforge.configuration.Configuration.filter", false]], "filter() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.filter", false]], "filter() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.filter", false]], "filter() (costlog method)": [[90, "engforge.eng.costs.CostLog.filter", false]], "filter() (costmodel method)": [[91, "engforge.eng.costs.CostModel.filter", false]], "filter() (csvreporter method)": [[206, "engforge.reporting.CSVReporter.filter", false]], "filter() (dataframelog method)": [[61, "engforge.dataframe.DataFrameLog.filter", false]], "filter() (dbconnection method)": [[72, "engforge.datastores.data.DBConnection.filter", false]], "filter() (diskcachestore method)": [[73, "engforge.datastores.data.DiskCacheStore.filter", false]], "filter() (diskplotreporter method)": [[207, "engforge.reporting.DiskPlotReporter.filter", false]], "filter() (diskreportermixin method)": [[208, "engforge.reporting.DiskReporterMixin.filter", false]], "filter() (drysoil method)": [[142, "engforge.eng.solid_materials.DrySoil.filter", false]], "filter() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.filter", false]], "filter() (economics method)": [[92, "engforge.eng.costs.Economics.filter", false]], "filter() (engattr method)": [[165, "engforge.engforge_attributes.EngAttr.filter", false]], "filter() (envvariable method)": [[168, "engforge.env_var.EnvVariable.filter", false]], "filter() (excelreporter method)": [[209, "engforge.reporting.ExcelReporter.filter", false]], "filter() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.filter", false]], "filter() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.filter", false]], "filter() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.filter", false]], "filter() (forgelog method)": [[36, "engforge.common.ForgeLog.filter", false]], "filter() (gdrivereporter method)": [[210, "engforge.reporting.GdriveReporter.filter", false]], "filter() (geometrylog method)": [[114, "engforge.eng.geometry.GeometryLog.filter", false]], "filter() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.filter", false]], "filter() (gsheetsreporter method)": [[211, "engforge.reporting.GsheetsReporter.filter", false]], "filter() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.filter", false]], "filter() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.filter", false]], "filter() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.filter", false]], "filter() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.filter", false]], "filter() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.filter", false]], "filter() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.filter", false]], "filter() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.filter", false]], "filter() (log method)": [[173, "engforge.logging.Log.filter", false]], "filter() (loggingmixin method)": [[174, "engforge.logging.LoggingMixin.filter", false]], "filter() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.filter", false]], "filter() (pipe method)": [[127, "engforge.eng.pipes.Pipe.filter", false]], "filter() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.filter", false]], "filter() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.filter", false]], "filter() (pipelog method)": [[130, "engforge.eng.pipes.PipeLog.filter", false]], "filter() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.filter", false]], "filter() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.filter", false]], "filter() (plotlog method)": [[12, "engforge.attr_plotting.PlotLog.filter", false]], "filter() (plotreporter method)": [[212, "engforge.reporting.PlotReporter.filter", false]], "filter() (problog method)": [[187, "engforge.problem_context.ProbLog.filter", false]], "filter() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.filter", false]], "filter() (propertylog method)": [[193, "engforge.properties.PropertyLog.filter", false]], "filter() (pump method)": [[133, "engforge.eng.pipes.Pump.filter", false]], "filter() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.filter", false]], "filter() (reflog method)": [[244, "engforge.system_reference.RefLog.filter", false]], "filter() (reporter method)": [[213, "engforge.reporting.Reporter.filter", false]], "filter() (rock method)": [[143, "engforge.eng.solid_materials.Rock.filter", false]], "filter() (rubber method)": [[144, "engforge.eng.solid_materials.Rubber.filter", false]], "filter() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.filter", false]], "filter() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.filter", false]], "filter() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.filter", false]], "filter() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.filter", false]], "filter() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.filter", false]], "filter() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.filter", false]], "filter() (slotlog method)": [[26, "engforge.attr_slots.SlotLog.filter", false]], "filter() (solidmaterial method)": [[146, "engforge.eng.solid_materials.SolidMaterial.filter", false]], "filter() (solvablelog method)": [[218, "engforge.solveable.SolvableLog.filter", false]], "filter() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.filter", false]], "filter() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.filter", false]], "filter() (solverlog method)": [[221, "engforge.solver.SolverLog.filter", false]], "filter() (solvermixin method)": [[222, "engforge.solver.SolverMixin.filter", false]], "filter() (solverutillog method)": [[224, "engforge.solver_utils.SolverUtilLog.filter", false]], "filter() (ss_316 method)": [[145, "engforge.eng.solid_materials.SS_316.filter", false]], "filter() (steam method)": [[110, "engforge.eng.fluid_material.Steam.filter", false]], "filter() (system method)": [[240, "engforge.system.System.filter", false]], "filter() (systemslog method)": [[241, "engforge.system.SystemsLog.filter", false]], "filter() (tablelog method)": [[252, "engforge.tabulation.TableLog.filter", false]], "filter() (tablereporter method)": [[214, "engforge.reporting.TableReporter.filter", false]], "filter() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.filter", false]], "filter() (temporalreportermixin method)": [[215, "engforge.reporting.TemporalReporterMixin.filter", false]], "filter() (triangle method)": [[120, "engforge.eng.geometry.Triangle.filter", false]], "filter() (water method)": [[111, "engforge.eng.fluid_material.Water.filter", false]], "filter() (wetsoil method)": [[147, "engforge.eng.solid_materials.WetSoil.filter", false]], "filter_combos() (in module engforge.solver_utils)": [[231, "engforge.solver_utils.filter_combos", false]], "filter_vals() (in module engforge.solver_utils)": [[232, "engforge.solver_utils.filter_vals", false]], "filter_vars() (problem method)": [[188, "engforge.problem_context.Problem.filter_vars", false]], "filter_vars() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.filter_vars", false]], "final_objectives (problem property)": [[188, "engforge.problem_context.Problem.final_objectives", false]], "final_objectives (problemexec property)": [[189, "engforge.problem_context.ProblemExec.final_objectives", false]], "flat2gen() (in module engforge.patterns)": [[181, "engforge.patterns.flat2gen", false]], "flatten() (in module engforge.patterns)": [[182, "engforge.patterns.flatten", false]], "flowinput (class in engforge.eng.pipes)": [[125, "engforge.eng.pipes.FlowInput", false]], "flownode (class in engforge.eng.pipes)": [[126, "engforge.eng.pipes.FlowNode", false]], "fluidmaterial (class in engforge.eng.fluid_material)": [[101, "engforge.eng.fluid_material.FluidMaterial", false]], "forge() (in module engforge.configuration)": [[55, "engforge.configuration.forge", false]], "forgelog (class in engforge.common)": [[36, "engforge.common.ForgeLog", false]], "fvec (pipe property)": [[127, "engforge.eng.pipes.Pipe.Fvec", false]], "fvec (pipefitting property)": [[128, "engforge.eng.pipes.PipeFitting.Fvec", false]], "fvec (pipeflow property)": [[129, "engforge.eng.pipes.PipeFlow.Fvec", false]], "gdrivereporter (class in engforge.reporting)": [[210, "engforge.reporting.GdriveReporter", false]], "gend() (in module engforge.eng.costs)": [[95, "engforge.eng.costs.gend", false]], "geometrylog (class in engforge.eng.geometry)": [[114, "engforge.eng.geometry.GeometryLog", false]], "get() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.get", false]], "get() (diskcachestore method)": [[73, "engforge.datastores.data.DiskCacheStore.get", false]], "get_attributes_of() (in module engforge.engforge_attributes)": [[166, "engforge.engforge_attributes.get_attributes_of", false]], "get_extra_kws() (problem class method)": [[188, "engforge.problem_context.Problem.get_extra_kws", false]], "get_extra_kws() (problemexec class method)": [[189, "engforge.problem_context.ProblemExec.get_extra_kws", false]], "get_forces_at() (beam method)": [[151, "engforge.eng.structure_beams.Beam.get_forces_at", false]], "get_func_return() (cache_prop method)": [[194, "engforge.properties.cache_prop.get_func_return", false]], "get_func_return() (cached_system_property method)": [[197, "engforge.properties.cached_system_property.get_func_return", false]], "get_func_return() (class_cache method)": [[198, "engforge.properties.class_cache.get_func_return", false]], "get_func_return() (cost_property method)": [[93, "engforge.eng.costs.cost_property.get_func_return", false]], "get_func_return() (dataframe_property method)": [[64, "engforge.dataframe.dataframe_property.get_func_return", false]], "get_func_return() (engforge_prop method)": [[199, "engforge.properties.engforge_prop.get_func_return", false]], "get_func_return() (instance_cached method)": [[200, "engforge.properties.instance_cached.get_func_return", false]], "get_func_return() (solver_cached method)": [[201, "engforge.properties.solver_cached.get_func_return", false]], "get_func_return() (system_property method)": [[204, "engforge.properties.system_property.get_func_return", false]], "get_mesh_size() (in module engforge.eng.geometry)": [[123, "engforge.eng.geometry.get_mesh_size", false]], "get_parent_key() (problem method)": [[188, "engforge.problem_context.Problem.get_parent_key", false]], "get_parent_key() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.get_parent_key", false]], "get_ref_values() (problem method)": [[188, "engforge.problem_context.Problem.get_ref_values", false]], "get_ref_values() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.get_ref_values", false]], "get_sesh() (problem method)": [[188, "engforge.problem_context.Problem.get_sesh", false]], "get_sesh() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.get_sesh", false]], "get_size() (in module engforge.common)": [[38, "engforge.common.get_size", false]], "get_stress_at() (beam method)": [[151, "engforge.eng.structure_beams.Beam.get_stress_at", false]], "get_system_input_refs() (air method)": [[97, "engforge.eng.fluid_material.Air.get_system_input_refs", false]], "get_system_input_refs() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.get_system_input_refs", false]], "get_system_input_refs() (analysis method)": [[2, "engforge.analysis.Analysis.get_system_input_refs", false]], "get_system_input_refs() (beam method)": [[151, "engforge.eng.structure_beams.Beam.get_system_input_refs", false]], "get_system_input_refs() (component method)": [[48, "engforge.components.Component.get_system_input_refs", false]], "get_system_input_refs() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.get_system_input_refs", false]], "get_system_input_refs() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.get_system_input_refs", false]], "get_system_input_refs() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.get_system_input_refs", false]], "get_system_input_refs() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.get_system_input_refs", false]], "get_system_input_refs() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.get_system_input_refs", false]], "get_system_input_refs() (costmodel method)": [[91, "engforge.eng.costs.CostModel.get_system_input_refs", false]], "get_system_input_refs() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.get_system_input_refs", false]], "get_system_input_refs() (economics method)": [[92, "engforge.eng.costs.Economics.get_system_input_refs", false]], "get_system_input_refs() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.get_system_input_refs", false]], "get_system_input_refs() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.get_system_input_refs", false]], "get_system_input_refs() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.get_system_input_refs", false]], "get_system_input_refs() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.get_system_input_refs", false]], "get_system_input_refs() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.get_system_input_refs", false]], "get_system_input_refs() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.get_system_input_refs", false]], "get_system_input_refs() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.get_system_input_refs", false]], "get_system_input_refs() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.get_system_input_refs", false]], "get_system_input_refs() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.get_system_input_refs", false]], "get_system_input_refs() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.get_system_input_refs", false]], "get_system_input_refs() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.get_system_input_refs", false]], "get_system_input_refs() (pipe method)": [[127, "engforge.eng.pipes.Pipe.get_system_input_refs", false]], "get_system_input_refs() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.get_system_input_refs", false]], "get_system_input_refs() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.get_system_input_refs", false]], "get_system_input_refs() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.get_system_input_refs", false]], "get_system_input_refs() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.get_system_input_refs", false]], "get_system_input_refs() (pump method)": [[133, "engforge.eng.pipes.Pump.get_system_input_refs", false]], "get_system_input_refs() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.get_system_input_refs", false]], "get_system_input_refs() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.get_system_input_refs", false]], "get_system_input_refs() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.get_system_input_refs", false]], "get_system_input_refs() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.get_system_input_refs", false]], "get_system_input_refs() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.get_system_input_refs", false]], "get_system_input_refs() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.get_system_input_refs", false]], "get_system_input_refs() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.get_system_input_refs", false]], "get_system_input_refs() (solvermixin method)": [[222, "engforge.solver.SolverMixin.get_system_input_refs", false]], "get_system_input_refs() (steam method)": [[110, "engforge.eng.fluid_material.Steam.get_system_input_refs", false]], "get_system_input_refs() (system method)": [[240, "engforge.system.System.get_system_input_refs", false]], "get_system_input_refs() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.get_system_input_refs", false]], "get_system_input_refs() (water method)": [[111, "engforge.eng.fluid_material.Water.get_system_input_refs", false]], "global_inertia (beam property)": [[151, "engforge.eng.structure_beams.Beam.GLOBAL_INERTIA", false]], "globaldynamics (class in engforge.dynamics)": [[85, "engforge.dynamics.GlobalDynamics", false]], "go_through_configurations() (air method)": [[97, "engforge.eng.fluid_material.Air.go_through_configurations", false]], "go_through_configurations() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.go_through_configurations", false]], "go_through_configurations() (aluminum method)": [[139, "engforge.eng.solid_materials.Aluminum.go_through_configurations", false]], "go_through_configurations() (analysis method)": [[2, "engforge.analysis.Analysis.go_through_configurations", false]], "go_through_configurations() (ansi_4130 method)": [[137, "engforge.eng.solid_materials.ANSI_4130.go_through_configurations", false]], "go_through_configurations() (ansi_4340 method)": [[138, "engforge.eng.solid_materials.ANSI_4340.go_through_configurations", false]], "go_through_configurations() (beam method)": [[151, "engforge.eng.structure_beams.Beam.go_through_configurations", false]], "go_through_configurations() (carbonfiber method)": [[140, "engforge.eng.solid_materials.CarbonFiber.go_through_configurations", false]], "go_through_configurations() (circle method)": [[113, "engforge.eng.geometry.Circle.go_through_configurations", false]], "go_through_configurations() (component method)": [[48, "engforge.components.Component.go_through_configurations", false]], "go_through_configurations() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.go_through_configurations", false]], "go_through_configurations() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.go_through_configurations", false]], "go_through_configurations() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.go_through_configurations", false]], "go_through_configurations() (concrete method)": [[141, "engforge.eng.solid_materials.Concrete.go_through_configurations", false]], "go_through_configurations() (configuration method)": [[52, "engforge.configuration.Configuration.go_through_configurations", false]], "go_through_configurations() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.go_through_configurations", false]], "go_through_configurations() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.go_through_configurations", false]], "go_through_configurations() (costmodel method)": [[91, "engforge.eng.costs.CostModel.go_through_configurations", false]], "go_through_configurations() (drysoil method)": [[142, "engforge.eng.solid_materials.DrySoil.go_through_configurations", false]], "go_through_configurations() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.go_through_configurations", false]], "go_through_configurations() (economics method)": [[92, "engforge.eng.costs.Economics.go_through_configurations", false]], "go_through_configurations() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.go_through_configurations", false]], "go_through_configurations() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.go_through_configurations", false]], "go_through_configurations() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.go_through_configurations", false]], "go_through_configurations() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.go_through_configurations", false]], "go_through_configurations() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.go_through_configurations", false]], "go_through_configurations() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.go_through_configurations", false]], "go_through_configurations() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.go_through_configurations", false]], "go_through_configurations() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.go_through_configurations", false]], "go_through_configurations() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.go_through_configurations", false]], "go_through_configurations() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.go_through_configurations", false]], "go_through_configurations() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.go_through_configurations", false]], "go_through_configurations() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.go_through_configurations", false]], "go_through_configurations() (pipe method)": [[127, "engforge.eng.pipes.Pipe.go_through_configurations", false]], "go_through_configurations() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.go_through_configurations", false]], "go_through_configurations() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.go_through_configurations", false]], "go_through_configurations() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.go_through_configurations", false]], "go_through_configurations() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.go_through_configurations", false]], "go_through_configurations() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.go_through_configurations", false]], "go_through_configurations() (pump method)": [[133, "engforge.eng.pipes.Pump.go_through_configurations", false]], "go_through_configurations() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.go_through_configurations", false]], "go_through_configurations() (rock method)": [[143, "engforge.eng.solid_materials.Rock.go_through_configurations", false]], "go_through_configurations() (rubber method)": [[144, "engforge.eng.solid_materials.Rubber.go_through_configurations", false]], "go_through_configurations() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.go_through_configurations", false]], "go_through_configurations() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.go_through_configurations", false]], "go_through_configurations() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.go_through_configurations", false]], "go_through_configurations() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.go_through_configurations", false]], "go_through_configurations() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.go_through_configurations", false]], "go_through_configurations() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.go_through_configurations", false]], "go_through_configurations() (solidmaterial method)": [[146, "engforge.eng.solid_materials.SolidMaterial.go_through_configurations", false]], "go_through_configurations() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.go_through_configurations", false]], "go_through_configurations() (ss_316 method)": [[145, "engforge.eng.solid_materials.SS_316.go_through_configurations", false]], "go_through_configurations() (steam method)": [[110, "engforge.eng.fluid_material.Steam.go_through_configurations", false]], "go_through_configurations() (system method)": [[240, "engforge.system.System.go_through_configurations", false]], "go_through_configurations() (triangle method)": [[120, "engforge.eng.geometry.Triangle.go_through_configurations", false]], "go_through_configurations() (water method)": [[111, "engforge.eng.fluid_material.Water.go_through_configurations", false]], "go_through_configurations() (wetsoil method)": [[147, "engforge.eng.solid_materials.WetSoil.go_through_configurations", false]], "gsheetsreporter (class in engforge.reporting)": [[211, "engforge.reporting.GsheetsReporter", false]], "handle_instance() (attr_base class method)": [[33, "engforge.attributes.ATTR_BASE.handle_instance", false]], "handle_instance() (plot class method)": [[9, "engforge.attr_plotting.Plot.handle_instance", false]], "handle_instance() (plotbase class method)": [[10, "engforge.attr_plotting.PlotBase.handle_instance", false]], "handle_instance() (signal class method)": [[22, "engforge.attr_signals.Signal.handle_instance", false]], "handle_instance() (slot class method)": [[25, "engforge.attr_slots.Slot.handle_instance", false]], "handle_instance() (solver class method)": [[29, "engforge.attr_solver.Solver.handle_instance", false]], "handle_instance() (time class method)": [[7, "engforge.attr_dynamics.Time.handle_instance", false]], "handle_instance() (trace class method)": [[14, "engforge.attr_plotting.Trace.handle_instance", false]], "handle_normalize() (in module engforge.solver_utils)": [[233, "engforge.solver_utils.handle_normalize", false]], "hash_id() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.hash_id", false]], "hollowcircle (class in engforge.eng.geometry)": [[115, "engforge.eng.geometry.HollowCircle", false]], "hydrogen (class in engforge.eng.fluid_material)": [[102, "engforge.eng.fluid_material.Hydrogen", false]], "idealair (class in engforge.eng.fluid_material)": [[103, "engforge.eng.fluid_material.IdealAir", false]], "idealgas (class in engforge.eng.fluid_material)": [[104, "engforge.eng.fluid_material.IdealGas", false]], "idealh2 (class in engforge.eng.fluid_material)": [[105, "engforge.eng.fluid_material.IdealH2", false]], "idealoxygen (class in engforge.eng.fluid_material)": [[106, "engforge.eng.fluid_material.IdealOxygen", false]], "idealsteam (class in engforge.eng.fluid_material)": [[107, "engforge.eng.fluid_material.IdealSteam", false]], "identity (air property)": [[97, "engforge.eng.fluid_material.Air.identity", false]], "identity (airwatermix property)": [[98, "engforge.eng.fluid_material.AirWaterMix.identity", false]], "identity (aluminum property)": [[139, "engforge.eng.solid_materials.Aluminum.identity", false]], "identity (analysis property)": [[2, "engforge.analysis.Analysis.identity", false]], "identity (ansi_4130 property)": [[137, "engforge.eng.solid_materials.ANSI_4130.identity", false]], "identity (ansi_4340 property)": [[138, "engforge.eng.solid_materials.ANSI_4340.identity", false]], "identity (beam property)": [[151, "engforge.eng.structure_beams.Beam.identity", false]], "identity (carbonfiber property)": [[140, "engforge.eng.solid_materials.CarbonFiber.identity", false]], "identity (circle property)": [[113, "engforge.eng.geometry.Circle.identity", false]], "identity (component property)": [[48, "engforge.components.Component.identity", false]], "identity (componentdict property)": [[42, "engforge.component_collections.ComponentDict.identity", false]], "identity (componentiter property)": [[43, "engforge.component_collections.ComponentIter.identity", false]], "identity (componentiterator property)": [[44, "engforge.component_collections.ComponentIterator.identity", false]], "identity (concrete property)": [[141, "engforge.eng.solid_materials.Concrete.identity", false]], "identity (configuration property)": [[52, "engforge.configuration.Configuration.identity", false]], "identity (coolpropmaterial property)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.identity", false]], "identity (coolpropmixture property)": [[100, "engforge.eng.fluid_material.CoolPropMixture.identity", false]], "identity (costmodel property)": [[91, "engforge.eng.costs.CostModel.identity", false]], "identity (drysoil property)": [[142, "engforge.eng.solid_materials.DrySoil.identity", false]], "identity (dynamicsmixin property)": [[84, "engforge.dynamics.DynamicsMixin.identity", false]], "identity (economics property)": [[92, "engforge.eng.costs.Economics.identity", false]], "identity (flowinput property)": [[125, "engforge.eng.pipes.FlowInput.identity", false]], "identity (flownode property)": [[126, "engforge.eng.pipes.FlowNode.identity", false]], "identity (fluidmaterial property)": [[101, "engforge.eng.fluid_material.FluidMaterial.identity", false]], "identity (globaldynamics property)": [[85, "engforge.dynamics.GlobalDynamics.identity", false]], "identity (hollowcircle property)": [[115, "engforge.eng.geometry.HollowCircle.identity", false]], "identity (hydrogen property)": [[102, "engforge.eng.fluid_material.Hydrogen.identity", false]], "identity (idealair property)": [[103, "engforge.eng.fluid_material.IdealAir.identity", false]], "identity (idealgas property)": [[104, "engforge.eng.fluid_material.IdealGas.identity", false]], "identity (idealh2 property)": [[105, "engforge.eng.fluid_material.IdealH2.identity", false]], "identity (idealoxygen property)": [[106, "engforge.eng.fluid_material.IdealOxygen.identity", false]], "identity (idealsteam property)": [[107, "engforge.eng.fluid_material.IdealSteam.identity", false]], "identity (oxygen property)": [[108, "engforge.eng.fluid_material.Oxygen.identity", false]], "identity (pipe property)": [[127, "engforge.eng.pipes.Pipe.identity", false]], "identity (pipefitting property)": [[128, "engforge.eng.pipes.PipeFitting.identity", false]], "identity (pipeflow property)": [[129, "engforge.eng.pipes.PipeFlow.identity", false]], "identity (pipenode property)": [[131, "engforge.eng.pipes.PipeNode.identity", false]], "identity (pipesystem property)": [[132, "engforge.eng.pipes.PipeSystem.identity", false]], "identity (profile2d property)": [[117, "engforge.eng.geometry.Profile2D.identity", false]], "identity (pump property)": [[133, "engforge.eng.pipes.Pump.identity", false]], "identity (rectangle property)": [[118, "engforge.eng.geometry.Rectangle.identity", false]], "identity (rock property)": [[143, "engforge.eng.solid_materials.Rock.identity", false]], "identity (rubber property)": [[144, "engforge.eng.solid_materials.Rubber.identity", false]], "identity (seawater property)": [[109, "engforge.eng.fluid_material.SeaWater.identity", false]], "identity (shapelysection property)": [[119, "engforge.eng.geometry.ShapelySection.identity", false]], "identity (simplecompressor property)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.identity", false]], "identity (simpleheatexchanger property)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.identity", false]], "identity (simplepump property)": [[156, "engforge.eng.thermodynamics.SimplePump.identity", false]], "identity (simpleturbine property)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.identity", false]], "identity (solidmaterial property)": [[146, "engforge.eng.solid_materials.SolidMaterial.identity", false]], "identity (solveableinterface property)": [[49, "engforge.components.SolveableInterface.identity", false]], "identity (ss_316 property)": [[145, "engforge.eng.solid_materials.SS_316.identity", false]], "identity (steam property)": [[110, "engforge.eng.fluid_material.Steam.identity", false]], "identity (system property)": [[240, "engforge.system.System.identity", false]], "identity (triangle property)": [[120, "engforge.eng.geometry.Triangle.identity", false]], "identity (water property)": [[111, "engforge.eng.fluid_material.Water.identity", false]], "identity (wetsoil property)": [[147, "engforge.eng.solid_materials.WetSoil.identity", false]], "ih() (in module engforge.eng.solid_materials)": [[148, "engforge.eng.solid_materials.ih", false]], "illegalargument": [[186, "engforge.problem_context.IllegalArgument", false]], "index() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.index", false]], "index_map (class in engforge.dynamics)": [[86, "engforge.dynamics.INDEX_MAP", false]], "inertia (beam property)": [[151, "engforge.eng.structure_beams.Beam.INERTIA", false]], "info() (air method)": [[97, "engforge.eng.fluid_material.Air.info", false]], "info() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.info", false]], "info() (aluminum method)": [[139, "engforge.eng.solid_materials.Aluminum.info", false]], "info() (analysis method)": [[2, "engforge.analysis.Analysis.info", false]], "info() (ansi_4130 method)": [[137, "engforge.eng.solid_materials.ANSI_4130.info", false]], "info() (ansi_4340 method)": [[138, "engforge.eng.solid_materials.ANSI_4340.info", false]], "info() (attributedbasemixin method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.info", false]], "info() (attrlog method)": [[32, "engforge.attributes.ATTRLog.info", false]], "info() (attrsolverlog method)": [[28, "engforge.attr_solver.AttrSolverLog.info", false]], "info() (beam method)": [[151, "engforge.eng.structure_beams.Beam.info", false]], "info() (carbonfiber method)": [[140, "engforge.eng.solid_materials.CarbonFiber.info", false]], "info() (circle method)": [[113, "engforge.eng.geometry.Circle.info", false]], "info() (component method)": [[48, "engforge.components.Component.info", false]], "info() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.info", false]], "info() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.info", false]], "info() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.info", false]], "info() (concrete method)": [[141, "engforge.eng.solid_materials.Concrete.info", false]], "info() (configlog method)": [[51, "engforge.configuration.ConfigLog.info", false]], "info() (configuration method)": [[52, "engforge.configuration.Configuration.info", false]], "info() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.info", false]], "info() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.info", false]], "info() (costlog method)": [[90, "engforge.eng.costs.CostLog.info", false]], "info() (costmodel method)": [[91, "engforge.eng.costs.CostModel.info", false]], "info() (csvreporter method)": [[206, "engforge.reporting.CSVReporter.info", false]], "info() (dataframelog method)": [[61, "engforge.dataframe.DataFrameLog.info", false]], "info() (dbconnection method)": [[72, "engforge.datastores.data.DBConnection.info", false]], "info() (diskcachestore method)": [[73, "engforge.datastores.data.DiskCacheStore.info", false]], "info() (diskplotreporter method)": [[207, "engforge.reporting.DiskPlotReporter.info", false]], "info() (diskreportermixin method)": [[208, "engforge.reporting.DiskReporterMixin.info", false]], "info() (drysoil method)": [[142, "engforge.eng.solid_materials.DrySoil.info", false]], "info() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.info", false]], "info() (economics method)": [[92, "engforge.eng.costs.Economics.info", false]], "info() (engattr method)": [[165, "engforge.engforge_attributes.EngAttr.info", false]], "info() (envvariable method)": [[168, "engforge.env_var.EnvVariable.info", false]], "info() (excelreporter method)": [[209, "engforge.reporting.ExcelReporter.info", false]], "info() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.info", false]], "info() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.info", false]], "info() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.info", false]], "info() (forgelog method)": [[36, "engforge.common.ForgeLog.info", false]], "info() (gdrivereporter method)": [[210, "engforge.reporting.GdriveReporter.info", false]], "info() (geometrylog method)": [[114, "engforge.eng.geometry.GeometryLog.info", false]], "info() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.info", false]], "info() (gsheetsreporter method)": [[211, "engforge.reporting.GsheetsReporter.info", false]], "info() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.info", false]], "info() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.info", false]], "info() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.info", false]], "info() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.info", false]], "info() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.info", false]], "info() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.info", false]], "info() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.info", false]], "info() (log method)": [[173, "engforge.logging.Log.info", false]], "info() (loggingmixin method)": [[174, "engforge.logging.LoggingMixin.info", false]], "info() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.info", false]], "info() (pipe method)": [[127, "engforge.eng.pipes.Pipe.info", false]], "info() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.info", false]], "info() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.info", false]], "info() (pipelog method)": [[130, "engforge.eng.pipes.PipeLog.info", false]], "info() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.info", false]], "info() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.info", false]], "info() (plotlog method)": [[12, "engforge.attr_plotting.PlotLog.info", false]], "info() (plotreporter method)": [[212, "engforge.reporting.PlotReporter.info", false]], "info() (problog method)": [[187, "engforge.problem_context.ProbLog.info", false]], "info() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.info", false]], "info() (propertylog method)": [[193, "engforge.properties.PropertyLog.info", false]], "info() (pump method)": [[133, "engforge.eng.pipes.Pump.info", false]], "info() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.info", false]], "info() (reflog method)": [[244, "engforge.system_reference.RefLog.info", false]], "info() (reporter method)": [[213, "engforge.reporting.Reporter.info", false]], "info() (rock method)": [[143, "engforge.eng.solid_materials.Rock.info", false]], "info() (rubber method)": [[144, "engforge.eng.solid_materials.Rubber.info", false]], "info() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.info", false]], "info() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.info", false]], "info() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.info", false]], "info() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.info", false]], "info() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.info", false]], "info() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.info", false]], "info() (slotlog method)": [[26, "engforge.attr_slots.SlotLog.info", false]], "info() (solidmaterial method)": [[146, "engforge.eng.solid_materials.SolidMaterial.info", false]], "info() (solvablelog method)": [[218, "engforge.solveable.SolvableLog.info", false]], "info() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.info", false]], "info() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.info", false]], "info() (solverlog method)": [[221, "engforge.solver.SolverLog.info", false]], "info() (solvermixin method)": [[222, "engforge.solver.SolverMixin.info", false]], "info() (solverutillog method)": [[224, "engforge.solver_utils.SolverUtilLog.info", false]], "info() (ss_316 method)": [[145, "engforge.eng.solid_materials.SS_316.info", false]], "info() (steam method)": [[110, "engforge.eng.fluid_material.Steam.info", false]], "info() (system method)": [[240, "engforge.system.System.info", false]], "info() (systemslog method)": [[241, "engforge.system.SystemsLog.info", false]], "info() (tablelog method)": [[252, "engforge.tabulation.TableLog.info", false]], "info() (tablereporter method)": [[214, "engforge.reporting.TableReporter.info", false]], "info() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.info", false]], "info() (temporalreportermixin method)": [[215, "engforge.reporting.TemporalReporterMixin.info", false]], "info() (triangle method)": [[120, "engforge.eng.geometry.Triangle.info", false]], "info() (water method)": [[111, "engforge.eng.fluid_material.Water.info", false]], "info() (wetsoil method)": [[147, "engforge.eng.solid_materials.WetSoil.info", false]], "input_as_dict (air property)": [[97, "engforge.eng.fluid_material.Air.input_as_dict", false]], "input_as_dict (airwatermix property)": [[98, "engforge.eng.fluid_material.AirWaterMix.input_as_dict", false]], "input_as_dict (aluminum property)": [[139, "engforge.eng.solid_materials.Aluminum.input_as_dict", false]], "input_as_dict (analysis property)": [[2, "engforge.analysis.Analysis.input_as_dict", false]], "input_as_dict (ansi_4130 property)": [[137, "engforge.eng.solid_materials.ANSI_4130.input_as_dict", false]], "input_as_dict (ansi_4340 property)": [[138, "engforge.eng.solid_materials.ANSI_4340.input_as_dict", false]], "input_as_dict (attributedbasemixin property)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.input_as_dict", false]], "input_as_dict (beam property)": [[151, "engforge.eng.structure_beams.Beam.input_as_dict", false]], "input_as_dict (carbonfiber property)": [[140, "engforge.eng.solid_materials.CarbonFiber.input_as_dict", false]], "input_as_dict (circle property)": [[113, "engforge.eng.geometry.Circle.input_as_dict", false]], "input_as_dict (component property)": [[48, "engforge.components.Component.input_as_dict", false]], "input_as_dict (componentdict property)": [[42, "engforge.component_collections.ComponentDict.input_as_dict", false]], "input_as_dict (componentiter property)": [[43, "engforge.component_collections.ComponentIter.input_as_dict", false]], "input_as_dict (componentiterator property)": [[44, "engforge.component_collections.ComponentIterator.input_as_dict", false]], "input_as_dict (concrete property)": [[141, "engforge.eng.solid_materials.Concrete.input_as_dict", false]], "input_as_dict (configuration property)": [[52, "engforge.configuration.Configuration.input_as_dict", false]], "input_as_dict (coolpropmaterial property)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.input_as_dict", false]], "input_as_dict (coolpropmixture property)": [[100, "engforge.eng.fluid_material.CoolPropMixture.input_as_dict", false]], "input_as_dict (costmodel property)": [[91, "engforge.eng.costs.CostModel.input_as_dict", false]], "input_as_dict (drysoil property)": [[142, "engforge.eng.solid_materials.DrySoil.input_as_dict", false]], "input_as_dict (dynamicsmixin property)": [[84, "engforge.dynamics.DynamicsMixin.input_as_dict", false]], "input_as_dict (economics property)": [[92, "engforge.eng.costs.Economics.input_as_dict", false]], "input_as_dict (flowinput property)": [[125, "engforge.eng.pipes.FlowInput.input_as_dict", false]], "input_as_dict (flownode property)": [[126, "engforge.eng.pipes.FlowNode.input_as_dict", false]], "input_as_dict (fluidmaterial property)": [[101, "engforge.eng.fluid_material.FluidMaterial.input_as_dict", false]], "input_as_dict (globaldynamics property)": [[85, "engforge.dynamics.GlobalDynamics.input_as_dict", false]], "input_as_dict (hollowcircle property)": [[115, "engforge.eng.geometry.HollowCircle.input_as_dict", false]], "input_as_dict (hydrogen property)": [[102, "engforge.eng.fluid_material.Hydrogen.input_as_dict", false]], "input_as_dict (idealair property)": [[103, "engforge.eng.fluid_material.IdealAir.input_as_dict", false]], "input_as_dict (idealgas property)": [[104, "engforge.eng.fluid_material.IdealGas.input_as_dict", false]], "input_as_dict (idealh2 property)": [[105, "engforge.eng.fluid_material.IdealH2.input_as_dict", false]], "input_as_dict (idealoxygen property)": [[106, "engforge.eng.fluid_material.IdealOxygen.input_as_dict", false]], "input_as_dict (idealsteam property)": [[107, "engforge.eng.fluid_material.IdealSteam.input_as_dict", false]], "input_as_dict (oxygen property)": [[108, "engforge.eng.fluid_material.Oxygen.input_as_dict", false]], "input_as_dict (pipe property)": [[127, "engforge.eng.pipes.Pipe.input_as_dict", false]], "input_as_dict (pipefitting property)": [[128, "engforge.eng.pipes.PipeFitting.input_as_dict", false]], "input_as_dict (pipeflow property)": [[129, "engforge.eng.pipes.PipeFlow.input_as_dict", false]], "input_as_dict (pipenode property)": [[131, "engforge.eng.pipes.PipeNode.input_as_dict", false]], "input_as_dict (pipesystem property)": [[132, "engforge.eng.pipes.PipeSystem.input_as_dict", false]], "input_as_dict (profile2d property)": [[117, "engforge.eng.geometry.Profile2D.input_as_dict", false]], "input_as_dict (pump property)": [[133, "engforge.eng.pipes.Pump.input_as_dict", false]], "input_as_dict (rectangle property)": [[118, "engforge.eng.geometry.Rectangle.input_as_dict", false]], "input_as_dict (rock property)": [[143, "engforge.eng.solid_materials.Rock.input_as_dict", false]], "input_as_dict (rubber property)": [[144, "engforge.eng.solid_materials.Rubber.input_as_dict", false]], "input_as_dict (seawater property)": [[109, "engforge.eng.fluid_material.SeaWater.input_as_dict", false]], "input_as_dict (shapelysection property)": [[119, "engforge.eng.geometry.ShapelySection.input_as_dict", false]], "input_as_dict (simplecompressor property)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.input_as_dict", false]], "input_as_dict (simpleheatexchanger property)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.input_as_dict", false]], "input_as_dict (simplepump property)": [[156, "engforge.eng.thermodynamics.SimplePump.input_as_dict", false]], "input_as_dict (simpleturbine property)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.input_as_dict", false]], "input_as_dict (solidmaterial property)": [[146, "engforge.eng.solid_materials.SolidMaterial.input_as_dict", false]], "input_as_dict (solveableinterface property)": [[49, "engforge.components.SolveableInterface.input_as_dict", false]], "input_as_dict (solveablemixin property)": [[219, "engforge.solveable.SolveableMixin.input_as_dict", false]], "input_as_dict (solvermixin property)": [[222, "engforge.solver.SolverMixin.input_as_dict", false]], "input_as_dict (ss_316 property)": [[145, "engforge.eng.solid_materials.SS_316.input_as_dict", false]], "input_as_dict (steam property)": [[110, "engforge.eng.fluid_material.Steam.input_as_dict", false]], "input_as_dict (system property)": [[240, "engforge.system.System.input_as_dict", false]], "input_as_dict (tabulationmixin property)": [[253, "engforge.tabulation.TabulationMixin.input_as_dict", false]], "input_as_dict (triangle property)": [[120, "engforge.eng.geometry.Triangle.input_as_dict", false]], "input_as_dict (water property)": [[111, "engforge.eng.fluid_material.Water.input_as_dict", false]], "input_as_dict (wetsoil property)": [[147, "engforge.eng.solid_materials.WetSoil.input_as_dict", false]], "input_fields() (air class method)": [[97, "engforge.eng.fluid_material.Air.input_fields", false]], "input_fields() (airwatermix class method)": [[98, "engforge.eng.fluid_material.AirWaterMix.input_fields", false]], "input_fields() (aluminum class method)": [[139, "engforge.eng.solid_materials.Aluminum.input_fields", false]], "input_fields() (analysis class method)": [[2, "engforge.analysis.Analysis.input_fields", false]], "input_fields() (ansi_4130 class method)": [[137, "engforge.eng.solid_materials.ANSI_4130.input_fields", false]], "input_fields() (ansi_4340 class method)": [[138, "engforge.eng.solid_materials.ANSI_4340.input_fields", false]], "input_fields() (attributedbasemixin class method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.input_fields", false]], "input_fields() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.input_fields", false]], "input_fields() (carbonfiber class method)": [[140, "engforge.eng.solid_materials.CarbonFiber.input_fields", false]], "input_fields() (circle class method)": [[113, "engforge.eng.geometry.Circle.input_fields", false]], "input_fields() (component class method)": [[48, "engforge.components.Component.input_fields", false]], "input_fields() (componentdict class method)": [[42, "engforge.component_collections.ComponentDict.input_fields", false]], "input_fields() (componentiter class method)": [[43, "engforge.component_collections.ComponentIter.input_fields", false]], "input_fields() (componentiterator class method)": [[44, "engforge.component_collections.ComponentIterator.input_fields", false]], "input_fields() (concrete class method)": [[141, "engforge.eng.solid_materials.Concrete.input_fields", false]], "input_fields() (configuration class method)": [[52, "engforge.configuration.Configuration.input_fields", false]], "input_fields() (coolpropmaterial class method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.input_fields", false]], "input_fields() (coolpropmixture class method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.input_fields", false]], "input_fields() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.input_fields", false]], "input_fields() (drysoil class method)": [[142, "engforge.eng.solid_materials.DrySoil.input_fields", false]], "input_fields() (dynamicsmixin class method)": [[84, "engforge.dynamics.DynamicsMixin.input_fields", false]], "input_fields() (economics class method)": [[92, "engforge.eng.costs.Economics.input_fields", false]], "input_fields() (flowinput class method)": [[125, "engforge.eng.pipes.FlowInput.input_fields", false]], "input_fields() (flownode class method)": [[126, "engforge.eng.pipes.FlowNode.input_fields", false]], "input_fields() (fluidmaterial class method)": [[101, "engforge.eng.fluid_material.FluidMaterial.input_fields", false]], "input_fields() (globaldynamics class method)": [[85, "engforge.dynamics.GlobalDynamics.input_fields", false]], "input_fields() (hollowcircle class method)": [[115, "engforge.eng.geometry.HollowCircle.input_fields", false]], "input_fields() (hydrogen class method)": [[102, "engforge.eng.fluid_material.Hydrogen.input_fields", false]], "input_fields() (idealair class method)": [[103, "engforge.eng.fluid_material.IdealAir.input_fields", false]], "input_fields() (idealgas class method)": [[104, "engforge.eng.fluid_material.IdealGas.input_fields", false]], "input_fields() (idealh2 class method)": [[105, "engforge.eng.fluid_material.IdealH2.input_fields", false]], "input_fields() (idealoxygen class method)": [[106, "engforge.eng.fluid_material.IdealOxygen.input_fields", false]], "input_fields() (idealsteam class method)": [[107, "engforge.eng.fluid_material.IdealSteam.input_fields", false]], "input_fields() (oxygen class method)": [[108, "engforge.eng.fluid_material.Oxygen.input_fields", false]], "input_fields() (pipe class method)": [[127, "engforge.eng.pipes.Pipe.input_fields", false]], "input_fields() (pipefitting class method)": [[128, "engforge.eng.pipes.PipeFitting.input_fields", false]], "input_fields() (pipeflow class method)": [[129, "engforge.eng.pipes.PipeFlow.input_fields", false]], "input_fields() (pipenode class method)": [[131, "engforge.eng.pipes.PipeNode.input_fields", false]], "input_fields() (pipesystem class method)": [[132, "engforge.eng.pipes.PipeSystem.input_fields", false]], "input_fields() (profile2d class method)": [[117, "engforge.eng.geometry.Profile2D.input_fields", false]], "input_fields() (pump class method)": [[133, "engforge.eng.pipes.Pump.input_fields", false]], "input_fields() (rectangle class method)": [[118, "engforge.eng.geometry.Rectangle.input_fields", false]], "input_fields() (rock class method)": [[143, "engforge.eng.solid_materials.Rock.input_fields", false]], "input_fields() (rubber class method)": [[144, "engforge.eng.solid_materials.Rubber.input_fields", false]], "input_fields() (seawater class method)": [[109, "engforge.eng.fluid_material.SeaWater.input_fields", false]], "input_fields() (shapelysection class method)": [[119, "engforge.eng.geometry.ShapelySection.input_fields", false]], "input_fields() (simplecompressor class method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.input_fields", false]], "input_fields() (simpleheatexchanger class method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.input_fields", false]], "input_fields() (simplepump class method)": [[156, "engforge.eng.thermodynamics.SimplePump.input_fields", false]], "input_fields() (simpleturbine class method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.input_fields", false]], "input_fields() (solidmaterial class method)": [[146, "engforge.eng.solid_materials.SolidMaterial.input_fields", false]], "input_fields() (solveableinterface class method)": [[49, "engforge.components.SolveableInterface.input_fields", false]], "input_fields() (solveablemixin class method)": [[219, "engforge.solveable.SolveableMixin.input_fields", false]], "input_fields() (solvermixin class method)": [[222, "engforge.solver.SolverMixin.input_fields", false]], "input_fields() (ss_316 class method)": [[145, "engforge.eng.solid_materials.SS_316.input_fields", false]], "input_fields() (steam class method)": [[110, "engforge.eng.fluid_material.Steam.input_fields", false]], "input_fields() (system class method)": [[240, "engforge.system.System.input_fields", false]], "input_fields() (tabulationmixin class method)": [[253, "engforge.tabulation.TabulationMixin.input_fields", false]], "input_fields() (triangle class method)": [[120, "engforge.eng.geometry.Triangle.input_fields", false]], "input_fields() (water class method)": [[111, "engforge.eng.fluid_material.Water.input_fields", false]], "input_fields() (wetsoil class method)": [[147, "engforge.eng.solid_materials.WetSoil.input_fields", false]], "inputsingletonmeta (class in engforge.patterns)": [[177, "engforge.patterns.InputSingletonMeta", false]], "insert() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.insert", false]], "inst_vectorize (class in engforge.common)": [[39, "engforge.common.inst_vectorize", false]], "inst_vectorize (class in engforge.patterns)": [[183, "engforge.patterns.inst_vectorize", false]], "install_seaborn() (in module engforge.attr_plotting)": [[19, "engforge.attr_plotting.install_seaborn", false]], "installstdlogger() (air method)": [[97, "engforge.eng.fluid_material.Air.installSTDLogger", false]], "installstdlogger() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.installSTDLogger", false]], "installstdlogger() (aluminum method)": [[139, "engforge.eng.solid_materials.Aluminum.installSTDLogger", false]], "installstdlogger() (analysis method)": [[2, "engforge.analysis.Analysis.installSTDLogger", false]], "installstdlogger() (ansi_4130 method)": [[137, "engforge.eng.solid_materials.ANSI_4130.installSTDLogger", false]], "installstdlogger() (ansi_4340 method)": [[138, "engforge.eng.solid_materials.ANSI_4340.installSTDLogger", false]], "installstdlogger() (attributedbasemixin method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.installSTDLogger", false]], "installstdlogger() (attrlog method)": [[32, "engforge.attributes.ATTRLog.installSTDLogger", false]], "installstdlogger() (attrsolverlog method)": [[28, "engforge.attr_solver.AttrSolverLog.installSTDLogger", false]], "installstdlogger() (beam method)": [[151, "engforge.eng.structure_beams.Beam.installSTDLogger", false]], "installstdlogger() (carbonfiber method)": [[140, "engforge.eng.solid_materials.CarbonFiber.installSTDLogger", false]], "installstdlogger() (circle method)": [[113, "engforge.eng.geometry.Circle.installSTDLogger", false]], "installstdlogger() (component method)": [[48, "engforge.components.Component.installSTDLogger", false]], "installstdlogger() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.installSTDLogger", false]], "installstdlogger() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.installSTDLogger", false]], "installstdlogger() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.installSTDLogger", false]], "installstdlogger() (concrete method)": [[141, "engforge.eng.solid_materials.Concrete.installSTDLogger", false]], "installstdlogger() (configlog method)": [[51, "engforge.configuration.ConfigLog.installSTDLogger", false]], "installstdlogger() (configuration method)": [[52, "engforge.configuration.Configuration.installSTDLogger", false]], "installstdlogger() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.installSTDLogger", false]], "installstdlogger() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.installSTDLogger", false]], "installstdlogger() (costlog method)": [[90, "engforge.eng.costs.CostLog.installSTDLogger", false]], "installstdlogger() (costmodel method)": [[91, "engforge.eng.costs.CostModel.installSTDLogger", false]], "installstdlogger() (csvreporter method)": [[206, "engforge.reporting.CSVReporter.installSTDLogger", false]], "installstdlogger() (dataframelog method)": [[61, "engforge.dataframe.DataFrameLog.installSTDLogger", false]], "installstdlogger() (dbconnection method)": [[72, "engforge.datastores.data.DBConnection.installSTDLogger", false]], "installstdlogger() (diskcachestore method)": [[73, "engforge.datastores.data.DiskCacheStore.installSTDLogger", false]], "installstdlogger() (diskplotreporter method)": [[207, "engforge.reporting.DiskPlotReporter.installSTDLogger", false]], "installstdlogger() (diskreportermixin method)": [[208, "engforge.reporting.DiskReporterMixin.installSTDLogger", false]], "installstdlogger() (drysoil method)": [[142, "engforge.eng.solid_materials.DrySoil.installSTDLogger", false]], "installstdlogger() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.installSTDLogger", false]], "installstdlogger() (economics method)": [[92, "engforge.eng.costs.Economics.installSTDLogger", false]], "installstdlogger() (engattr method)": [[165, "engforge.engforge_attributes.EngAttr.installSTDLogger", false]], "installstdlogger() (envvariable method)": [[168, "engforge.env_var.EnvVariable.installSTDLogger", false]], "installstdlogger() (excelreporter method)": [[209, "engforge.reporting.ExcelReporter.installSTDLogger", false]], "installstdlogger() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.installSTDLogger", false]], "installstdlogger() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.installSTDLogger", false]], "installstdlogger() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.installSTDLogger", false]], "installstdlogger() (forgelog method)": [[36, "engforge.common.ForgeLog.installSTDLogger", false]], "installstdlogger() (gdrivereporter method)": [[210, "engforge.reporting.GdriveReporter.installSTDLogger", false]], "installstdlogger() (geometrylog method)": [[114, "engforge.eng.geometry.GeometryLog.installSTDLogger", false]], "installstdlogger() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.installSTDLogger", false]], "installstdlogger() (gsheetsreporter method)": [[211, "engforge.reporting.GsheetsReporter.installSTDLogger", false]], "installstdlogger() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.installSTDLogger", false]], "installstdlogger() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.installSTDLogger", false]], "installstdlogger() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.installSTDLogger", false]], "installstdlogger() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.installSTDLogger", false]], "installstdlogger() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.installSTDLogger", false]], "installstdlogger() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.installSTDLogger", false]], "installstdlogger() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.installSTDLogger", false]], "installstdlogger() (log method)": [[173, "engforge.logging.Log.installSTDLogger", false]], "installstdlogger() (loggingmixin method)": [[174, "engforge.logging.LoggingMixin.installSTDLogger", false]], "installstdlogger() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.installSTDLogger", false]], "installstdlogger() (pipe method)": [[127, "engforge.eng.pipes.Pipe.installSTDLogger", false]], "installstdlogger() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.installSTDLogger", false]], "installstdlogger() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.installSTDLogger", false]], "installstdlogger() (pipelog method)": [[130, "engforge.eng.pipes.PipeLog.installSTDLogger", false]], "installstdlogger() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.installSTDLogger", false]], "installstdlogger() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.installSTDLogger", false]], "installstdlogger() (plotlog method)": [[12, "engforge.attr_plotting.PlotLog.installSTDLogger", false]], "installstdlogger() (plotreporter method)": [[212, "engforge.reporting.PlotReporter.installSTDLogger", false]], "installstdlogger() (problog method)": [[187, "engforge.problem_context.ProbLog.installSTDLogger", false]], "installstdlogger() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.installSTDLogger", false]], "installstdlogger() (propertylog method)": [[193, "engforge.properties.PropertyLog.installSTDLogger", false]], "installstdlogger() (pump method)": [[133, "engforge.eng.pipes.Pump.installSTDLogger", false]], "installstdlogger() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.installSTDLogger", false]], "installstdlogger() (reflog method)": [[244, "engforge.system_reference.RefLog.installSTDLogger", false]], "installstdlogger() (reporter method)": [[213, "engforge.reporting.Reporter.installSTDLogger", false]], "installstdlogger() (rock method)": [[143, "engforge.eng.solid_materials.Rock.installSTDLogger", false]], "installstdlogger() (rubber method)": [[144, "engforge.eng.solid_materials.Rubber.installSTDLogger", false]], "installstdlogger() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.installSTDLogger", false]], "installstdlogger() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.installSTDLogger", false]], "installstdlogger() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.installSTDLogger", false]], "installstdlogger() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.installSTDLogger", false]], "installstdlogger() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.installSTDLogger", false]], "installstdlogger() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.installSTDLogger", false]], "installstdlogger() (slotlog method)": [[26, "engforge.attr_slots.SlotLog.installSTDLogger", false]], "installstdlogger() (solidmaterial method)": [[146, "engforge.eng.solid_materials.SolidMaterial.installSTDLogger", false]], "installstdlogger() (solvablelog method)": [[218, "engforge.solveable.SolvableLog.installSTDLogger", false]], "installstdlogger() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.installSTDLogger", false]], "installstdlogger() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.installSTDLogger", false]], "installstdlogger() (solverlog method)": [[221, "engforge.solver.SolverLog.installSTDLogger", false]], "installstdlogger() (solvermixin method)": [[222, "engforge.solver.SolverMixin.installSTDLogger", false]], "installstdlogger() (solverutillog method)": [[224, "engforge.solver_utils.SolverUtilLog.installSTDLogger", false]], "installstdlogger() (ss_316 method)": [[145, "engforge.eng.solid_materials.SS_316.installSTDLogger", false]], "installstdlogger() (steam method)": [[110, "engforge.eng.fluid_material.Steam.installSTDLogger", false]], "installstdlogger() (system method)": [[240, "engforge.system.System.installSTDLogger", false]], "installstdlogger() (systemslog method)": [[241, "engforge.system.SystemsLog.installSTDLogger", false]], "installstdlogger() (tablelog method)": [[252, "engforge.tabulation.TableLog.installSTDLogger", false]], "installstdlogger() (tablereporter method)": [[214, "engforge.reporting.TableReporter.installSTDLogger", false]], "installstdlogger() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.installSTDLogger", false]], "installstdlogger() (temporalreportermixin method)": [[215, "engforge.reporting.TemporalReporterMixin.installSTDLogger", false]], "installstdlogger() (triangle method)": [[120, "engforge.eng.geometry.Triangle.installSTDLogger", false]], "installstdlogger() (water method)": [[111, "engforge.eng.fluid_material.Water.installSTDLogger", false]], "installstdlogger() (wetsoil method)": [[147, "engforge.eng.solid_materials.WetSoil.installSTDLogger", false]], "instance() (singleton method)": [[178, "engforge.patterns.Singleton.instance", false]], "instance_cached (class in engforge.properties)": [[200, "engforge.properties.instance_cached", false]], "instance_class (plot attribute)": [[9, "engforge.attr_plotting.Plot.instance_class", false]], "instance_class (plotbase attribute)": [[10, "engforge.attr_plotting.PlotBase.instance_class", false]], "instance_class (signal attribute)": [[22, "engforge.attr_signals.Signal.instance_class", false]], "instance_class (solver attribute)": [[29, "engforge.attr_solver.Solver.instance_class", false]], "instance_class (time attribute)": [[7, "engforge.attr_dynamics.Time.instance_class", false]], "instance_class (trace attribute)": [[14, "engforge.attr_plotting.Trace.instance_class", false]], "integral_rate() (problem method)": [[188, "engforge.problem_context.Problem.integral_rate", false]], "integral_rate() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.integral_rate", false]], "integrate() (time class method)": [[7, "engforge.attr_dynamics.Time.integrate", false]], "integrator_rate_refs (problem property)": [[188, "engforge.problem_context.Problem.integrator_rate_refs", false]], "integrator_rate_refs (problemexec property)": [[189, "engforge.problem_context.ProblemExec.integrator_rate_refs", false]], "integrator_var_refs (problem property)": [[188, "engforge.problem_context.Problem.integrator_var_refs", false]], "integrator_var_refs (problemexec property)": [[189, "engforge.problem_context.ProblemExec.integrator_var_refs", false]], "integratorinstance (class in engforge.attr_dynamics)": [[5, "engforge.attr_dynamics.IntegratorInstance", false]], "internal_components() (air method)": [[97, "engforge.eng.fluid_material.Air.internal_components", false]], "internal_components() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.internal_components", false]], "internal_components() (analysis method)": [[2, "engforge.analysis.Analysis.internal_components", false]], "internal_components() (beam method)": [[151, "engforge.eng.structure_beams.Beam.internal_components", false]], "internal_components() (component method)": [[48, "engforge.components.Component.internal_components", false]], "internal_components() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.internal_components", false]], "internal_components() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.internal_components", false]], "internal_components() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.internal_components", false]], "internal_components() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.internal_components", false]], "internal_components() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.internal_components", false]], "internal_components() (costmodel method)": [[91, "engforge.eng.costs.CostModel.internal_components", false]], "internal_components() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.internal_components", false]], "internal_components() (economics method)": [[92, "engforge.eng.costs.Economics.internal_components", false]], "internal_components() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.internal_components", false]], "internal_components() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.internal_components", false]], "internal_components() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.internal_components", false]], "internal_components() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.internal_components", false]], "internal_components() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.internal_components", false]], "internal_components() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.internal_components", false]], "internal_components() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.internal_components", false]], "internal_components() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.internal_components", false]], "internal_components() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.internal_components", false]], "internal_components() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.internal_components", false]], "internal_components() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.internal_components", false]], "internal_components() (pipe method)": [[127, "engforge.eng.pipes.Pipe.internal_components", false]], "internal_components() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.internal_components", false]], "internal_components() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.internal_components", false]], "internal_components() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.internal_components", false]], "internal_components() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.internal_components", false]], "internal_components() (pump method)": [[133, "engforge.eng.pipes.Pump.internal_components", false]], "internal_components() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.internal_components", false]], "internal_components() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.internal_components", false]], "internal_components() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.internal_components", false]], "internal_components() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.internal_components", false]], "internal_components() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.internal_components", false]], "internal_components() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.internal_components", false]], "internal_components() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.internal_components", false]], "internal_components() (solvermixin method)": [[222, "engforge.solver.SolverMixin.internal_components", false]], "internal_components() (steam method)": [[110, "engforge.eng.fluid_material.Steam.internal_components", false]], "internal_components() (system method)": [[240, "engforge.system.System.internal_components", false]], "internal_components() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.internal_components", false]], "internal_components() (water method)": [[111, "engforge.eng.fluid_material.Water.internal_components", false]], "internal_configurations() (air method)": [[97, "engforge.eng.fluid_material.Air.internal_configurations", false]], "internal_configurations() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.internal_configurations", false]], "internal_configurations() (aluminum method)": [[139, "engforge.eng.solid_materials.Aluminum.internal_configurations", false]], "internal_configurations() (analysis method)": [[2, "engforge.analysis.Analysis.internal_configurations", false]], "internal_configurations() (ansi_4130 method)": [[137, "engforge.eng.solid_materials.ANSI_4130.internal_configurations", false]], "internal_configurations() (ansi_4340 method)": [[138, "engforge.eng.solid_materials.ANSI_4340.internal_configurations", false]], "internal_configurations() (beam method)": [[151, "engforge.eng.structure_beams.Beam.internal_configurations", false]], "internal_configurations() (carbonfiber method)": [[140, "engforge.eng.solid_materials.CarbonFiber.internal_configurations", false]], "internal_configurations() (circle method)": [[113, "engforge.eng.geometry.Circle.internal_configurations", false]], "internal_configurations() (component method)": [[48, "engforge.components.Component.internal_configurations", false]], "internal_configurations() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.internal_configurations", false]], "internal_configurations() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.internal_configurations", false]], "internal_configurations() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.internal_configurations", false]], "internal_configurations() (concrete method)": [[141, "engforge.eng.solid_materials.Concrete.internal_configurations", false]], "internal_configurations() (configuration method)": [[52, "engforge.configuration.Configuration.internal_configurations", false]], "internal_configurations() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.internal_configurations", false]], "internal_configurations() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.internal_configurations", false]], "internal_configurations() (costmodel method)": [[91, "engforge.eng.costs.CostModel.internal_configurations", false]], "internal_configurations() (drysoil method)": [[142, "engforge.eng.solid_materials.DrySoil.internal_configurations", false]], "internal_configurations() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.internal_configurations", false]], "internal_configurations() (economics method)": [[92, "engforge.eng.costs.Economics.internal_configurations", false]], "internal_configurations() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.internal_configurations", false]], "internal_configurations() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.internal_configurations", false]], "internal_configurations() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.internal_configurations", false]], "internal_configurations() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.internal_configurations", false]], "internal_configurations() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.internal_configurations", false]], "internal_configurations() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.internal_configurations", false]], "internal_configurations() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.internal_configurations", false]], "internal_configurations() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.internal_configurations", false]], "internal_configurations() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.internal_configurations", false]], "internal_configurations() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.internal_configurations", false]], "internal_configurations() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.internal_configurations", false]], "internal_configurations() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.internal_configurations", false]], "internal_configurations() (pipe method)": [[127, "engforge.eng.pipes.Pipe.internal_configurations", false]], "internal_configurations() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.internal_configurations", false]], "internal_configurations() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.internal_configurations", false]], "internal_configurations() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.internal_configurations", false]], "internal_configurations() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.internal_configurations", false]], "internal_configurations() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.internal_configurations", false]], "internal_configurations() (pump method)": [[133, "engforge.eng.pipes.Pump.internal_configurations", false]], "internal_configurations() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.internal_configurations", false]], "internal_configurations() (rock method)": [[143, "engforge.eng.solid_materials.Rock.internal_configurations", false]], "internal_configurations() (rubber method)": [[144, "engforge.eng.solid_materials.Rubber.internal_configurations", false]], "internal_configurations() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.internal_configurations", false]], "internal_configurations() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.internal_configurations", false]], "internal_configurations() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.internal_configurations", false]], "internal_configurations() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.internal_configurations", false]], "internal_configurations() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.internal_configurations", false]], "internal_configurations() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.internal_configurations", false]], "internal_configurations() (solidmaterial method)": [[146, "engforge.eng.solid_materials.SolidMaterial.internal_configurations", false]], "internal_configurations() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.internal_configurations", false]], "internal_configurations() (ss_316 method)": [[145, "engforge.eng.solid_materials.SS_316.internal_configurations", false]], "internal_configurations() (steam method)": [[110, "engforge.eng.fluid_material.Steam.internal_configurations", false]], "internal_configurations() (system method)": [[240, "engforge.system.System.internal_configurations", false]], "internal_configurations() (triangle method)": [[120, "engforge.eng.geometry.Triangle.internal_configurations", false]], "internal_configurations() (water method)": [[111, "engforge.eng.fluid_material.Water.internal_configurations", false]], "internal_configurations() (wetsoil method)": [[147, "engforge.eng.solid_materials.WetSoil.internal_configurations", false]], "internal_references() (air method)": [[97, "engforge.eng.fluid_material.Air.internal_references", false]], "internal_references() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.internal_references", false]], "internal_references() (analysis method)": [[2, "engforge.analysis.Analysis.internal_references", false]], "internal_references() (beam method)": [[151, "engforge.eng.structure_beams.Beam.internal_references", false]], "internal_references() (component method)": [[48, "engforge.components.Component.internal_references", false]], "internal_references() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.internal_references", false]], "internal_references() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.internal_references", false]], "internal_references() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.internal_references", false]], "internal_references() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.internal_references", false]], "internal_references() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.internal_references", false]], "internal_references() (costmodel method)": [[91, "engforge.eng.costs.CostModel.internal_references", false]], "internal_references() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.internal_references", false]], "internal_references() (economics method)": [[92, "engforge.eng.costs.Economics.internal_references", false]], "internal_references() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.internal_references", false]], "internal_references() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.internal_references", false]], "internal_references() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.internal_references", false]], "internal_references() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.internal_references", false]], "internal_references() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.internal_references", false]], "internal_references() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.internal_references", false]], "internal_references() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.internal_references", false]], "internal_references() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.internal_references", false]], "internal_references() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.internal_references", false]], "internal_references() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.internal_references", false]], "internal_references() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.internal_references", false]], "internal_references() (pipe method)": [[127, "engforge.eng.pipes.Pipe.internal_references", false]], "internal_references() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.internal_references", false]], "internal_references() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.internal_references", false]], "internal_references() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.internal_references", false]], "internal_references() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.internal_references", false]], "internal_references() (pump method)": [[133, "engforge.eng.pipes.Pump.internal_references", false]], "internal_references() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.internal_references", false]], "internal_references() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.internal_references", false]], "internal_references() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.internal_references", false]], "internal_references() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.internal_references", false]], "internal_references() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.internal_references", false]], "internal_references() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.internal_references", false]], "internal_references() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.internal_references", false]], "internal_references() (solvermixin method)": [[222, "engforge.solver.SolverMixin.internal_references", false]], "internal_references() (steam method)": [[110, "engforge.eng.fluid_material.Steam.internal_references", false]], "internal_references() (system method)": [[240, "engforge.system.System.internal_references", false]], "internal_references() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.internal_references", false]], "internal_references() (water method)": [[111, "engforge.eng.fluid_material.Water.internal_references", false]], "internal_systems() (air method)": [[97, "engforge.eng.fluid_material.Air.internal_systems", false]], "internal_systems() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.internal_systems", false]], "internal_systems() (analysis method)": [[2, "engforge.analysis.Analysis.internal_systems", false]], "internal_systems() (beam method)": [[151, "engforge.eng.structure_beams.Beam.internal_systems", false]], "internal_systems() (component method)": [[48, "engforge.components.Component.internal_systems", false]], "internal_systems() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.internal_systems", false]], "internal_systems() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.internal_systems", false]], "internal_systems() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.internal_systems", false]], "internal_systems() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.internal_systems", false]], "internal_systems() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.internal_systems", false]], "internal_systems() (costmodel method)": [[91, "engforge.eng.costs.CostModel.internal_systems", false]], "internal_systems() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.internal_systems", false]], "internal_systems() (economics method)": [[92, "engforge.eng.costs.Economics.internal_systems", false]], "internal_systems() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.internal_systems", false]], "internal_systems() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.internal_systems", false]], "internal_systems() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.internal_systems", false]], "internal_systems() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.internal_systems", false]], "internal_systems() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.internal_systems", false]], "internal_systems() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.internal_systems", false]], "internal_systems() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.internal_systems", false]], "internal_systems() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.internal_systems", false]], "internal_systems() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.internal_systems", false]], "internal_systems() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.internal_systems", false]], "internal_systems() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.internal_systems", false]], "internal_systems() (pipe method)": [[127, "engforge.eng.pipes.Pipe.internal_systems", false]], "internal_systems() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.internal_systems", false]], "internal_systems() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.internal_systems", false]], "internal_systems() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.internal_systems", false]], "internal_systems() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.internal_systems", false]], "internal_systems() (pump method)": [[133, "engforge.eng.pipes.Pump.internal_systems", false]], "internal_systems() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.internal_systems", false]], "internal_systems() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.internal_systems", false]], "internal_systems() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.internal_systems", false]], "internal_systems() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.internal_systems", false]], "internal_systems() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.internal_systems", false]], "internal_systems() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.internal_systems", false]], "internal_systems() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.internal_systems", false]], "internal_systems() (solvermixin method)": [[222, "engforge.solver.SolverMixin.internal_systems", false]], "internal_systems() (steam method)": [[110, "engforge.eng.fluid_material.Steam.internal_systems", false]], "internal_systems() (system method)": [[240, "engforge.system.System.internal_systems", false]], "internal_systems() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.internal_systems", false]], "internal_systems() (water method)": [[111, "engforge.eng.fluid_material.Water.internal_systems", false]], "internal_tabulations() (air method)": [[97, "engforge.eng.fluid_material.Air.internal_tabulations", false]], "internal_tabulations() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.internal_tabulations", false]], "internal_tabulations() (analysis method)": [[2, "engforge.analysis.Analysis.internal_tabulations", false]], "internal_tabulations() (beam method)": [[151, "engforge.eng.structure_beams.Beam.internal_tabulations", false]], "internal_tabulations() (component method)": [[48, "engforge.components.Component.internal_tabulations", false]], "internal_tabulations() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.internal_tabulations", false]], "internal_tabulations() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.internal_tabulations", false]], "internal_tabulations() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.internal_tabulations", false]], "internal_tabulations() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.internal_tabulations", false]], "internal_tabulations() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.internal_tabulations", false]], "internal_tabulations() (costmodel method)": [[91, "engforge.eng.costs.CostModel.internal_tabulations", false]], "internal_tabulations() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.internal_tabulations", false]], "internal_tabulations() (economics method)": [[92, "engforge.eng.costs.Economics.internal_tabulations", false]], "internal_tabulations() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.internal_tabulations", false]], "internal_tabulations() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.internal_tabulations", false]], "internal_tabulations() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.internal_tabulations", false]], "internal_tabulations() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.internal_tabulations", false]], "internal_tabulations() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.internal_tabulations", false]], "internal_tabulations() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.internal_tabulations", false]], "internal_tabulations() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.internal_tabulations", false]], "internal_tabulations() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.internal_tabulations", false]], "internal_tabulations() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.internal_tabulations", false]], "internal_tabulations() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.internal_tabulations", false]], "internal_tabulations() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.internal_tabulations", false]], "internal_tabulations() (pipe method)": [[127, "engforge.eng.pipes.Pipe.internal_tabulations", false]], "internal_tabulations() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.internal_tabulations", false]], "internal_tabulations() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.internal_tabulations", false]], "internal_tabulations() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.internal_tabulations", false]], "internal_tabulations() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.internal_tabulations", false]], "internal_tabulations() (pump method)": [[133, "engforge.eng.pipes.Pump.internal_tabulations", false]], "internal_tabulations() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.internal_tabulations", false]], "internal_tabulations() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.internal_tabulations", false]], "internal_tabulations() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.internal_tabulations", false]], "internal_tabulations() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.internal_tabulations", false]], "internal_tabulations() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.internal_tabulations", false]], "internal_tabulations() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.internal_tabulations", false]], "internal_tabulations() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.internal_tabulations", false]], "internal_tabulations() (solvermixin method)": [[222, "engforge.solver.SolverMixin.internal_tabulations", false]], "internal_tabulations() (steam method)": [[110, "engforge.eng.fluid_material.Steam.internal_tabulations", false]], "internal_tabulations() (system method)": [[240, "engforge.system.System.internal_tabulations", false]], "internal_tabulations() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.internal_tabulations", false]], "internal_tabulations() (water method)": [[111, "engforge.eng.fluid_material.Water.internal_tabulations", false]], "is_active (problem property)": [[188, "engforge.problem_context.Problem.is_active", false]], "is_active (problemexec property)": [[189, "engforge.problem_context.ProblemExec.is_active", false]], "is_ec2_instance() (in module engforge.common)": [[40, "engforge.common.is_ec2_instance", false]], "is_uniform() (in module engforge.dataframe)": [[67, "engforge.dataframe.is_uniform", false]], "items() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.items", false]], "iter_tkn (class in engforge.component_collections)": [[46, "engforge.component_collections.iter_tkn", false]], "key_func() (in module engforge.dataframe)": [[68, "engforge.dataframe.key_func", false]], "keys() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.keys", false]], "kwargs (problem property)": [[188, "engforge.problem_context.Problem.kwargs", false]], "kwargs (problemexec property)": [[189, "engforge.problem_context.ProblemExec.kwargs", false]], "last_context (air property)": [[97, "engforge.eng.fluid_material.Air.last_context", false]], "last_context (airwatermix property)": [[98, "engforge.eng.fluid_material.AirWaterMix.last_context", false]], "last_context (analysis property)": [[2, "engforge.analysis.Analysis.last_context", false]], "last_context (beam property)": [[151, "engforge.eng.structure_beams.Beam.last_context", false]], "last_context (component property)": [[48, "engforge.components.Component.last_context", false]], "last_context (componentdict property)": [[42, "engforge.component_collections.ComponentDict.last_context", false]], "last_context (componentiter property)": [[43, "engforge.component_collections.ComponentIter.last_context", false]], "last_context (componentiterator property)": [[44, "engforge.component_collections.ComponentIterator.last_context", false]], "last_context (coolpropmaterial property)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.last_context", false]], "last_context (coolpropmixture property)": [[100, "engforge.eng.fluid_material.CoolPropMixture.last_context", false]], "last_context (costmodel property)": [[91, "engforge.eng.costs.CostModel.last_context", false]], "last_context (economics property)": [[92, "engforge.eng.costs.Economics.last_context", false]], "last_context (flowinput property)": [[125, "engforge.eng.pipes.FlowInput.last_context", false]], "last_context (flownode property)": [[126, "engforge.eng.pipes.FlowNode.last_context", false]], "last_context (fluidmaterial property)": [[101, "engforge.eng.fluid_material.FluidMaterial.last_context", false]], "last_context (hydrogen property)": [[102, "engforge.eng.fluid_material.Hydrogen.last_context", false]], "last_context (idealair property)": [[103, "engforge.eng.fluid_material.IdealAir.last_context", false]], "last_context (idealgas property)": [[104, "engforge.eng.fluid_material.IdealGas.last_context", false]], "last_context (idealh2 property)": [[105, "engforge.eng.fluid_material.IdealH2.last_context", false]], "last_context (idealoxygen property)": [[106, "engforge.eng.fluid_material.IdealOxygen.last_context", false]], "last_context (idealsteam property)": [[107, "engforge.eng.fluid_material.IdealSteam.last_context", false]], "last_context (oxygen property)": [[108, "engforge.eng.fluid_material.Oxygen.last_context", false]], "last_context (pipe property)": [[127, "engforge.eng.pipes.Pipe.last_context", false]], "last_context (pipefitting property)": [[128, "engforge.eng.pipes.PipeFitting.last_context", false]], "last_context (pipeflow property)": [[129, "engforge.eng.pipes.PipeFlow.last_context", false]], "last_context (pipenode property)": [[131, "engforge.eng.pipes.PipeNode.last_context", false]], "last_context (pipesystem property)": [[132, "engforge.eng.pipes.PipeSystem.last_context", false]], "last_context (pump property)": [[133, "engforge.eng.pipes.Pump.last_context", false]], "last_context (seawater property)": [[109, "engforge.eng.fluid_material.SeaWater.last_context", false]], "last_context (simplecompressor property)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.last_context", false]], "last_context (simpleheatexchanger property)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.last_context", false]], "last_context (simplepump property)": [[156, "engforge.eng.thermodynamics.SimplePump.last_context", false]], "last_context (simpleturbine property)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.last_context", false]], "last_context (solveableinterface property)": [[49, "engforge.components.SolveableInterface.last_context", false]], "last_context (steam property)": [[110, "engforge.eng.fluid_material.Steam.last_context", false]], "last_context (system property)": [[240, "engforge.system.System.last_context", false]], "last_context (tabulationmixin property)": [[253, "engforge.tabulation.TabulationMixin.last_context", false]], "last_context (water property)": [[111, "engforge.eng.fluid_material.Water.last_context", false]], "lifecycle_dataframe (economics property)": [[92, "engforge.eng.costs.Economics.lifecycle_dataframe", false]], "lifecycle_output (economics property)": [[92, "engforge.eng.costs.Economics.lifecycle_output", false]], "linear_output() (air method)": [[97, "engforge.eng.fluid_material.Air.linear_output", false]], "linear_output() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.linear_output", false]], "linear_output() (beam method)": [[151, "engforge.eng.structure_beams.Beam.linear_output", false]], "linear_output() (component method)": [[48, "engforge.components.Component.linear_output", false]], "linear_output() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.linear_output", false]], "linear_output() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.linear_output", false]], "linear_output() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.linear_output", false]], "linear_output() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.linear_output", false]], "linear_output() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.linear_output", false]], "linear_output() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.linear_output", false]], "linear_output() (economics method)": [[92, "engforge.eng.costs.Economics.linear_output", false]], "linear_output() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.linear_output", false]], "linear_output() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.linear_output", false]], "linear_output() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.linear_output", false]], "linear_output() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.linear_output", false]], "linear_output() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.linear_output", false]], "linear_output() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.linear_output", false]], "linear_output() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.linear_output", false]], "linear_output() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.linear_output", false]], "linear_output() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.linear_output", false]], "linear_output() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.linear_output", false]], "linear_output() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.linear_output", false]], "linear_output() (pipe method)": [[127, "engforge.eng.pipes.Pipe.linear_output", false]], "linear_output() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.linear_output", false]], "linear_output() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.linear_output", false]], "linear_output() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.linear_output", false]], "linear_output() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.linear_output", false]], "linear_output() (pump method)": [[133, "engforge.eng.pipes.Pump.linear_output", false]], "linear_output() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.linear_output", false]], "linear_output() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.linear_output", false]], "linear_output() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.linear_output", false]], "linear_output() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.linear_output", false]], "linear_output() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.linear_output", false]], "linear_output() (steam method)": [[110, "engforge.eng.fluid_material.Steam.linear_output", false]], "linear_output() (system method)": [[240, "engforge.system.System.linear_output", false]], "linear_output() (water method)": [[111, "engforge.eng.fluid_material.Water.linear_output", false]], "linear_step() (air method)": [[97, "engforge.eng.fluid_material.Air.linear_step", false]], "linear_step() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.linear_step", false]], "linear_step() (beam method)": [[151, "engforge.eng.structure_beams.Beam.linear_step", false]], "linear_step() (component method)": [[48, "engforge.components.Component.linear_step", false]], "linear_step() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.linear_step", false]], "linear_step() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.linear_step", false]], "linear_step() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.linear_step", false]], "linear_step() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.linear_step", false]], "linear_step() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.linear_step", false]], "linear_step() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.linear_step", false]], "linear_step() (economics method)": [[92, "engforge.eng.costs.Economics.linear_step", false]], "linear_step() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.linear_step", false]], "linear_step() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.linear_step", false]], "linear_step() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.linear_step", false]], "linear_step() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.linear_step", false]], "linear_step() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.linear_step", false]], "linear_step() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.linear_step", false]], "linear_step() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.linear_step", false]], "linear_step() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.linear_step", false]], "linear_step() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.linear_step", false]], "linear_step() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.linear_step", false]], "linear_step() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.linear_step", false]], "linear_step() (pipe method)": [[127, "engforge.eng.pipes.Pipe.linear_step", false]], "linear_step() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.linear_step", false]], "linear_step() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.linear_step", false]], "linear_step() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.linear_step", false]], "linear_step() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.linear_step", false]], "linear_step() (pump method)": [[133, "engforge.eng.pipes.Pump.linear_step", false]], "linear_step() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.linear_step", false]], "linear_step() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.linear_step", false]], "linear_step() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.linear_step", false]], "linear_step() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.linear_step", false]], "linear_step() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.linear_step", false]], "linear_step() (steam method)": [[110, "engforge.eng.fluid_material.Steam.linear_step", false]], "linear_step() (system method)": [[240, "engforge.system.System.linear_step", false]], "linear_step() (water method)": [[111, "engforge.eng.fluid_material.Water.linear_step", false]], "local_inertia (beam property)": [[151, "engforge.eng.structure_beams.Beam.LOCAL_INERTIA", false]], "locate() (air class method)": [[97, "engforge.eng.fluid_material.Air.locate", false]], "locate() (airwatermix class method)": [[98, "engforge.eng.fluid_material.AirWaterMix.locate", false]], "locate() (analysis class method)": [[2, "engforge.analysis.Analysis.locate", false]], "locate() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.locate", false]], "locate() (component class method)": [[48, "engforge.components.Component.locate", false]], "locate() (componentdict class method)": [[42, "engforge.component_collections.ComponentDict.locate", false]], "locate() (componentiter class method)": [[43, "engforge.component_collections.ComponentIter.locate", false]], "locate() (componentiterator class method)": [[44, "engforge.component_collections.ComponentIterator.locate", false]], "locate() (coolpropmaterial class method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.locate", false]], "locate() (coolpropmixture class method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.locate", false]], "locate() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.locate", false]], "locate() (dynamicsmixin class method)": [[84, "engforge.dynamics.DynamicsMixin.locate", false]], "locate() (economics class method)": [[92, "engforge.eng.costs.Economics.locate", false]], "locate() (flowinput class method)": [[125, "engforge.eng.pipes.FlowInput.locate", false]], "locate() (flownode class method)": [[126, "engforge.eng.pipes.FlowNode.locate", false]], "locate() (fluidmaterial class method)": [[101, "engforge.eng.fluid_material.FluidMaterial.locate", false]], "locate() (globaldynamics class method)": [[85, "engforge.dynamics.GlobalDynamics.locate", false]], "locate() (hydrogen class method)": [[102, "engforge.eng.fluid_material.Hydrogen.locate", false]], "locate() (idealair class method)": [[103, "engforge.eng.fluid_material.IdealAir.locate", false]], "locate() (idealgas class method)": [[104, "engforge.eng.fluid_material.IdealGas.locate", false]], "locate() (idealh2 class method)": [[105, "engforge.eng.fluid_material.IdealH2.locate", false]], "locate() (idealoxygen class method)": [[106, "engforge.eng.fluid_material.IdealOxygen.locate", false]], "locate() (idealsteam class method)": [[107, "engforge.eng.fluid_material.IdealSteam.locate", false]], "locate() (oxygen class method)": [[108, "engforge.eng.fluid_material.Oxygen.locate", false]], "locate() (pipe class method)": [[127, "engforge.eng.pipes.Pipe.locate", false]], "locate() (pipefitting class method)": [[128, "engforge.eng.pipes.PipeFitting.locate", false]], "locate() (pipeflow class method)": [[129, "engforge.eng.pipes.PipeFlow.locate", false]], "locate() (pipenode class method)": [[131, "engforge.eng.pipes.PipeNode.locate", false]], "locate() (pipesystem class method)": [[132, "engforge.eng.pipes.PipeSystem.locate", false]], "locate() (pump class method)": [[133, "engforge.eng.pipes.Pump.locate", false]], "locate() (seawater class method)": [[109, "engforge.eng.fluid_material.SeaWater.locate", false]], "locate() (simplecompressor class method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.locate", false]], "locate() (simpleheatexchanger class method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.locate", false]], "locate() (simplepump class method)": [[156, "engforge.eng.thermodynamics.SimplePump.locate", false]], "locate() (simpleturbine class method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.locate", false]], "locate() (solveableinterface class method)": [[49, "engforge.components.SolveableInterface.locate", false]], "locate() (solveablemixin class method)": [[219, "engforge.solveable.SolveableMixin.locate", false]], "locate() (solvermixin class method)": [[222, "engforge.solver.SolverMixin.locate", false]], "locate() (steam class method)": [[110, "engforge.eng.fluid_material.Steam.locate", false]], "locate() (system class method)": [[240, "engforge.system.System.locate", false]], "locate() (tabulationmixin class method)": [[253, "engforge.tabulation.TabulationMixin.locate", false]], "locate() (water class method)": [[111, "engforge.eng.fluid_material.Water.locate", false]], "locate_ref() (air method)": [[97, "engforge.eng.fluid_material.Air.locate_ref", false]], "locate_ref() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.locate_ref", false]], "locate_ref() (analysis method)": [[2, "engforge.analysis.Analysis.locate_ref", false]], "locate_ref() (beam method)": [[151, "engforge.eng.structure_beams.Beam.locate_ref", false]], "locate_ref() (component method)": [[48, "engforge.components.Component.locate_ref", false]], "locate_ref() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.locate_ref", false]], "locate_ref() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.locate_ref", false]], "locate_ref() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.locate_ref", false]], "locate_ref() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.locate_ref", false]], "locate_ref() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.locate_ref", false]], "locate_ref() (costmodel method)": [[91, "engforge.eng.costs.CostModel.locate_ref", false]], "locate_ref() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.locate_ref", false]], "locate_ref() (economics method)": [[92, "engforge.eng.costs.Economics.locate_ref", false]], "locate_ref() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.locate_ref", false]], "locate_ref() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.locate_ref", false]], "locate_ref() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.locate_ref", false]], "locate_ref() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.locate_ref", false]], "locate_ref() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.locate_ref", false]], "locate_ref() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.locate_ref", false]], "locate_ref() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.locate_ref", false]], "locate_ref() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.locate_ref", false]], "locate_ref() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.locate_ref", false]], "locate_ref() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.locate_ref", false]], "locate_ref() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.locate_ref", false]], "locate_ref() (pipe method)": [[127, "engforge.eng.pipes.Pipe.locate_ref", false]], "locate_ref() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.locate_ref", false]], "locate_ref() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.locate_ref", false]], "locate_ref() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.locate_ref", false]], "locate_ref() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.locate_ref", false]], "locate_ref() (pump method)": [[133, "engforge.eng.pipes.Pump.locate_ref", false]], "locate_ref() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.locate_ref", false]], "locate_ref() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.locate_ref", false]], "locate_ref() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.locate_ref", false]], "locate_ref() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.locate_ref", false]], "locate_ref() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.locate_ref", false]], "locate_ref() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.locate_ref", false]], "locate_ref() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.locate_ref", false]], "locate_ref() (solvermixin method)": [[222, "engforge.solver.SolverMixin.locate_ref", false]], "locate_ref() (steam method)": [[110, "engforge.eng.fluid_material.Steam.locate_ref", false]], "locate_ref() (system method)": [[240, "engforge.system.System.locate_ref", false]], "locate_ref() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.locate_ref", false]], "locate_ref() (water method)": [[111, "engforge.eng.fluid_material.Water.locate_ref", false]], "log (class in engforge.logging)": [[173, "engforge.logging.Log", false]], "loggingmixin (class in engforge.logging)": [[174, "engforge.logging.LoggingMixin", false]], "make_attribute() (attr_base class method)": [[33, "engforge.attributes.ATTR_BASE.make_attribute", false]], "make_attribute() (plot class method)": [[9, "engforge.attr_plotting.Plot.make_attribute", false]], "make_attribute() (plotbase class method)": [[10, "engforge.attr_plotting.PlotBase.make_attribute", false]], "make_attribute() (signal class method)": [[22, "engforge.attr_signals.Signal.make_attribute", false]], "make_attribute() (slot class method)": [[25, "engforge.attr_slots.Slot.make_attribute", false]], "make_attribute() (solver class method)": [[29, "engforge.attr_solver.Solver.make_attribute", false]], "make_attribute() (time class method)": [[7, "engforge.attr_dynamics.Time.make_attribute", false]], "make_attribute() (trace class method)": [[14, "engforge.attr_plotting.Trace.make_attribute", false]], "make_plots() (analysis method)": [[2, "engforge.analysis.Analysis.make_plots", false]], "make_plots() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.make_plots", false]], "make_plots() (plottingmixin method)": [[13, "engforge.attr_plotting.PlottingMixin.make_plots", false]], "make_plots() (system method)": [[240, "engforge.system.System.make_plots", false]], "make_reporter_check() (in module engforge.analysis)": [[3, "engforge.analysis.make_reporter_check", false]], "mark_all_comps_changed() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.mark_all_comps_changed", false]], "mark_all_comps_changed() (system method)": [[240, "engforge.system.System.mark_all_comps_changed", false]], "max_von_mises() (beam method)": [[151, "engforge.eng.structure_beams.Beam.max_von_mises", false]], "max_von_mises_by_case() (beam method)": [[151, "engforge.eng.structure_beams.Beam.max_von_mises_by_case", false]], "maybe_attr_inst() (in module engforge.system_reference)": [[246, "engforge.system_reference.maybe_attr_inst", false]], "maybe_ref() (in module engforge.system_reference)": [[247, "engforge.system_reference.maybe_ref", false]], "mesh_section() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.mesh_section", false]], "message_with_identiy() (air method)": [[97, "engforge.eng.fluid_material.Air.message_with_identiy", false]], "message_with_identiy() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.message_with_identiy", false]], "message_with_identiy() (aluminum method)": [[139, "engforge.eng.solid_materials.Aluminum.message_with_identiy", false]], "message_with_identiy() (analysis method)": [[2, "engforge.analysis.Analysis.message_with_identiy", false]], "message_with_identiy() (ansi_4130 method)": [[137, "engforge.eng.solid_materials.ANSI_4130.message_with_identiy", false]], "message_with_identiy() (ansi_4340 method)": [[138, "engforge.eng.solid_materials.ANSI_4340.message_with_identiy", false]], "message_with_identiy() (attributedbasemixin method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.message_with_identiy", false]], "message_with_identiy() (attrlog method)": [[32, "engforge.attributes.ATTRLog.message_with_identiy", false]], "message_with_identiy() (attrsolverlog method)": [[28, "engforge.attr_solver.AttrSolverLog.message_with_identiy", false]], "message_with_identiy() (beam method)": [[151, "engforge.eng.structure_beams.Beam.message_with_identiy", false]], "message_with_identiy() (carbonfiber method)": [[140, "engforge.eng.solid_materials.CarbonFiber.message_with_identiy", false]], "message_with_identiy() (circle method)": [[113, "engforge.eng.geometry.Circle.message_with_identiy", false]], "message_with_identiy() (component method)": [[48, "engforge.components.Component.message_with_identiy", false]], "message_with_identiy() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.message_with_identiy", false]], "message_with_identiy() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.message_with_identiy", false]], "message_with_identiy() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.message_with_identiy", false]], "message_with_identiy() (concrete method)": [[141, "engforge.eng.solid_materials.Concrete.message_with_identiy", false]], "message_with_identiy() (configlog method)": [[51, "engforge.configuration.ConfigLog.message_with_identiy", false]], "message_with_identiy() (configuration method)": [[52, "engforge.configuration.Configuration.message_with_identiy", false]], "message_with_identiy() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.message_with_identiy", false]], "message_with_identiy() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.message_with_identiy", false]], "message_with_identiy() (costlog method)": [[90, "engforge.eng.costs.CostLog.message_with_identiy", false]], "message_with_identiy() (costmodel method)": [[91, "engforge.eng.costs.CostModel.message_with_identiy", false]], "message_with_identiy() (csvreporter method)": [[206, "engforge.reporting.CSVReporter.message_with_identiy", false]], "message_with_identiy() (dataframelog method)": [[61, "engforge.dataframe.DataFrameLog.message_with_identiy", false]], "message_with_identiy() (dbconnection method)": [[72, "engforge.datastores.data.DBConnection.message_with_identiy", false]], "message_with_identiy() (diskcachestore method)": [[73, "engforge.datastores.data.DiskCacheStore.message_with_identiy", false]], "message_with_identiy() (diskplotreporter method)": [[207, "engforge.reporting.DiskPlotReporter.message_with_identiy", false]], "message_with_identiy() (diskreportermixin method)": [[208, "engforge.reporting.DiskReporterMixin.message_with_identiy", false]], "message_with_identiy() (drysoil method)": [[142, "engforge.eng.solid_materials.DrySoil.message_with_identiy", false]], "message_with_identiy() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.message_with_identiy", false]], "message_with_identiy() (economics method)": [[92, "engforge.eng.costs.Economics.message_with_identiy", false]], "message_with_identiy() (engattr method)": [[165, "engforge.engforge_attributes.EngAttr.message_with_identiy", false]], "message_with_identiy() (envvariable method)": [[168, "engforge.env_var.EnvVariable.message_with_identiy", false]], "message_with_identiy() (excelreporter method)": [[209, "engforge.reporting.ExcelReporter.message_with_identiy", false]], "message_with_identiy() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.message_with_identiy", false]], "message_with_identiy() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.message_with_identiy", false]], "message_with_identiy() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.message_with_identiy", false]], "message_with_identiy() (forgelog method)": [[36, "engforge.common.ForgeLog.message_with_identiy", false]], "message_with_identiy() (gdrivereporter method)": [[210, "engforge.reporting.GdriveReporter.message_with_identiy", false]], "message_with_identiy() (geometrylog method)": [[114, "engforge.eng.geometry.GeometryLog.message_with_identiy", false]], "message_with_identiy() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.message_with_identiy", false]], "message_with_identiy() (gsheetsreporter method)": [[211, "engforge.reporting.GsheetsReporter.message_with_identiy", false]], "message_with_identiy() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.message_with_identiy", false]], "message_with_identiy() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.message_with_identiy", false]], "message_with_identiy() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.message_with_identiy", false]], "message_with_identiy() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.message_with_identiy", false]], "message_with_identiy() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.message_with_identiy", false]], "message_with_identiy() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.message_with_identiy", false]], "message_with_identiy() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.message_with_identiy", false]], "message_with_identiy() (log method)": [[173, "engforge.logging.Log.message_with_identiy", false]], "message_with_identiy() (loggingmixin method)": [[174, "engforge.logging.LoggingMixin.message_with_identiy", false]], "message_with_identiy() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.message_with_identiy", false]], "message_with_identiy() (pipe method)": [[127, "engforge.eng.pipes.Pipe.message_with_identiy", false]], "message_with_identiy() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.message_with_identiy", false]], "message_with_identiy() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.message_with_identiy", false]], "message_with_identiy() (pipelog method)": [[130, "engforge.eng.pipes.PipeLog.message_with_identiy", false]], "message_with_identiy() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.message_with_identiy", false]], "message_with_identiy() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.message_with_identiy", false]], "message_with_identiy() (plotlog method)": [[12, "engforge.attr_plotting.PlotLog.message_with_identiy", false]], "message_with_identiy() (plotreporter method)": [[212, "engforge.reporting.PlotReporter.message_with_identiy", false]], "message_with_identiy() (problog method)": [[187, "engforge.problem_context.ProbLog.message_with_identiy", false]], "message_with_identiy() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.message_with_identiy", false]], "message_with_identiy() (propertylog method)": [[193, "engforge.properties.PropertyLog.message_with_identiy", false]], "message_with_identiy() (pump method)": [[133, "engforge.eng.pipes.Pump.message_with_identiy", false]], "message_with_identiy() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.message_with_identiy", false]], "message_with_identiy() (reflog method)": [[244, "engforge.system_reference.RefLog.message_with_identiy", false]], "message_with_identiy() (reporter method)": [[213, "engforge.reporting.Reporter.message_with_identiy", false]], "message_with_identiy() (rock method)": [[143, "engforge.eng.solid_materials.Rock.message_with_identiy", false]], "message_with_identiy() (rubber method)": [[144, "engforge.eng.solid_materials.Rubber.message_with_identiy", false]], "message_with_identiy() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.message_with_identiy", false]], "message_with_identiy() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.message_with_identiy", false]], "message_with_identiy() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.message_with_identiy", false]], "message_with_identiy() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.message_with_identiy", false]], "message_with_identiy() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.message_with_identiy", false]], "message_with_identiy() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.message_with_identiy", false]], "message_with_identiy() (slotlog method)": [[26, "engforge.attr_slots.SlotLog.message_with_identiy", false]], "message_with_identiy() (solidmaterial method)": [[146, "engforge.eng.solid_materials.SolidMaterial.message_with_identiy", false]], "message_with_identiy() (solvablelog method)": [[218, "engforge.solveable.SolvableLog.message_with_identiy", false]], "message_with_identiy() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.message_with_identiy", false]], "message_with_identiy() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.message_with_identiy", false]], "message_with_identiy() (solverlog method)": [[221, "engforge.solver.SolverLog.message_with_identiy", false]], "message_with_identiy() (solvermixin method)": [[222, "engforge.solver.SolverMixin.message_with_identiy", false]], "message_with_identiy() (solverutillog method)": [[224, "engforge.solver_utils.SolverUtilLog.message_with_identiy", false]], "message_with_identiy() (ss_316 method)": [[145, "engforge.eng.solid_materials.SS_316.message_with_identiy", false]], "message_with_identiy() (steam method)": [[110, "engforge.eng.fluid_material.Steam.message_with_identiy", false]], "message_with_identiy() (system method)": [[240, "engforge.system.System.message_with_identiy", false]], "message_with_identiy() (systemslog method)": [[241, "engforge.system.SystemsLog.message_with_identiy", false]], "message_with_identiy() (tablelog method)": [[252, "engforge.tabulation.TableLog.message_with_identiy", false]], "message_with_identiy() (tablereporter method)": [[214, "engforge.reporting.TableReporter.message_with_identiy", false]], "message_with_identiy() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.message_with_identiy", false]], "message_with_identiy() (temporalreportermixin method)": [[215, "engforge.reporting.TemporalReporterMixin.message_with_identiy", false]], "message_with_identiy() (triangle method)": [[120, "engforge.eng.geometry.Triangle.message_with_identiy", false]], "message_with_identiy() (water method)": [[111, "engforge.eng.fluid_material.Water.message_with_identiy", false]], "message_with_identiy() (wetsoil method)": [[147, "engforge.eng.solid_materials.WetSoil.message_with_identiy", false]], "meta() (in module engforge.configuration)": [[56, "engforge.configuration.meta", false]], "module": [[0, "module-engforge", false], [1, "module-engforge.analysis", false], [4, "module-engforge.attr_dynamics", false], [8, "module-engforge.attr_plotting", false], [21, "module-engforge.attr_signals", false], [24, "module-engforge.attr_slots", false], [27, "module-engforge.attr_solver", false], [31, "module-engforge.attributes", false], [35, "module-engforge.common", false], [41, "module-engforge.component_collections", false], [47, "module-engforge.components", false], [50, "module-engforge.configuration", false], [60, "module-engforge.dataframe", false], [70, "module-engforge.datastores", false], [71, "module-engforge.datastores.data", false], [83, "module-engforge.dynamics", false], [88, "module-engforge.eng", false], [89, "module-engforge.eng.costs", false], [96, "module-engforge.eng.fluid_material", false], [112, "module-engforge.eng.geometry", false], [124, "module-engforge.eng.pipes", false], [134, "module-engforge.eng.prediction", false], [136, "module-engforge.eng.solid_materials", false], [150, "module-engforge.eng.structure_beams", false], [153, "module-engforge.eng.thermodynamics", false], [163, "module-engforge.engforge_attributes", false], [167, "module-engforge.env_var", false], [170, "module-engforge.locations", false], [172, "module-engforge.logging", false], [176, "module-engforge.patterns", false], [185, "module-engforge.problem_context", false], [192, "module-engforge.properties", false], [205, "module-engforge.reporting", false], [217, "module-engforge.solveable", false], [220, "module-engforge.solver", false], [223, "module-engforge.solver_utils", false], [239, "module-engforge.system", false], [242, "module-engforge.system_reference", false], [251, "module-engforge.tabulation", false], [254, "module-engforge.typing", false], [259, "module-examples", false], [260, "module-examples.air_filter", false], [261, "module-examples.spring_mass", false], [262, "module-test", false], [263, "module-test.test_airfilter", false], [264, "module-test.test_comp_iter", false], [265, "module-test.test_composition", false], [266, "module-test.test_costs", false], [267, "module-test.test_dynamics", false], [268, "module-test.test_dynamics_spaces", false], [269, "module-test.test_four_bar", false], [270, "module-test.test_modules", false], [271, "module-test.test_performance", false], [272, "module-test.test_pipes", false], [273, "module-test.test_problem_deepscoping", false], [274, "module-test.test_slider_crank", false], [275, "module-test.test_solver", false], [276, "module-test.test_tabulation", false]], "mro() (inputsingletonmeta method)": [[177, "engforge.patterns.InputSingletonMeta.mro", false]], "mro() (singletonmeta method)": [[179, "engforge.patterns.SingletonMeta.mro", false]], "msg() (air method)": [[97, "engforge.eng.fluid_material.Air.msg", false]], "msg() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.msg", false]], "msg() (aluminum method)": [[139, "engforge.eng.solid_materials.Aluminum.msg", false]], "msg() (analysis method)": [[2, "engforge.analysis.Analysis.msg", false]], "msg() (ansi_4130 method)": [[137, "engforge.eng.solid_materials.ANSI_4130.msg", false]], "msg() (ansi_4340 method)": [[138, "engforge.eng.solid_materials.ANSI_4340.msg", false]], "msg() (attributedbasemixin method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.msg", false]], "msg() (attrlog method)": [[32, "engforge.attributes.ATTRLog.msg", false]], "msg() (attrsolverlog method)": [[28, "engforge.attr_solver.AttrSolverLog.msg", false]], "msg() (beam method)": [[151, "engforge.eng.structure_beams.Beam.msg", false]], "msg() (carbonfiber method)": [[140, "engforge.eng.solid_materials.CarbonFiber.msg", false]], "msg() (circle method)": [[113, "engforge.eng.geometry.Circle.msg", false]], "msg() (component method)": [[48, "engforge.components.Component.msg", false]], "msg() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.msg", false]], "msg() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.msg", false]], "msg() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.msg", false]], "msg() (concrete method)": [[141, "engforge.eng.solid_materials.Concrete.msg", false]], "msg() (configlog method)": [[51, "engforge.configuration.ConfigLog.msg", false]], "msg() (configuration method)": [[52, "engforge.configuration.Configuration.msg", false]], "msg() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.msg", false]], "msg() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.msg", false]], "msg() (costlog method)": [[90, "engforge.eng.costs.CostLog.msg", false]], "msg() (costmodel method)": [[91, "engforge.eng.costs.CostModel.msg", false]], "msg() (csvreporter method)": [[206, "engforge.reporting.CSVReporter.msg", false]], "msg() (dataframelog method)": [[61, "engforge.dataframe.DataFrameLog.msg", false]], "msg() (dbconnection method)": [[72, "engforge.datastores.data.DBConnection.msg", false]], "msg() (diskcachestore method)": [[73, "engforge.datastores.data.DiskCacheStore.msg", false]], "msg() (diskplotreporter method)": [[207, "engforge.reporting.DiskPlotReporter.msg", false]], "msg() (diskreportermixin method)": [[208, "engforge.reporting.DiskReporterMixin.msg", false]], "msg() (drysoil method)": [[142, "engforge.eng.solid_materials.DrySoil.msg", false]], "msg() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.msg", false]], "msg() (economics method)": [[92, "engforge.eng.costs.Economics.msg", false]], "msg() (engattr method)": [[165, "engforge.engforge_attributes.EngAttr.msg", false]], "msg() (envvariable method)": [[168, "engforge.env_var.EnvVariable.msg", false]], "msg() (excelreporter method)": [[209, "engforge.reporting.ExcelReporter.msg", false]], "msg() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.msg", false]], "msg() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.msg", false]], "msg() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.msg", false]], "msg() (forgelog method)": [[36, "engforge.common.ForgeLog.msg", false]], "msg() (gdrivereporter method)": [[210, "engforge.reporting.GdriveReporter.msg", false]], "msg() (geometrylog method)": [[114, "engforge.eng.geometry.GeometryLog.msg", false]], "msg() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.msg", false]], "msg() (gsheetsreporter method)": [[211, "engforge.reporting.GsheetsReporter.msg", false]], "msg() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.msg", false]], "msg() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.msg", false]], "msg() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.msg", false]], "msg() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.msg", false]], "msg() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.msg", false]], "msg() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.msg", false]], "msg() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.msg", false]], "msg() (log method)": [[173, "engforge.logging.Log.msg", false]], "msg() (loggingmixin method)": [[174, "engforge.logging.LoggingMixin.msg", false]], "msg() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.msg", false]], "msg() (pipe method)": [[127, "engforge.eng.pipes.Pipe.msg", false]], "msg() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.msg", false]], "msg() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.msg", false]], "msg() (pipelog method)": [[130, "engforge.eng.pipes.PipeLog.msg", false]], "msg() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.msg", false]], "msg() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.msg", false]], "msg() (plotlog method)": [[12, "engforge.attr_plotting.PlotLog.msg", false]], "msg() (plotreporter method)": [[212, "engforge.reporting.PlotReporter.msg", false]], "msg() (problog method)": [[187, "engforge.problem_context.ProbLog.msg", false]], "msg() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.msg", false]], "msg() (propertylog method)": [[193, "engforge.properties.PropertyLog.msg", false]], "msg() (pump method)": [[133, "engforge.eng.pipes.Pump.msg", false]], "msg() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.msg", false]], "msg() (reflog method)": [[244, "engforge.system_reference.RefLog.msg", false]], "msg() (reporter method)": [[213, "engforge.reporting.Reporter.msg", false]], "msg() (rock method)": [[143, "engforge.eng.solid_materials.Rock.msg", false]], "msg() (rubber method)": [[144, "engforge.eng.solid_materials.Rubber.msg", false]], "msg() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.msg", false]], "msg() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.msg", false]], "msg() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.msg", false]], "msg() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.msg", false]], "msg() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.msg", false]], "msg() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.msg", false]], "msg() (slotlog method)": [[26, "engforge.attr_slots.SlotLog.msg", false]], "msg() (solidmaterial method)": [[146, "engforge.eng.solid_materials.SolidMaterial.msg", false]], "msg() (solvablelog method)": [[218, "engforge.solveable.SolvableLog.msg", false]], "msg() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.msg", false]], "msg() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.msg", false]], "msg() (solverlog method)": [[221, "engforge.solver.SolverLog.msg", false]], "msg() (solvermixin method)": [[222, "engforge.solver.SolverMixin.msg", false]], "msg() (solverutillog method)": [[224, "engforge.solver_utils.SolverUtilLog.msg", false]], "msg() (ss_316 method)": [[145, "engforge.eng.solid_materials.SS_316.msg", false]], "msg() (steam method)": [[110, "engforge.eng.fluid_material.Steam.msg", false]], "msg() (system method)": [[240, "engforge.system.System.msg", false]], "msg() (systemslog method)": [[241, "engforge.system.SystemsLog.msg", false]], "msg() (tablelog method)": [[252, "engforge.tabulation.TableLog.msg", false]], "msg() (tablereporter method)": [[214, "engforge.reporting.TableReporter.msg", false]], "msg() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.msg", false]], "msg() (temporalreportermixin method)": [[215, "engforge.reporting.TemporalReporterMixin.msg", false]], "msg() (triangle method)": [[120, "engforge.eng.geometry.Triangle.msg", false]], "msg() (water method)": [[111, "engforge.eng.fluid_material.Water.msg", false]], "msg() (wetsoil method)": [[147, "engforge.eng.solid_materials.WetSoil.msg", false]], "name_generator() (in module engforge.configuration)": [[57, "engforge.configuration.name_generator", false]], "nan_to_null() (in module engforge.datastores.data)": [[82, "engforge.datastores.data.nan_to_null", false]], "nonlinear_output() (air method)": [[97, "engforge.eng.fluid_material.Air.nonlinear_output", false]], "nonlinear_output() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.nonlinear_output", false]], "nonlinear_output() (beam method)": [[151, "engforge.eng.structure_beams.Beam.nonlinear_output", false]], "nonlinear_output() (component method)": [[48, "engforge.components.Component.nonlinear_output", false]], "nonlinear_output() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.nonlinear_output", false]], "nonlinear_output() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.nonlinear_output", false]], "nonlinear_output() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.nonlinear_output", false]], "nonlinear_output() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.nonlinear_output", false]], "nonlinear_output() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.nonlinear_output", false]], "nonlinear_output() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.nonlinear_output", false]], "nonlinear_output() (economics method)": [[92, "engforge.eng.costs.Economics.nonlinear_output", false]], "nonlinear_output() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.nonlinear_output", false]], "nonlinear_output() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.nonlinear_output", false]], "nonlinear_output() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.nonlinear_output", false]], "nonlinear_output() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.nonlinear_output", false]], "nonlinear_output() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.nonlinear_output", false]], "nonlinear_output() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.nonlinear_output", false]], "nonlinear_output() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.nonlinear_output", false]], "nonlinear_output() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.nonlinear_output", false]], "nonlinear_output() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.nonlinear_output", false]], "nonlinear_output() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.nonlinear_output", false]], "nonlinear_output() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.nonlinear_output", false]], "nonlinear_output() (pipe method)": [[127, "engforge.eng.pipes.Pipe.nonlinear_output", false]], "nonlinear_output() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.nonlinear_output", false]], "nonlinear_output() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.nonlinear_output", false]], "nonlinear_output() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.nonlinear_output", false]], "nonlinear_output() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.nonlinear_output", false]], "nonlinear_output() (pump method)": [[133, "engforge.eng.pipes.Pump.nonlinear_output", false]], "nonlinear_output() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.nonlinear_output", false]], "nonlinear_output() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.nonlinear_output", false]], "nonlinear_output() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.nonlinear_output", false]], "nonlinear_output() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.nonlinear_output", false]], "nonlinear_output() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.nonlinear_output", false]], "nonlinear_output() (steam method)": [[110, "engforge.eng.fluid_material.Steam.nonlinear_output", false]], "nonlinear_output() (system method)": [[240, "engforge.system.System.nonlinear_output", false]], "nonlinear_output() (water method)": [[111, "engforge.eng.fluid_material.Water.nonlinear_output", false]], "nonlinear_step() (air method)": [[97, "engforge.eng.fluid_material.Air.nonlinear_step", false]], "nonlinear_step() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.nonlinear_step", false]], "nonlinear_step() (beam method)": [[151, "engforge.eng.structure_beams.Beam.nonlinear_step", false]], "nonlinear_step() (component method)": [[48, "engforge.components.Component.nonlinear_step", false]], "nonlinear_step() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.nonlinear_step", false]], "nonlinear_step() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.nonlinear_step", false]], "nonlinear_step() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.nonlinear_step", false]], "nonlinear_step() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.nonlinear_step", false]], "nonlinear_step() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.nonlinear_step", false]], "nonlinear_step() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.nonlinear_step", false]], "nonlinear_step() (economics method)": [[92, "engforge.eng.costs.Economics.nonlinear_step", false]], "nonlinear_step() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.nonlinear_step", false]], "nonlinear_step() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.nonlinear_step", false]], "nonlinear_step() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.nonlinear_step", false]], "nonlinear_step() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.nonlinear_step", false]], "nonlinear_step() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.nonlinear_step", false]], "nonlinear_step() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.nonlinear_step", false]], "nonlinear_step() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.nonlinear_step", false]], "nonlinear_step() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.nonlinear_step", false]], "nonlinear_step() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.nonlinear_step", false]], "nonlinear_step() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.nonlinear_step", false]], "nonlinear_step() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.nonlinear_step", false]], "nonlinear_step() (pipe method)": [[127, "engforge.eng.pipes.Pipe.nonlinear_step", false]], "nonlinear_step() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.nonlinear_step", false]], "nonlinear_step() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.nonlinear_step", false]], "nonlinear_step() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.nonlinear_step", false]], "nonlinear_step() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.nonlinear_step", false]], "nonlinear_step() (pump method)": [[133, "engforge.eng.pipes.Pump.nonlinear_step", false]], "nonlinear_step() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.nonlinear_step", false]], "nonlinear_step() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.nonlinear_step", false]], "nonlinear_step() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.nonlinear_step", false]], "nonlinear_step() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.nonlinear_step", false]], "nonlinear_step() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.nonlinear_step", false]], "nonlinear_step() (steam method)": [[110, "engforge.eng.fluid_material.Steam.nonlinear_step", false]], "nonlinear_step() (system method)": [[240, "engforge.system.System.nonlinear_step", false]], "nonlinear_step() (water method)": [[111, "engforge.eng.fluid_material.Water.nonlinear_step", false]], "numeric_nan_validator() (in module engforge.typing)": [[255, "engforge.typing.NUMERIC_NAN_VALIDATOR", false]], "numeric_validator() (in module engforge.typing)": [[256, "engforge.typing.NUMERIC_VALIDATOR", false]], "obj() (solver class method)": [[29, "engforge.attr_solver.Solver.obj", false]], "objectify() (in module engforge.solver_utils)": [[234, "engforge.solver_utils.objectify", false]], "objective() (solver class method)": [[29, "engforge.attr_solver.Solver.objective", false]], "observe_and_predict() (circle method)": [[113, "engforge.eng.geometry.Circle.observe_and_predict", false]], "observe_and_predict() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.observe_and_predict", false]], "observe_and_predict() (predictionmixin method)": [[135, "engforge.eng.prediction.PredictionMixin.observe_and_predict", false]], "observe_and_predict() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.observe_and_predict", false]], "observe_and_predict() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.observe_and_predict", false]], "observe_and_predict() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.observe_and_predict", false]], "observe_and_predict() (triangle method)": [[120, "engforge.eng.geometry.Triangle.observe_and_predict", false]], "options() (in module engforge.typing)": [[257, "engforge.typing.Options", false]], "output_state (problem property)": [[188, "engforge.problem_context.Problem.output_state", false]], "output_state (problemexec property)": [[189, "engforge.problem_context.ProblemExec.output_state", false]], "oxygen (class in engforge.eng.fluid_material)": [[108, "engforge.eng.fluid_material.Oxygen", false]], "parametricspline (class in engforge.eng.geometry)": [[116, "engforge.eng.geometry.ParametricSpline", false]], "parent_configurations_cls() (air class method)": [[97, "engforge.eng.fluid_material.Air.parent_configurations_cls", false]], "parent_configurations_cls() (airwatermix class method)": [[98, "engforge.eng.fluid_material.AirWaterMix.parent_configurations_cls", false]], "parent_configurations_cls() (aluminum class method)": [[139, "engforge.eng.solid_materials.Aluminum.parent_configurations_cls", false]], "parent_configurations_cls() (analysis class method)": [[2, "engforge.analysis.Analysis.parent_configurations_cls", false]], "parent_configurations_cls() (ansi_4130 class method)": [[137, "engforge.eng.solid_materials.ANSI_4130.parent_configurations_cls", false]], "parent_configurations_cls() (ansi_4340 class method)": [[138, "engforge.eng.solid_materials.ANSI_4340.parent_configurations_cls", false]], "parent_configurations_cls() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.parent_configurations_cls", false]], "parent_configurations_cls() (carbonfiber class method)": [[140, "engforge.eng.solid_materials.CarbonFiber.parent_configurations_cls", false]], "parent_configurations_cls() (circle class method)": [[113, "engforge.eng.geometry.Circle.parent_configurations_cls", false]], "parent_configurations_cls() (component class method)": [[48, "engforge.components.Component.parent_configurations_cls", false]], "parent_configurations_cls() (componentdict class method)": [[42, "engforge.component_collections.ComponentDict.parent_configurations_cls", false]], "parent_configurations_cls() (componentiter class method)": [[43, "engforge.component_collections.ComponentIter.parent_configurations_cls", false]], "parent_configurations_cls() (componentiterator class method)": [[44, "engforge.component_collections.ComponentIterator.parent_configurations_cls", false]], "parent_configurations_cls() (concrete class method)": [[141, "engforge.eng.solid_materials.Concrete.parent_configurations_cls", false]], "parent_configurations_cls() (configuration class method)": [[52, "engforge.configuration.Configuration.parent_configurations_cls", false]], "parent_configurations_cls() (coolpropmaterial class method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.parent_configurations_cls", false]], "parent_configurations_cls() (coolpropmixture class method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.parent_configurations_cls", false]], "parent_configurations_cls() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.parent_configurations_cls", false]], "parent_configurations_cls() (drysoil class method)": [[142, "engforge.eng.solid_materials.DrySoil.parent_configurations_cls", false]], "parent_configurations_cls() (dynamicsmixin class method)": [[84, "engforge.dynamics.DynamicsMixin.parent_configurations_cls", false]], "parent_configurations_cls() (economics class method)": [[92, "engforge.eng.costs.Economics.parent_configurations_cls", false]], "parent_configurations_cls() (flowinput class method)": [[125, "engforge.eng.pipes.FlowInput.parent_configurations_cls", false]], "parent_configurations_cls() (flownode class method)": [[126, "engforge.eng.pipes.FlowNode.parent_configurations_cls", false]], "parent_configurations_cls() (fluidmaterial class method)": [[101, "engforge.eng.fluid_material.FluidMaterial.parent_configurations_cls", false]], "parent_configurations_cls() (globaldynamics class method)": [[85, "engforge.dynamics.GlobalDynamics.parent_configurations_cls", false]], "parent_configurations_cls() (hollowcircle class method)": [[115, "engforge.eng.geometry.HollowCircle.parent_configurations_cls", false]], "parent_configurations_cls() (hydrogen class method)": [[102, "engforge.eng.fluid_material.Hydrogen.parent_configurations_cls", false]], "parent_configurations_cls() (idealair class method)": [[103, "engforge.eng.fluid_material.IdealAir.parent_configurations_cls", false]], "parent_configurations_cls() (idealgas class method)": [[104, "engforge.eng.fluid_material.IdealGas.parent_configurations_cls", false]], "parent_configurations_cls() (idealh2 class method)": [[105, "engforge.eng.fluid_material.IdealH2.parent_configurations_cls", false]], "parent_configurations_cls() (idealoxygen class method)": [[106, "engforge.eng.fluid_material.IdealOxygen.parent_configurations_cls", false]], "parent_configurations_cls() (idealsteam class method)": [[107, "engforge.eng.fluid_material.IdealSteam.parent_configurations_cls", false]], "parent_configurations_cls() (oxygen class method)": [[108, "engforge.eng.fluid_material.Oxygen.parent_configurations_cls", false]], "parent_configurations_cls() (pipe class method)": [[127, "engforge.eng.pipes.Pipe.parent_configurations_cls", false]], "parent_configurations_cls() (pipefitting class method)": [[128, "engforge.eng.pipes.PipeFitting.parent_configurations_cls", false]], "parent_configurations_cls() (pipeflow class method)": [[129, "engforge.eng.pipes.PipeFlow.parent_configurations_cls", false]], "parent_configurations_cls() (pipenode class method)": [[131, "engforge.eng.pipes.PipeNode.parent_configurations_cls", false]], "parent_configurations_cls() (pipesystem class method)": [[132, "engforge.eng.pipes.PipeSystem.parent_configurations_cls", false]], "parent_configurations_cls() (profile2d class method)": [[117, "engforge.eng.geometry.Profile2D.parent_configurations_cls", false]], "parent_configurations_cls() (pump class method)": [[133, "engforge.eng.pipes.Pump.parent_configurations_cls", false]], "parent_configurations_cls() (rectangle class method)": [[118, "engforge.eng.geometry.Rectangle.parent_configurations_cls", false]], "parent_configurations_cls() (rock class method)": [[143, "engforge.eng.solid_materials.Rock.parent_configurations_cls", false]], "parent_configurations_cls() (rubber class method)": [[144, "engforge.eng.solid_materials.Rubber.parent_configurations_cls", false]], "parent_configurations_cls() (seawater class method)": [[109, "engforge.eng.fluid_material.SeaWater.parent_configurations_cls", false]], "parent_configurations_cls() (shapelysection class method)": [[119, "engforge.eng.geometry.ShapelySection.parent_configurations_cls", false]], "parent_configurations_cls() (simplecompressor class method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.parent_configurations_cls", false]], "parent_configurations_cls() (simpleheatexchanger class method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.parent_configurations_cls", false]], "parent_configurations_cls() (simplepump class method)": [[156, "engforge.eng.thermodynamics.SimplePump.parent_configurations_cls", false]], "parent_configurations_cls() (simpleturbine class method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.parent_configurations_cls", false]], "parent_configurations_cls() (solidmaterial class method)": [[146, "engforge.eng.solid_materials.SolidMaterial.parent_configurations_cls", false]], "parent_configurations_cls() (solveableinterface class method)": [[49, "engforge.components.SolveableInterface.parent_configurations_cls", false]], "parent_configurations_cls() (ss_316 class method)": [[145, "engforge.eng.solid_materials.SS_316.parent_configurations_cls", false]], "parent_configurations_cls() (steam class method)": [[110, "engforge.eng.fluid_material.Steam.parent_configurations_cls", false]], "parent_configurations_cls() (system class method)": [[240, "engforge.system.System.parent_configurations_cls", false]], "parent_configurations_cls() (triangle class method)": [[120, "engforge.eng.geometry.Triangle.parent_configurations_cls", false]], "parent_configurations_cls() (water class method)": [[111, "engforge.eng.fluid_material.Water.parent_configurations_cls", false]], "parent_configurations_cls() (wetsoil class method)": [[147, "engforge.eng.solid_materials.WetSoil.parent_configurations_cls", false]], "parse_bool() (in module engforge.env_var)": [[169, "engforge.env_var.parse_bool", false]], "parse_default() (problem class method)": [[188, "engforge.problem_context.Problem.parse_default", false]], "parse_default() (problemexec class method)": [[189, "engforge.problem_context.ProblemExec.parse_default", false]], "parse_run_kwargs() (air method)": [[97, "engforge.eng.fluid_material.Air.parse_run_kwargs", false]], "parse_run_kwargs() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.parse_run_kwargs", false]], "parse_run_kwargs() (analysis method)": [[2, "engforge.analysis.Analysis.parse_run_kwargs", false]], "parse_run_kwargs() (beam method)": [[151, "engforge.eng.structure_beams.Beam.parse_run_kwargs", false]], "parse_run_kwargs() (component method)": [[48, "engforge.components.Component.parse_run_kwargs", false]], "parse_run_kwargs() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.parse_run_kwargs", false]], "parse_run_kwargs() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.parse_run_kwargs", false]], "parse_run_kwargs() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.parse_run_kwargs", false]], "parse_run_kwargs() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.parse_run_kwargs", false]], "parse_run_kwargs() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.parse_run_kwargs", false]], "parse_run_kwargs() (costmodel method)": [[91, "engforge.eng.costs.CostModel.parse_run_kwargs", false]], "parse_run_kwargs() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.parse_run_kwargs", false]], "parse_run_kwargs() (economics method)": [[92, "engforge.eng.costs.Economics.parse_run_kwargs", false]], "parse_run_kwargs() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.parse_run_kwargs", false]], "parse_run_kwargs() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.parse_run_kwargs", false]], "parse_run_kwargs() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.parse_run_kwargs", false]], "parse_run_kwargs() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.parse_run_kwargs", false]], "parse_run_kwargs() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.parse_run_kwargs", false]], "parse_run_kwargs() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.parse_run_kwargs", false]], "parse_run_kwargs() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.parse_run_kwargs", false]], "parse_run_kwargs() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.parse_run_kwargs", false]], "parse_run_kwargs() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.parse_run_kwargs", false]], "parse_run_kwargs() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.parse_run_kwargs", false]], "parse_run_kwargs() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.parse_run_kwargs", false]], "parse_run_kwargs() (pipe method)": [[127, "engforge.eng.pipes.Pipe.parse_run_kwargs", false]], "parse_run_kwargs() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.parse_run_kwargs", false]], "parse_run_kwargs() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.parse_run_kwargs", false]], "parse_run_kwargs() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.parse_run_kwargs", false]], "parse_run_kwargs() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.parse_run_kwargs", false]], "parse_run_kwargs() (pump method)": [[133, "engforge.eng.pipes.Pump.parse_run_kwargs", false]], "parse_run_kwargs() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.parse_run_kwargs", false]], "parse_run_kwargs() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.parse_run_kwargs", false]], "parse_run_kwargs() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.parse_run_kwargs", false]], "parse_run_kwargs() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.parse_run_kwargs", false]], "parse_run_kwargs() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.parse_run_kwargs", false]], "parse_run_kwargs() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.parse_run_kwargs", false]], "parse_run_kwargs() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.parse_run_kwargs", false]], "parse_run_kwargs() (solvermixin method)": [[222, "engforge.solver.SolverMixin.parse_run_kwargs", false]], "parse_run_kwargs() (steam method)": [[110, "engforge.eng.fluid_material.Steam.parse_run_kwargs", false]], "parse_run_kwargs() (system method)": [[240, "engforge.system.System.parse_run_kwargs", false]], "parse_run_kwargs() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.parse_run_kwargs", false]], "parse_run_kwargs() (water method)": [[111, "engforge.eng.fluid_material.Water.parse_run_kwargs", false]], "parse_simulation_input() (air method)": [[97, "engforge.eng.fluid_material.Air.parse_simulation_input", false]], "parse_simulation_input() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.parse_simulation_input", false]], "parse_simulation_input() (analysis method)": [[2, "engforge.analysis.Analysis.parse_simulation_input", false]], "parse_simulation_input() (beam method)": [[151, "engforge.eng.structure_beams.Beam.parse_simulation_input", false]], "parse_simulation_input() (component method)": [[48, "engforge.components.Component.parse_simulation_input", false]], "parse_simulation_input() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.parse_simulation_input", false]], "parse_simulation_input() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.parse_simulation_input", false]], "parse_simulation_input() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.parse_simulation_input", false]], "parse_simulation_input() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.parse_simulation_input", false]], "parse_simulation_input() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.parse_simulation_input", false]], "parse_simulation_input() (costmodel method)": [[91, "engforge.eng.costs.CostModel.parse_simulation_input", false]], "parse_simulation_input() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.parse_simulation_input", false]], "parse_simulation_input() (economics method)": [[92, "engforge.eng.costs.Economics.parse_simulation_input", false]], "parse_simulation_input() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.parse_simulation_input", false]], "parse_simulation_input() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.parse_simulation_input", false]], "parse_simulation_input() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.parse_simulation_input", false]], "parse_simulation_input() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.parse_simulation_input", false]], "parse_simulation_input() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.parse_simulation_input", false]], "parse_simulation_input() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.parse_simulation_input", false]], "parse_simulation_input() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.parse_simulation_input", false]], "parse_simulation_input() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.parse_simulation_input", false]], "parse_simulation_input() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.parse_simulation_input", false]], "parse_simulation_input() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.parse_simulation_input", false]], "parse_simulation_input() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.parse_simulation_input", false]], "parse_simulation_input() (pipe method)": [[127, "engforge.eng.pipes.Pipe.parse_simulation_input", false]], "parse_simulation_input() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.parse_simulation_input", false]], "parse_simulation_input() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.parse_simulation_input", false]], "parse_simulation_input() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.parse_simulation_input", false]], "parse_simulation_input() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.parse_simulation_input", false]], "parse_simulation_input() (pump method)": [[133, "engforge.eng.pipes.Pump.parse_simulation_input", false]], "parse_simulation_input() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.parse_simulation_input", false]], "parse_simulation_input() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.parse_simulation_input", false]], "parse_simulation_input() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.parse_simulation_input", false]], "parse_simulation_input() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.parse_simulation_input", false]], "parse_simulation_input() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.parse_simulation_input", false]], "parse_simulation_input() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.parse_simulation_input", false]], "parse_simulation_input() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.parse_simulation_input", false]], "parse_simulation_input() (solvermixin method)": [[222, "engforge.solver.SolverMixin.parse_simulation_input", false]], "parse_simulation_input() (steam method)": [[110, "engforge.eng.fluid_material.Steam.parse_simulation_input", false]], "parse_simulation_input() (system method)": [[240, "engforge.system.System.parse_simulation_input", false]], "parse_simulation_input() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.parse_simulation_input", false]], "parse_simulation_input() (water method)": [[111, "engforge.eng.fluid_material.Water.parse_simulation_input", false]], "path_exist_validator() (in module engforge.reporting)": [[216, "engforge.reporting.path_exist_validator", false]], "persist_contexts() (problem method)": [[188, "engforge.problem_context.Problem.persist_contexts", false]], "persist_contexts() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.persist_contexts", false]], "pipe (class in engforge.eng.pipes)": [[127, "engforge.eng.pipes.Pipe", false]], "pipefitting (class in engforge.eng.pipes)": [[128, "engforge.eng.pipes.PipeFitting", false]], "pipeflow (class in engforge.eng.pipes)": [[129, "engforge.eng.pipes.PipeFlow", false]], "pipelog (class in engforge.eng.pipes)": [[130, "engforge.eng.pipes.PipeLog", false]], "pipenode (class in engforge.eng.pipes)": [[131, "engforge.eng.pipes.PipeNode", false]], "pipesystem (class in engforge.eng.pipes)": [[132, "engforge.eng.pipes.PipeSystem", false]], "plot (class in engforge.attr_plotting)": [[9, "engforge.attr_plotting.Plot", false]], "plot() (plotinstance method)": [[11, "engforge.attr_plotting.PlotInstance.plot", false]], "plot() (traceinstance method)": [[15, "engforge.attr_plotting.TraceInstance.plot", false]], "plot_attributes() (air class method)": [[97, "engforge.eng.fluid_material.Air.plot_attributes", false]], "plot_attributes() (airwatermix class method)": [[98, "engforge.eng.fluid_material.AirWaterMix.plot_attributes", false]], "plot_attributes() (aluminum class method)": [[139, "engforge.eng.solid_materials.Aluminum.plot_attributes", false]], "plot_attributes() (analysis class method)": [[2, "engforge.analysis.Analysis.plot_attributes", false]], "plot_attributes() (ansi_4130 class method)": [[137, "engforge.eng.solid_materials.ANSI_4130.plot_attributes", false]], "plot_attributes() (ansi_4340 class method)": [[138, "engforge.eng.solid_materials.ANSI_4340.plot_attributes", false]], "plot_attributes() (attributedbasemixin class method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.plot_attributes", false]], "plot_attributes() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.plot_attributes", false]], "plot_attributes() (carbonfiber class method)": [[140, "engforge.eng.solid_materials.CarbonFiber.plot_attributes", false]], "plot_attributes() (circle class method)": [[113, "engforge.eng.geometry.Circle.plot_attributes", false]], "plot_attributes() (component class method)": [[48, "engforge.components.Component.plot_attributes", false]], "plot_attributes() (componentdict class method)": [[42, "engforge.component_collections.ComponentDict.plot_attributes", false]], "plot_attributes() (componentiter class method)": [[43, "engforge.component_collections.ComponentIter.plot_attributes", false]], "plot_attributes() (componentiterator class method)": [[44, "engforge.component_collections.ComponentIterator.plot_attributes", false]], "plot_attributes() (concrete class method)": [[141, "engforge.eng.solid_materials.Concrete.plot_attributes", false]], "plot_attributes() (configuration class method)": [[52, "engforge.configuration.Configuration.plot_attributes", false]], "plot_attributes() (coolpropmaterial class method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.plot_attributes", false]], "plot_attributes() (coolpropmixture class method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.plot_attributes", false]], "plot_attributes() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.plot_attributes", false]], "plot_attributes() (drysoil class method)": [[142, "engforge.eng.solid_materials.DrySoil.plot_attributes", false]], "plot_attributes() (dynamicsmixin class method)": [[84, "engforge.dynamics.DynamicsMixin.plot_attributes", false]], "plot_attributes() (economics class method)": [[92, "engforge.eng.costs.Economics.plot_attributes", false]], "plot_attributes() (flowinput class method)": [[125, "engforge.eng.pipes.FlowInput.plot_attributes", false]], "plot_attributes() (flownode class method)": [[126, "engforge.eng.pipes.FlowNode.plot_attributes", false]], "plot_attributes() (fluidmaterial class method)": [[101, "engforge.eng.fluid_material.FluidMaterial.plot_attributes", false]], "plot_attributes() (globaldynamics class method)": [[85, "engforge.dynamics.GlobalDynamics.plot_attributes", false]], "plot_attributes() (hollowcircle class method)": [[115, "engforge.eng.geometry.HollowCircle.plot_attributes", false]], "plot_attributes() (hydrogen class method)": [[102, "engforge.eng.fluid_material.Hydrogen.plot_attributes", false]], "plot_attributes() (idealair class method)": [[103, "engforge.eng.fluid_material.IdealAir.plot_attributes", false]], "plot_attributes() (idealgas class method)": [[104, "engforge.eng.fluid_material.IdealGas.plot_attributes", false]], "plot_attributes() (idealh2 class method)": [[105, "engforge.eng.fluid_material.IdealH2.plot_attributes", false]], "plot_attributes() (idealoxygen class method)": [[106, "engforge.eng.fluid_material.IdealOxygen.plot_attributes", false]], "plot_attributes() (idealsteam class method)": [[107, "engforge.eng.fluid_material.IdealSteam.plot_attributes", false]], "plot_attributes() (oxygen class method)": [[108, "engforge.eng.fluid_material.Oxygen.plot_attributes", false]], "plot_attributes() (pipe class method)": [[127, "engforge.eng.pipes.Pipe.plot_attributes", false]], "plot_attributes() (pipefitting class method)": [[128, "engforge.eng.pipes.PipeFitting.plot_attributes", false]], "plot_attributes() (pipeflow class method)": [[129, "engforge.eng.pipes.PipeFlow.plot_attributes", false]], "plot_attributes() (pipenode class method)": [[131, "engforge.eng.pipes.PipeNode.plot_attributes", false]], "plot_attributes() (pipesystem class method)": [[132, "engforge.eng.pipes.PipeSystem.plot_attributes", false]], "plot_attributes() (profile2d class method)": [[117, "engforge.eng.geometry.Profile2D.plot_attributes", false]], "plot_attributes() (pump class method)": [[133, "engforge.eng.pipes.Pump.plot_attributes", false]], "plot_attributes() (rectangle class method)": [[118, "engforge.eng.geometry.Rectangle.plot_attributes", false]], "plot_attributes() (rock class method)": [[143, "engforge.eng.solid_materials.Rock.plot_attributes", false]], "plot_attributes() (rubber class method)": [[144, "engforge.eng.solid_materials.Rubber.plot_attributes", false]], "plot_attributes() (seawater class method)": [[109, "engforge.eng.fluid_material.SeaWater.plot_attributes", false]], "plot_attributes() (shapelysection class method)": [[119, "engforge.eng.geometry.ShapelySection.plot_attributes", false]], "plot_attributes() (simplecompressor class method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.plot_attributes", false]], "plot_attributes() (simpleheatexchanger class method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.plot_attributes", false]], "plot_attributes() (simplepump class method)": [[156, "engforge.eng.thermodynamics.SimplePump.plot_attributes", false]], "plot_attributes() (simpleturbine class method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.plot_attributes", false]], "plot_attributes() (solidmaterial class method)": [[146, "engforge.eng.solid_materials.SolidMaterial.plot_attributes", false]], "plot_attributes() (solveableinterface class method)": [[49, "engforge.components.SolveableInterface.plot_attributes", false]], "plot_attributes() (solveablemixin class method)": [[219, "engforge.solveable.SolveableMixin.plot_attributes", false]], "plot_attributes() (solvermixin class method)": [[222, "engforge.solver.SolverMixin.plot_attributes", false]], "plot_attributes() (ss_316 class method)": [[145, "engforge.eng.solid_materials.SS_316.plot_attributes", false]], "plot_attributes() (steam class method)": [[110, "engforge.eng.fluid_material.Steam.plot_attributes", false]], "plot_attributes() (system class method)": [[240, "engforge.system.System.plot_attributes", false]], "plot_attributes() (tabulationmixin class method)": [[253, "engforge.tabulation.TabulationMixin.plot_attributes", false]], "plot_attributes() (triangle class method)": [[120, "engforge.eng.geometry.Triangle.plot_attributes", false]], "plot_attributes() (water class method)": [[111, "engforge.eng.fluid_material.Water.plot_attributes", false]], "plot_attributes() (wetsoil class method)": [[147, "engforge.eng.solid_materials.WetSoil.plot_attributes", false]], "plot_vars() (plot class method)": [[9, "engforge.attr_plotting.Plot.plot_vars", false]], "plot_vars() (plotbase class method)": [[10, "engforge.attr_plotting.PlotBase.plot_vars", false]], "plot_vars() (trace class method)": [[14, "engforge.attr_plotting.Trace.plot_vars", false]], "plotable_variables (air property)": [[97, "engforge.eng.fluid_material.Air.plotable_variables", false]], "plotable_variables (airwatermix property)": [[98, "engforge.eng.fluid_material.AirWaterMix.plotable_variables", false]], "plotable_variables (analysis property)": [[2, "engforge.analysis.Analysis.plotable_variables", false]], "plotable_variables (beam property)": [[151, "engforge.eng.structure_beams.Beam.plotable_variables", false]], "plotable_variables (component property)": [[48, "engforge.components.Component.plotable_variables", false]], "plotable_variables (componentdict property)": [[42, "engforge.component_collections.ComponentDict.plotable_variables", false]], "plotable_variables (componentiter property)": [[43, "engforge.component_collections.ComponentIter.plotable_variables", false]], "plotable_variables (componentiterator property)": [[44, "engforge.component_collections.ComponentIterator.plotable_variables", false]], "plotable_variables (coolpropmaterial property)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.plotable_variables", false]], "plotable_variables (coolpropmixture property)": [[100, "engforge.eng.fluid_material.CoolPropMixture.plotable_variables", false]], "plotable_variables (costmodel property)": [[91, "engforge.eng.costs.CostModel.plotable_variables", false]], "plotable_variables (economics property)": [[92, "engforge.eng.costs.Economics.plotable_variables", false]], "plotable_variables (flowinput property)": [[125, "engforge.eng.pipes.FlowInput.plotable_variables", false]], "plotable_variables (flownode property)": [[126, "engforge.eng.pipes.FlowNode.plotable_variables", false]], "plotable_variables (fluidmaterial property)": [[101, "engforge.eng.fluid_material.FluidMaterial.plotable_variables", false]], "plotable_variables (hydrogen property)": [[102, "engforge.eng.fluid_material.Hydrogen.plotable_variables", false]], "plotable_variables (idealair property)": [[103, "engforge.eng.fluid_material.IdealAir.plotable_variables", false]], "plotable_variables (idealgas property)": [[104, "engforge.eng.fluid_material.IdealGas.plotable_variables", false]], "plotable_variables (idealh2 property)": [[105, "engforge.eng.fluid_material.IdealH2.plotable_variables", false]], "plotable_variables (idealoxygen property)": [[106, "engforge.eng.fluid_material.IdealOxygen.plotable_variables", false]], "plotable_variables (idealsteam property)": [[107, "engforge.eng.fluid_material.IdealSteam.plotable_variables", false]], "plotable_variables (oxygen property)": [[108, "engforge.eng.fluid_material.Oxygen.plotable_variables", false]], "plotable_variables (pipe property)": [[127, "engforge.eng.pipes.Pipe.plotable_variables", false]], "plotable_variables (pipefitting property)": [[128, "engforge.eng.pipes.PipeFitting.plotable_variables", false]], "plotable_variables (pipeflow property)": [[129, "engforge.eng.pipes.PipeFlow.plotable_variables", false]], "plotable_variables (pipenode property)": [[131, "engforge.eng.pipes.PipeNode.plotable_variables", false]], "plotable_variables (pipesystem property)": [[132, "engforge.eng.pipes.PipeSystem.plotable_variables", false]], "plotable_variables (pump property)": [[133, "engforge.eng.pipes.Pump.plotable_variables", false]], "plotable_variables (seawater property)": [[109, "engforge.eng.fluid_material.SeaWater.plotable_variables", false]], "plotable_variables (simplecompressor property)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.plotable_variables", false]], "plotable_variables (simpleheatexchanger property)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.plotable_variables", false]], "plotable_variables (simplepump property)": [[156, "engforge.eng.thermodynamics.SimplePump.plotable_variables", false]], "plotable_variables (simpleturbine property)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.plotable_variables", false]], "plotable_variables (solveableinterface property)": [[49, "engforge.components.SolveableInterface.plotable_variables", false]], "plotable_variables (steam property)": [[110, "engforge.eng.fluid_material.Steam.plotable_variables", false]], "plotable_variables (system property)": [[240, "engforge.system.System.plotable_variables", false]], "plotable_variables (tabulationmixin property)": [[253, "engforge.tabulation.TabulationMixin.plotable_variables", false]], "plotable_variables (water property)": [[111, "engforge.eng.fluid_material.Water.plotable_variables", false]], "plotbase (class in engforge.attr_plotting)": [[10, "engforge.attr_plotting.PlotBase", false]], "plotinstance (class in engforge.attr_plotting)": [[11, "engforge.attr_plotting.PlotInstance", false]], "plotlog (class in engforge.attr_plotting)": [[12, "engforge.attr_plotting.PlotLog", false]], "plotreporter (class in engforge.reporting)": [[212, "engforge.reporting.PlotReporter", false]], "plottingmixin (class in engforge.attr_plotting)": [[13, "engforge.attr_plotting.PlottingMixin", false]], "pop() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.pop", false]], "pop() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.pop", false]], "popitem() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.popitem", false]], "pos_obj() (problem method)": [[188, "engforge.problem_context.Problem.pos_obj", false]], "pos_obj() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.pos_obj", false]], "post_execute() (problem method)": [[188, "engforge.problem_context.Problem.post_execute", false]], "post_execute() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.post_execute", false]], "post_process() (analysis method)": [[2, "engforge.analysis.Analysis.post_process", false]], "post_run_callback() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.post_run_callback", false]], "post_run_callback() (solvermixin method)": [[222, "engforge.solver.SolverMixin.post_run_callback", false]], "post_run_callback() (system method)": [[240, "engforge.system.System.post_run_callback", false]], "post_update() (air method)": [[97, "engforge.eng.fluid_material.Air.post_update", false]], "post_update() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.post_update", false]], "post_update() (analysis method)": [[2, "engforge.analysis.Analysis.post_update", false]], "post_update() (beam method)": [[151, "engforge.eng.structure_beams.Beam.post_update", false]], "post_update() (component method)": [[48, "engforge.components.Component.post_update", false]], "post_update() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.post_update", false]], "post_update() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.post_update", false]], "post_update() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.post_update", false]], "post_update() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.post_update", false]], "post_update() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.post_update", false]], "post_update() (costmodel method)": [[91, "engforge.eng.costs.CostModel.post_update", false]], "post_update() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.post_update", false]], "post_update() (economics method)": [[92, "engforge.eng.costs.Economics.post_update", false]], "post_update() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.post_update", false]], "post_update() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.post_update", false]], "post_update() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.post_update", false]], "post_update() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.post_update", false]], "post_update() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.post_update", false]], "post_update() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.post_update", false]], "post_update() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.post_update", false]], "post_update() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.post_update", false]], "post_update() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.post_update", false]], "post_update() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.post_update", false]], "post_update() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.post_update", false]], "post_update() (pipe method)": [[127, "engforge.eng.pipes.Pipe.post_update", false]], "post_update() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.post_update", false]], "post_update() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.post_update", false]], "post_update() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.post_update", false]], "post_update() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.post_update", false]], "post_update() (pump method)": [[133, "engforge.eng.pipes.Pump.post_update", false]], "post_update() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.post_update", false]], "post_update() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.post_update", false]], "post_update() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.post_update", false]], "post_update() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.post_update", false]], "post_update() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.post_update", false]], "post_update() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.post_update", false]], "post_update() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.post_update", false]], "post_update() (solvermixin method)": [[222, "engforge.solver.SolverMixin.post_update", false]], "post_update() (steam method)": [[110, "engforge.eng.fluid_material.Steam.post_update", false]], "post_update() (system method)": [[240, "engforge.system.System.post_update", false]], "post_update() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.post_update", false]], "post_update() (water method)": [[111, "engforge.eng.fluid_material.Water.post_update", false]], "post_update_system() (problem method)": [[188, "engforge.problem_context.Problem.post_update_system", false]], "post_update_system() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.post_update_system", false]], "power() (pump method)": [[133, "engforge.eng.pipes.Pump.power", false]], "pre_compile() (air class method)": [[97, "engforge.eng.fluid_material.Air.pre_compile", false]], "pre_compile() (airwatermix class method)": [[98, "engforge.eng.fluid_material.AirWaterMix.pre_compile", false]], "pre_compile() (aluminum class method)": [[139, "engforge.eng.solid_materials.Aluminum.pre_compile", false]], "pre_compile() (analysis class method)": [[2, "engforge.analysis.Analysis.pre_compile", false]], "pre_compile() (ansi_4130 class method)": [[137, "engforge.eng.solid_materials.ANSI_4130.pre_compile", false]], "pre_compile() (ansi_4340 class method)": [[138, "engforge.eng.solid_materials.ANSI_4340.pre_compile", false]], "pre_compile() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.pre_compile", false]], "pre_compile() (carbonfiber class method)": [[140, "engforge.eng.solid_materials.CarbonFiber.pre_compile", false]], "pre_compile() (circle class method)": [[113, "engforge.eng.geometry.Circle.pre_compile", false]], "pre_compile() (component class method)": [[48, "engforge.components.Component.pre_compile", false]], "pre_compile() (componentdict class method)": [[42, "engforge.component_collections.ComponentDict.pre_compile", false]], "pre_compile() (componentiter class method)": [[43, "engforge.component_collections.ComponentIter.pre_compile", false]], "pre_compile() (componentiterator class method)": [[44, "engforge.component_collections.ComponentIterator.pre_compile", false]], "pre_compile() (concrete class method)": [[141, "engforge.eng.solid_materials.Concrete.pre_compile", false]], "pre_compile() (configuration class method)": [[52, "engforge.configuration.Configuration.pre_compile", false]], "pre_compile() (coolpropmaterial class method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.pre_compile", false]], "pre_compile() (coolpropmixture class method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.pre_compile", false]], "pre_compile() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.pre_compile", false]], "pre_compile() (drysoil class method)": [[142, "engforge.eng.solid_materials.DrySoil.pre_compile", false]], "pre_compile() (dynamicsmixin class method)": [[84, "engforge.dynamics.DynamicsMixin.pre_compile", false]], "pre_compile() (economics class method)": [[92, "engforge.eng.costs.Economics.pre_compile", false]], "pre_compile() (flowinput class method)": [[125, "engforge.eng.pipes.FlowInput.pre_compile", false]], "pre_compile() (flownode class method)": [[126, "engforge.eng.pipes.FlowNode.pre_compile", false]], "pre_compile() (fluidmaterial class method)": [[101, "engforge.eng.fluid_material.FluidMaterial.pre_compile", false]], "pre_compile() (globaldynamics class method)": [[85, "engforge.dynamics.GlobalDynamics.pre_compile", false]], "pre_compile() (hollowcircle class method)": [[115, "engforge.eng.geometry.HollowCircle.pre_compile", false]], "pre_compile() (hydrogen class method)": [[102, "engforge.eng.fluid_material.Hydrogen.pre_compile", false]], "pre_compile() (idealair class method)": [[103, "engforge.eng.fluid_material.IdealAir.pre_compile", false]], "pre_compile() (idealgas class method)": [[104, "engforge.eng.fluid_material.IdealGas.pre_compile", false]], "pre_compile() (idealh2 class method)": [[105, "engforge.eng.fluid_material.IdealH2.pre_compile", false]], "pre_compile() (idealoxygen class method)": [[106, "engforge.eng.fluid_material.IdealOxygen.pre_compile", false]], "pre_compile() (idealsteam class method)": [[107, "engforge.eng.fluid_material.IdealSteam.pre_compile", false]], "pre_compile() (oxygen class method)": [[108, "engforge.eng.fluid_material.Oxygen.pre_compile", false]], "pre_compile() (pipe class method)": [[127, "engforge.eng.pipes.Pipe.pre_compile", false]], "pre_compile() (pipefitting class method)": [[128, "engforge.eng.pipes.PipeFitting.pre_compile", false]], "pre_compile() (pipeflow class method)": [[129, "engforge.eng.pipes.PipeFlow.pre_compile", false]], "pre_compile() (pipenode class method)": [[131, "engforge.eng.pipes.PipeNode.pre_compile", false]], "pre_compile() (pipesystem class method)": [[132, "engforge.eng.pipes.PipeSystem.pre_compile", false]], "pre_compile() (profile2d class method)": [[117, "engforge.eng.geometry.Profile2D.pre_compile", false]], "pre_compile() (pump class method)": [[133, "engforge.eng.pipes.Pump.pre_compile", false]], "pre_compile() (rectangle class method)": [[118, "engforge.eng.geometry.Rectangle.pre_compile", false]], "pre_compile() (rock class method)": [[143, "engforge.eng.solid_materials.Rock.pre_compile", false]], "pre_compile() (rubber class method)": [[144, "engforge.eng.solid_materials.Rubber.pre_compile", false]], "pre_compile() (seawater class method)": [[109, "engforge.eng.fluid_material.SeaWater.pre_compile", false]], "pre_compile() (shapelysection class method)": [[119, "engforge.eng.geometry.ShapelySection.pre_compile", false]], "pre_compile() (simplecompressor class method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.pre_compile", false]], "pre_compile() (simpleheatexchanger class method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.pre_compile", false]], "pre_compile() (simplepump class method)": [[156, "engforge.eng.thermodynamics.SimplePump.pre_compile", false]], "pre_compile() (simpleturbine class method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.pre_compile", false]], "pre_compile() (solidmaterial class method)": [[146, "engforge.eng.solid_materials.SolidMaterial.pre_compile", false]], "pre_compile() (solveableinterface class method)": [[49, "engforge.components.SolveableInterface.pre_compile", false]], "pre_compile() (ss_316 class method)": [[145, "engforge.eng.solid_materials.SS_316.pre_compile", false]], "pre_compile() (steam class method)": [[110, "engforge.eng.fluid_material.Steam.pre_compile", false]], "pre_compile() (system class method)": [[240, "engforge.system.System.pre_compile", false]], "pre_compile() (triangle class method)": [[120, "engforge.eng.geometry.Triangle.pre_compile", false]], "pre_compile() (water class method)": [[111, "engforge.eng.fluid_material.Water.pre_compile", false]], "pre_compile() (wetsoil class method)": [[147, "engforge.eng.solid_materials.WetSoil.pre_compile", false]], "pre_execute() (problem method)": [[188, "engforge.problem_context.Problem.pre_execute", false]], "pre_execute() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.pre_execute", false]], "pre_run_callback() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.pre_run_callback", false]], "pre_run_callback() (solvermixin method)": [[222, "engforge.solver.SolverMixin.pre_run_callback", false]], "pre_run_callback() (system method)": [[240, "engforge.system.System.pre_run_callback", false]], "predictionmixin (class in engforge.eng.prediction)": [[135, "engforge.eng.prediction.PredictionMixin", false]], "print_env_vars() (envvariable class method)": [[168, "engforge.env_var.EnvVariable.print_env_vars", false]], "problem (class in engforge.problem_context)": [[188, "engforge.problem_context.Problem", false]], "problem_opt_vars (problem property)": [[188, "engforge.problem_context.Problem.problem_opt_vars", false]], "problem_opt_vars (problemexec property)": [[189, "engforge.problem_context.ProblemExec.problem_opt_vars", false]], "problemexec (class in engforge.problem_context)": [[189, "engforge.problem_context.ProblemExec", false]], "problemexit": [[190, "engforge.problem_context.ProblemExit", false]], "problemexitatlevel": [[191, "engforge.problem_context.ProblemExitAtLevel", false]], "problog (class in engforge.problem_context)": [[187, "engforge.problem_context.ProbLog", false]], "profile2d (class in engforge.eng.geometry)": [[117, "engforge.eng.geometry.Profile2D", false]], "property_changed() (in module engforge.configuration)": [[58, "engforge.configuration.property_changed", false]], "propertylog (class in engforge.properties)": [[193, "engforge.properties.PropertyLog", false]], "pump (class in engforge.eng.pipes)": [[133, "engforge.eng.pipes.Pump", false]], "random_color() (in module engforge.eng.solid_materials)": [[149, "engforge.eng.solid_materials.random_color", false]], "rate() (air method)": [[97, "engforge.eng.fluid_material.Air.rate", false]], "rate() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.rate", false]], "rate() (beam method)": [[151, "engforge.eng.structure_beams.Beam.rate", false]], "rate() (component method)": [[48, "engforge.components.Component.rate", false]], "rate() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.rate", false]], "rate() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.rate", false]], "rate() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.rate", false]], "rate() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.rate", false]], "rate() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.rate", false]], "rate() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.rate", false]], "rate() (economics method)": [[92, "engforge.eng.costs.Economics.rate", false]], "rate() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.rate", false]], "rate() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.rate", false]], "rate() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.rate", false]], "rate() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.rate", false]], "rate() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.rate", false]], "rate() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.rate", false]], "rate() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.rate", false]], "rate() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.rate", false]], "rate() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.rate", false]], "rate() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.rate", false]], "rate() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.rate", false]], "rate() (pipe method)": [[127, "engforge.eng.pipes.Pipe.rate", false]], "rate() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.rate", false]], "rate() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.rate", false]], "rate() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.rate", false]], "rate() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.rate", false]], "rate() (pump method)": [[133, "engforge.eng.pipes.Pump.rate", false]], "rate() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.rate", false]], "rate() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.rate", false]], "rate() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.rate", false]], "rate() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.rate", false]], "rate() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.rate", false]], "rate() (steam method)": [[110, "engforge.eng.fluid_material.Steam.rate", false]], "rate() (system method)": [[240, "engforge.system.System.rate", false]], "rate() (water method)": [[111, "engforge.eng.fluid_material.Water.rate", false]], "rate_linear() (air method)": [[97, "engforge.eng.fluid_material.Air.rate_linear", false]], "rate_linear() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.rate_linear", false]], "rate_linear() (beam method)": [[151, "engforge.eng.structure_beams.Beam.rate_linear", false]], "rate_linear() (component method)": [[48, "engforge.components.Component.rate_linear", false]], "rate_linear() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.rate_linear", false]], "rate_linear() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.rate_linear", false]], "rate_linear() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.rate_linear", false]], "rate_linear() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.rate_linear", false]], "rate_linear() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.rate_linear", false]], "rate_linear() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.rate_linear", false]], "rate_linear() (economics method)": [[92, "engforge.eng.costs.Economics.rate_linear", false]], "rate_linear() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.rate_linear", false]], "rate_linear() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.rate_linear", false]], "rate_linear() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.rate_linear", false]], "rate_linear() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.rate_linear", false]], "rate_linear() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.rate_linear", false]], "rate_linear() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.rate_linear", false]], "rate_linear() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.rate_linear", false]], "rate_linear() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.rate_linear", false]], "rate_linear() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.rate_linear", false]], "rate_linear() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.rate_linear", false]], "rate_linear() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.rate_linear", false]], "rate_linear() (pipe method)": [[127, "engforge.eng.pipes.Pipe.rate_linear", false]], "rate_linear() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.rate_linear", false]], "rate_linear() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.rate_linear", false]], "rate_linear() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.rate_linear", false]], "rate_linear() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.rate_linear", false]], "rate_linear() (pump method)": [[133, "engforge.eng.pipes.Pump.rate_linear", false]], "rate_linear() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.rate_linear", false]], "rate_linear() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.rate_linear", false]], "rate_linear() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.rate_linear", false]], "rate_linear() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.rate_linear", false]], "rate_linear() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.rate_linear", false]], "rate_linear() (steam method)": [[110, "engforge.eng.fluid_material.Steam.rate_linear", false]], "rate_linear() (system method)": [[240, "engforge.system.System.rate_linear", false]], "rate_linear() (water method)": [[111, "engforge.eng.fluid_material.Water.rate_linear", false]], "rate_nonlinear() (air method)": [[97, "engforge.eng.fluid_material.Air.rate_nonlinear", false]], "rate_nonlinear() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.rate_nonlinear", false]], "rate_nonlinear() (beam method)": [[151, "engforge.eng.structure_beams.Beam.rate_nonlinear", false]], "rate_nonlinear() (component method)": [[48, "engforge.components.Component.rate_nonlinear", false]], "rate_nonlinear() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.rate_nonlinear", false]], "rate_nonlinear() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.rate_nonlinear", false]], "rate_nonlinear() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.rate_nonlinear", false]], "rate_nonlinear() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.rate_nonlinear", false]], "rate_nonlinear() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.rate_nonlinear", false]], "rate_nonlinear() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.rate_nonlinear", false]], "rate_nonlinear() (economics method)": [[92, "engforge.eng.costs.Economics.rate_nonlinear", false]], "rate_nonlinear() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.rate_nonlinear", false]], "rate_nonlinear() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.rate_nonlinear", false]], "rate_nonlinear() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.rate_nonlinear", false]], "rate_nonlinear() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.rate_nonlinear", false]], "rate_nonlinear() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.rate_nonlinear", false]], "rate_nonlinear() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.rate_nonlinear", false]], "rate_nonlinear() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.rate_nonlinear", false]], "rate_nonlinear() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.rate_nonlinear", false]], "rate_nonlinear() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.rate_nonlinear", false]], "rate_nonlinear() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.rate_nonlinear", false]], "rate_nonlinear() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.rate_nonlinear", false]], "rate_nonlinear() (pipe method)": [[127, "engforge.eng.pipes.Pipe.rate_nonlinear", false]], "rate_nonlinear() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.rate_nonlinear", false]], "rate_nonlinear() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.rate_nonlinear", false]], "rate_nonlinear() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.rate_nonlinear", false]], "rate_nonlinear() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.rate_nonlinear", false]], "rate_nonlinear() (pump method)": [[133, "engforge.eng.pipes.Pump.rate_nonlinear", false]], "rate_nonlinear() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.rate_nonlinear", false]], "rate_nonlinear() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.rate_nonlinear", false]], "rate_nonlinear() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.rate_nonlinear", false]], "rate_nonlinear() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.rate_nonlinear", false]], "rate_nonlinear() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.rate_nonlinear", false]], "rate_nonlinear() (steam method)": [[110, "engforge.eng.fluid_material.Steam.rate_nonlinear", false]], "rate_nonlinear() (system method)": [[240, "engforge.system.System.rate_nonlinear", false]], "rate_nonlinear() (water method)": [[111, "engforge.eng.fluid_material.Water.rate_nonlinear", false]], "rebuild_database() (dbconnection method)": [[72, "engforge.datastores.data.DBConnection.rebuild_database", false]], "record_state (problem property)": [[188, "engforge.problem_context.Problem.record_state", false]], "record_state (problemexec property)": [[189, "engforge.problem_context.ProblemExec.record_state", false]], "record_stress() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.record_stress", false]], "rectangle (class in engforge.eng.geometry)": [[118, "engforge.eng.geometry.Rectangle", false]], "ref (class in engforge.system_reference)": [[243, "engforge.system_reference.Ref", false]], "ref_dxdt() (air method)": [[97, "engforge.eng.fluid_material.Air.ref_dXdt", false]], "ref_dxdt() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.ref_dXdt", false]], "ref_dxdt() (beam method)": [[151, "engforge.eng.structure_beams.Beam.ref_dXdt", false]], "ref_dxdt() (component method)": [[48, "engforge.components.Component.ref_dXdt", false]], "ref_dxdt() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.ref_dXdt", false]], "ref_dxdt() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.ref_dXdt", false]], "ref_dxdt() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.ref_dXdt", false]], "ref_dxdt() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.ref_dXdt", false]], "ref_dxdt() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.ref_dXdt", false]], "ref_dxdt() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.ref_dXdt", false]], "ref_dxdt() (economics method)": [[92, "engforge.eng.costs.Economics.ref_dXdt", false]], "ref_dxdt() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.ref_dXdt", false]], "ref_dxdt() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.ref_dXdt", false]], "ref_dxdt() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.ref_dXdt", false]], "ref_dxdt() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.ref_dXdt", false]], "ref_dxdt() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.ref_dXdt", false]], "ref_dxdt() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.ref_dXdt", false]], "ref_dxdt() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.ref_dXdt", false]], "ref_dxdt() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.ref_dXdt", false]], "ref_dxdt() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.ref_dXdt", false]], "ref_dxdt() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.ref_dXdt", false]], "ref_dxdt() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.ref_dXdt", false]], "ref_dxdt() (pipe method)": [[127, "engforge.eng.pipes.Pipe.ref_dXdt", false]], "ref_dxdt() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.ref_dXdt", false]], "ref_dxdt() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.ref_dXdt", false]], "ref_dxdt() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.ref_dXdt", false]], "ref_dxdt() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.ref_dXdt", false]], "ref_dxdt() (pump method)": [[133, "engforge.eng.pipes.Pump.ref_dXdt", false]], "ref_dxdt() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.ref_dXdt", false]], "ref_dxdt() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.ref_dXdt", false]], "ref_dxdt() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.ref_dXdt", false]], "ref_dxdt() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.ref_dXdt", false]], "ref_dxdt() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.ref_dXdt", false]], "ref_dxdt() (steam method)": [[110, "engforge.eng.fluid_material.Steam.ref_dXdt", false]], "ref_dxdt() (system method)": [[240, "engforge.system.System.ref_dXdt", false]], "ref_dxdt() (water method)": [[111, "engforge.eng.fluid_material.Water.ref_dXdt", false]], "ref_to_val_constraint() (in module engforge.solver_utils)": [[235, "engforge.solver_utils.ref_to_val_constraint", false]], "reflog (class in engforge.system_reference)": [[244, "engforge.system_reference.RefLog", false]], "refmin_solve() (in module engforge.solver_utils)": [[236, "engforge.solver_utils.refmin_solve", false]], "refresh_references() (problem method)": [[188, "engforge.problem_context.Problem.refresh_references", false]], "refresh_references() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.refresh_references", false]], "refset_get() (in module engforge.system_reference)": [[248, "engforge.system_reference.refset_get", false]], "refset_input() (in module engforge.system_reference)": [[249, "engforge.system_reference.refset_input", false]], "refset_input() (ref method)": [[243, "engforge.system_reference.Ref.refset_input", false]], "remove() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.remove", false]], "remove() (envvariable method)": [[168, "engforge.env_var.EnvVariable.remove", false]], "report_root (csvreporter property)": [[206, "engforge.reporting.CSVReporter.report_root", false]], "report_root (diskplotreporter property)": [[207, "engforge.reporting.DiskPlotReporter.report_root", false]], "report_root (diskreportermixin property)": [[208, "engforge.reporting.DiskReporterMixin.report_root", false]], "report_root (excelreporter property)": [[209, "engforge.reporting.ExcelReporter.report_root", false]], "report_root (gdrivereporter property)": [[210, "engforge.reporting.GdriveReporter.report_root", false]], "report_root (gsheetsreporter property)": [[211, "engforge.reporting.GsheetsReporter.report_root", false]], "report_root (temporalreportermixin property)": [[215, "engforge.reporting.TemporalReporterMixin.report_root", false]], "reporter (class in engforge.reporting)": [[213, "engforge.reporting.Reporter", false]], "reset_contexts() (problem method)": [[188, "engforge.problem_context.Problem.reset_contexts", false]], "reset_contexts() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.reset_contexts", false]], "reset_data() (problem method)": [[188, "engforge.problem_context.Problem.reset_data", false]], "reset_data() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.reset_data", false]], "resetlog() (air method)": [[97, "engforge.eng.fluid_material.Air.resetLog", false]], "resetlog() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.resetLog", false]], "resetlog() (aluminum method)": [[139, "engforge.eng.solid_materials.Aluminum.resetLog", false]], "resetlog() (analysis method)": [[2, "engforge.analysis.Analysis.resetLog", false]], "resetlog() (ansi_4130 method)": [[137, "engforge.eng.solid_materials.ANSI_4130.resetLog", false]], "resetlog() (ansi_4340 method)": [[138, "engforge.eng.solid_materials.ANSI_4340.resetLog", false]], "resetlog() (attributedbasemixin method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.resetLog", false]], "resetlog() (attrlog method)": [[32, "engforge.attributes.ATTRLog.resetLog", false]], "resetlog() (attrsolverlog method)": [[28, "engforge.attr_solver.AttrSolverLog.resetLog", false]], "resetlog() (beam method)": [[151, "engforge.eng.structure_beams.Beam.resetLog", false]], "resetlog() (carbonfiber method)": [[140, "engforge.eng.solid_materials.CarbonFiber.resetLog", false]], "resetlog() (circle method)": [[113, "engforge.eng.geometry.Circle.resetLog", false]], "resetlog() (component method)": [[48, "engforge.components.Component.resetLog", false]], "resetlog() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.resetLog", false]], "resetlog() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.resetLog", false]], "resetlog() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.resetLog", false]], "resetlog() (concrete method)": [[141, "engforge.eng.solid_materials.Concrete.resetLog", false]], "resetlog() (configlog method)": [[51, "engforge.configuration.ConfigLog.resetLog", false]], "resetlog() (configuration method)": [[52, "engforge.configuration.Configuration.resetLog", false]], "resetlog() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.resetLog", false]], "resetlog() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.resetLog", false]], "resetlog() (costlog method)": [[90, "engforge.eng.costs.CostLog.resetLog", false]], "resetlog() (costmodel method)": [[91, "engforge.eng.costs.CostModel.resetLog", false]], "resetlog() (csvreporter method)": [[206, "engforge.reporting.CSVReporter.resetLog", false]], "resetlog() (dataframelog method)": [[61, "engforge.dataframe.DataFrameLog.resetLog", false]], "resetlog() (dbconnection method)": [[72, "engforge.datastores.data.DBConnection.resetLog", false]], "resetlog() (diskcachestore method)": [[73, "engforge.datastores.data.DiskCacheStore.resetLog", false]], "resetlog() (diskplotreporter method)": [[207, "engforge.reporting.DiskPlotReporter.resetLog", false]], "resetlog() (diskreportermixin method)": [[208, "engforge.reporting.DiskReporterMixin.resetLog", false]], "resetlog() (drysoil method)": [[142, "engforge.eng.solid_materials.DrySoil.resetLog", false]], "resetlog() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.resetLog", false]], "resetlog() (economics method)": [[92, "engforge.eng.costs.Economics.resetLog", false]], "resetlog() (engattr method)": [[165, "engforge.engforge_attributes.EngAttr.resetLog", false]], "resetlog() (envvariable method)": [[168, "engforge.env_var.EnvVariable.resetLog", false]], "resetlog() (excelreporter method)": [[209, "engforge.reporting.ExcelReporter.resetLog", false]], "resetlog() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.resetLog", false]], "resetlog() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.resetLog", false]], "resetlog() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.resetLog", false]], "resetlog() (forgelog method)": [[36, "engforge.common.ForgeLog.resetLog", false]], "resetlog() (gdrivereporter method)": [[210, "engforge.reporting.GdriveReporter.resetLog", false]], "resetlog() (geometrylog method)": [[114, "engforge.eng.geometry.GeometryLog.resetLog", false]], "resetlog() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.resetLog", false]], "resetlog() (gsheetsreporter method)": [[211, "engforge.reporting.GsheetsReporter.resetLog", false]], "resetlog() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.resetLog", false]], "resetlog() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.resetLog", false]], "resetlog() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.resetLog", false]], "resetlog() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.resetLog", false]], "resetlog() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.resetLog", false]], "resetlog() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.resetLog", false]], "resetlog() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.resetLog", false]], "resetlog() (log method)": [[173, "engforge.logging.Log.resetLog", false]], "resetlog() (loggingmixin method)": [[174, "engforge.logging.LoggingMixin.resetLog", false]], "resetlog() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.resetLog", false]], "resetlog() (pipe method)": [[127, "engforge.eng.pipes.Pipe.resetLog", false]], "resetlog() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.resetLog", false]], "resetlog() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.resetLog", false]], "resetlog() (pipelog method)": [[130, "engforge.eng.pipes.PipeLog.resetLog", false]], "resetlog() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.resetLog", false]], "resetlog() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.resetLog", false]], "resetlog() (plotlog method)": [[12, "engforge.attr_plotting.PlotLog.resetLog", false]], "resetlog() (plotreporter method)": [[212, "engforge.reporting.PlotReporter.resetLog", false]], "resetlog() (problog method)": [[187, "engforge.problem_context.ProbLog.resetLog", false]], "resetlog() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.resetLog", false]], "resetlog() (propertylog method)": [[193, "engforge.properties.PropertyLog.resetLog", false]], "resetlog() (pump method)": [[133, "engforge.eng.pipes.Pump.resetLog", false]], "resetlog() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.resetLog", false]], "resetlog() (reflog method)": [[244, "engforge.system_reference.RefLog.resetLog", false]], "resetlog() (reporter method)": [[213, "engforge.reporting.Reporter.resetLog", false]], "resetlog() (rock method)": [[143, "engforge.eng.solid_materials.Rock.resetLog", false]], "resetlog() (rubber method)": [[144, "engforge.eng.solid_materials.Rubber.resetLog", false]], "resetlog() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.resetLog", false]], "resetlog() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.resetLog", false]], "resetlog() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.resetLog", false]], "resetlog() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.resetLog", false]], "resetlog() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.resetLog", false]], "resetlog() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.resetLog", false]], "resetlog() (slotlog method)": [[26, "engforge.attr_slots.SlotLog.resetLog", false]], "resetlog() (solidmaterial method)": [[146, "engforge.eng.solid_materials.SolidMaterial.resetLog", false]], "resetlog() (solvablelog method)": [[218, "engforge.solveable.SolvableLog.resetLog", false]], "resetlog() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.resetLog", false]], "resetlog() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.resetLog", false]], "resetlog() (solverlog method)": [[221, "engforge.solver.SolverLog.resetLog", false]], "resetlog() (solvermixin method)": [[222, "engforge.solver.SolverMixin.resetLog", false]], "resetlog() (solverutillog method)": [[224, "engforge.solver_utils.SolverUtilLog.resetLog", false]], "resetlog() (ss_316 method)": [[145, "engforge.eng.solid_materials.SS_316.resetLog", false]], "resetlog() (steam method)": [[110, "engforge.eng.fluid_material.Steam.resetLog", false]], "resetlog() (system method)": [[240, "engforge.system.System.resetLog", false]], "resetlog() (systemslog method)": [[241, "engforge.system.SystemsLog.resetLog", false]], "resetlog() (tablelog method)": [[252, "engforge.tabulation.TableLog.resetLog", false]], "resetlog() (tablereporter method)": [[214, "engforge.reporting.TableReporter.resetLog", false]], "resetlog() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.resetLog", false]], "resetlog() (temporalreportermixin method)": [[215, "engforge.reporting.TemporalReporterMixin.resetLog", false]], "resetlog() (triangle method)": [[120, "engforge.eng.geometry.Triangle.resetLog", false]], "resetlog() (water method)": [[111, "engforge.eng.fluid_material.Water.resetLog", false]], "resetlog() (wetsoil method)": [[147, "engforge.eng.solid_materials.WetSoil.resetLog", false]], "resetsystemlogs() (air method)": [[97, "engforge.eng.fluid_material.Air.resetSystemLogs", false]], "resetsystemlogs() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.resetSystemLogs", false]], "resetsystemlogs() (aluminum method)": [[139, "engforge.eng.solid_materials.Aluminum.resetSystemLogs", false]], "resetsystemlogs() (analysis method)": [[2, "engforge.analysis.Analysis.resetSystemLogs", false]], "resetsystemlogs() (ansi_4130 method)": [[137, "engforge.eng.solid_materials.ANSI_4130.resetSystemLogs", false]], "resetsystemlogs() (ansi_4340 method)": [[138, "engforge.eng.solid_materials.ANSI_4340.resetSystemLogs", false]], "resetsystemlogs() (attributedbasemixin method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.resetSystemLogs", false]], "resetsystemlogs() (attrlog method)": [[32, "engforge.attributes.ATTRLog.resetSystemLogs", false]], "resetsystemlogs() (attrsolverlog method)": [[28, "engforge.attr_solver.AttrSolverLog.resetSystemLogs", false]], "resetsystemlogs() (beam method)": [[151, "engforge.eng.structure_beams.Beam.resetSystemLogs", false]], "resetsystemlogs() (carbonfiber method)": [[140, "engforge.eng.solid_materials.CarbonFiber.resetSystemLogs", false]], "resetsystemlogs() (circle method)": [[113, "engforge.eng.geometry.Circle.resetSystemLogs", false]], "resetsystemlogs() (component method)": [[48, "engforge.components.Component.resetSystemLogs", false]], "resetsystemlogs() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.resetSystemLogs", false]], "resetsystemlogs() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.resetSystemLogs", false]], "resetsystemlogs() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.resetSystemLogs", false]], "resetsystemlogs() (concrete method)": [[141, "engforge.eng.solid_materials.Concrete.resetSystemLogs", false]], "resetsystemlogs() (configlog method)": [[51, "engforge.configuration.ConfigLog.resetSystemLogs", false]], "resetsystemlogs() (configuration method)": [[52, "engforge.configuration.Configuration.resetSystemLogs", false]], "resetsystemlogs() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.resetSystemLogs", false]], "resetsystemlogs() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.resetSystemLogs", false]], "resetsystemlogs() (costlog method)": [[90, "engforge.eng.costs.CostLog.resetSystemLogs", false]], "resetsystemlogs() (costmodel method)": [[91, "engforge.eng.costs.CostModel.resetSystemLogs", false]], "resetsystemlogs() (csvreporter method)": [[206, "engforge.reporting.CSVReporter.resetSystemLogs", false]], "resetsystemlogs() (dataframelog method)": [[61, "engforge.dataframe.DataFrameLog.resetSystemLogs", false]], "resetsystemlogs() (dbconnection method)": [[72, "engforge.datastores.data.DBConnection.resetSystemLogs", false]], "resetsystemlogs() (diskcachestore method)": [[73, "engforge.datastores.data.DiskCacheStore.resetSystemLogs", false]], "resetsystemlogs() (diskplotreporter method)": [[207, "engforge.reporting.DiskPlotReporter.resetSystemLogs", false]], "resetsystemlogs() (diskreportermixin method)": [[208, "engforge.reporting.DiskReporterMixin.resetSystemLogs", false]], "resetsystemlogs() (drysoil method)": [[142, "engforge.eng.solid_materials.DrySoil.resetSystemLogs", false]], "resetsystemlogs() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.resetSystemLogs", false]], "resetsystemlogs() (economics method)": [[92, "engforge.eng.costs.Economics.resetSystemLogs", false]], "resetsystemlogs() (engattr method)": [[165, "engforge.engforge_attributes.EngAttr.resetSystemLogs", false]], "resetsystemlogs() (envvariable method)": [[168, "engforge.env_var.EnvVariable.resetSystemLogs", false]], "resetsystemlogs() (excelreporter method)": [[209, "engforge.reporting.ExcelReporter.resetSystemLogs", false]], "resetsystemlogs() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.resetSystemLogs", false]], "resetsystemlogs() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.resetSystemLogs", false]], "resetsystemlogs() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.resetSystemLogs", false]], "resetsystemlogs() (forgelog method)": [[36, "engforge.common.ForgeLog.resetSystemLogs", false]], "resetsystemlogs() (gdrivereporter method)": [[210, "engforge.reporting.GdriveReporter.resetSystemLogs", false]], "resetsystemlogs() (geometrylog method)": [[114, "engforge.eng.geometry.GeometryLog.resetSystemLogs", false]], "resetsystemlogs() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.resetSystemLogs", false]], "resetsystemlogs() (gsheetsreporter method)": [[211, "engforge.reporting.GsheetsReporter.resetSystemLogs", false]], "resetsystemlogs() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.resetSystemLogs", false]], "resetsystemlogs() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.resetSystemLogs", false]], "resetsystemlogs() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.resetSystemLogs", false]], "resetsystemlogs() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.resetSystemLogs", false]], "resetsystemlogs() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.resetSystemLogs", false]], "resetsystemlogs() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.resetSystemLogs", false]], "resetsystemlogs() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.resetSystemLogs", false]], "resetsystemlogs() (log method)": [[173, "engforge.logging.Log.resetSystemLogs", false]], "resetsystemlogs() (loggingmixin method)": [[174, "engforge.logging.LoggingMixin.resetSystemLogs", false]], "resetsystemlogs() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.resetSystemLogs", false]], "resetsystemlogs() (pipe method)": [[127, "engforge.eng.pipes.Pipe.resetSystemLogs", false]], "resetsystemlogs() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.resetSystemLogs", false]], "resetsystemlogs() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.resetSystemLogs", false]], "resetsystemlogs() (pipelog method)": [[130, "engforge.eng.pipes.PipeLog.resetSystemLogs", false]], "resetsystemlogs() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.resetSystemLogs", false]], "resetsystemlogs() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.resetSystemLogs", false]], "resetsystemlogs() (plotlog method)": [[12, "engforge.attr_plotting.PlotLog.resetSystemLogs", false]], "resetsystemlogs() (plotreporter method)": [[212, "engforge.reporting.PlotReporter.resetSystemLogs", false]], "resetsystemlogs() (problog method)": [[187, "engforge.problem_context.ProbLog.resetSystemLogs", false]], "resetsystemlogs() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.resetSystemLogs", false]], "resetsystemlogs() (propertylog method)": [[193, "engforge.properties.PropertyLog.resetSystemLogs", false]], "resetsystemlogs() (pump method)": [[133, "engforge.eng.pipes.Pump.resetSystemLogs", false]], "resetsystemlogs() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.resetSystemLogs", false]], "resetsystemlogs() (reflog method)": [[244, "engforge.system_reference.RefLog.resetSystemLogs", false]], "resetsystemlogs() (reporter method)": [[213, "engforge.reporting.Reporter.resetSystemLogs", false]], "resetsystemlogs() (rock method)": [[143, "engforge.eng.solid_materials.Rock.resetSystemLogs", false]], "resetsystemlogs() (rubber method)": [[144, "engforge.eng.solid_materials.Rubber.resetSystemLogs", false]], "resetsystemlogs() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.resetSystemLogs", false]], "resetsystemlogs() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.resetSystemLogs", false]], "resetsystemlogs() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.resetSystemLogs", false]], "resetsystemlogs() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.resetSystemLogs", false]], "resetsystemlogs() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.resetSystemLogs", false]], "resetsystemlogs() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.resetSystemLogs", false]], "resetsystemlogs() (slotlog method)": [[26, "engforge.attr_slots.SlotLog.resetSystemLogs", false]], "resetsystemlogs() (solidmaterial method)": [[146, "engforge.eng.solid_materials.SolidMaterial.resetSystemLogs", false]], "resetsystemlogs() (solvablelog method)": [[218, "engforge.solveable.SolvableLog.resetSystemLogs", false]], "resetsystemlogs() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.resetSystemLogs", false]], "resetsystemlogs() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.resetSystemLogs", false]], "resetsystemlogs() (solverlog method)": [[221, "engforge.solver.SolverLog.resetSystemLogs", false]], "resetsystemlogs() (solvermixin method)": [[222, "engforge.solver.SolverMixin.resetSystemLogs", false]], "resetsystemlogs() (solverutillog method)": [[224, "engforge.solver_utils.SolverUtilLog.resetSystemLogs", false]], "resetsystemlogs() (ss_316 method)": [[145, "engforge.eng.solid_materials.SS_316.resetSystemLogs", false]], "resetsystemlogs() (steam method)": [[110, "engforge.eng.fluid_material.Steam.resetSystemLogs", false]], "resetsystemlogs() (system method)": [[240, "engforge.system.System.resetSystemLogs", false]], "resetsystemlogs() (systemslog method)": [[241, "engforge.system.SystemsLog.resetSystemLogs", false]], "resetsystemlogs() (tablelog method)": [[252, "engforge.tabulation.TableLog.resetSystemLogs", false]], "resetsystemlogs() (tablereporter method)": [[214, "engforge.reporting.TableReporter.resetSystemLogs", false]], "resetsystemlogs() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.resetSystemLogs", false]], "resetsystemlogs() (temporalreportermixin method)": [[215, "engforge.reporting.TemporalReporterMixin.resetSystemLogs", false]], "resetsystemlogs() (triangle method)": [[120, "engforge.eng.geometry.Triangle.resetSystemLogs", false]], "resetsystemlogs() (water method)": [[111, "engforge.eng.fluid_material.Water.resetSystemLogs", false]], "resetsystemlogs() (wetsoil method)": [[147, "engforge.eng.solid_materials.WetSoil.resetSystemLogs", false]], "reverse() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.reverse", false]], "rock (class in engforge.eng.solid_materials)": [[143, "engforge.eng.solid_materials.Rock", false]], "rotation_matrix_from_vectors() (in module engforge.eng.structure_beams)": [[152, "engforge.eng.structure_beams.rotation_matrix_from_vectors", false]], "rubber (class in engforge.eng.solid_materials)": [[144, "engforge.eng.solid_materials.Rubber", false]], "run() (analysis method)": [[2, "engforge.analysis.Analysis.run", false]], "run() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.run", false]], "run() (solvermixin method)": [[222, "engforge.solver.SolverMixin.run", false]], "run() (system method)": [[240, "engforge.system.System.run", false]], "run_internal_systems() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.run_internal_systems", false]], "run_internal_systems() (solvermixin method)": [[222, "engforge.solver.SolverMixin.run_internal_systems", false]], "run_internal_systems() (system method)": [[240, "engforge.system.System.run_internal_systems", false]], "save_all_figures_to_pdf() (in module engforge.attr_plotting)": [[20, "engforge.attr_plotting.save_all_figures_to_pdf", false]], "save_data() (problem method)": [[188, "engforge.problem_context.Problem.save_data", false]], "save_data() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.save_data", false]], "scale_val() (in module engforge.system_reference)": [[250, "engforge.system_reference.scale_val", false]], "score_data() (circle method)": [[113, "engforge.eng.geometry.Circle.score_data", false]], "score_data() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.score_data", false]], "score_data() (predictionmixin method)": [[135, "engforge.eng.prediction.PredictionMixin.score_data", false]], "score_data() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.score_data", false]], "score_data() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.score_data", false]], "score_data() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.score_data", false]], "score_data() (triangle method)": [[120, "engforge.eng.geometry.Triangle.score_data", false]], "seawater (class in engforge.eng.fluid_material)": [[109, "engforge.eng.fluid_material.SeaWater", false]], "secondary_obj() (in module engforge.solver_utils)": [[237, "engforge.solver_utils.secondary_obj", false]], "sesh (problem property)": [[188, "engforge.problem_context.Problem.sesh", false]], "sesh (problemexec property)": [[189, "engforge.problem_context.ProblemExec.sesh", false]], "session_scope() (dbconnection method)": [[72, "engforge.datastores.data.DBConnection.session_scope", false]], "set() (diskcachestore method)": [[73, "engforge.datastores.data.DiskCacheStore.set", false]], "set_checkpoint() (problem method)": [[188, "engforge.problem_context.Problem.set_checkpoint", false]], "set_checkpoint() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.set_checkpoint", false]], "set_default_costs() (beam method)": [[151, "engforge.eng.structure_beams.Beam.set_default_costs", false]], "set_default_costs() (costmodel method)": [[91, "engforge.eng.costs.CostModel.set_default_costs", false]], "set_ref_values() (problem method)": [[188, "engforge.problem_context.Problem.set_ref_values", false]], "set_ref_values() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.set_ref_values", false]], "set_time() (air method)": [[97, "engforge.eng.fluid_material.Air.set_time", false]], "set_time() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.set_time", false]], "set_time() (beam method)": [[151, "engforge.eng.structure_beams.Beam.set_time", false]], "set_time() (component method)": [[48, "engforge.components.Component.set_time", false]], "set_time() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.set_time", false]], "set_time() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.set_time", false]], "set_time() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.set_time", false]], "set_time() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.set_time", false]], "set_time() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.set_time", false]], "set_time() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.set_time", false]], "set_time() (economics method)": [[92, "engforge.eng.costs.Economics.set_time", false]], "set_time() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.set_time", false]], "set_time() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.set_time", false]], "set_time() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.set_time", false]], "set_time() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.set_time", false]], "set_time() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.set_time", false]], "set_time() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.set_time", false]], "set_time() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.set_time", false]], "set_time() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.set_time", false]], "set_time() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.set_time", false]], "set_time() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.set_time", false]], "set_time() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.set_time", false]], "set_time() (pipe method)": [[127, "engforge.eng.pipes.Pipe.set_time", false]], "set_time() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.set_time", false]], "set_time() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.set_time", false]], "set_time() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.set_time", false]], "set_time() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.set_time", false]], "set_time() (pump method)": [[133, "engforge.eng.pipes.Pump.set_time", false]], "set_time() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.set_time", false]], "set_time() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.set_time", false]], "set_time() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.set_time", false]], "set_time() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.set_time", false]], "set_time() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.set_time", false]], "set_time() (steam method)": [[110, "engforge.eng.fluid_material.Steam.set_time", false]], "set_time() (system method)": [[240, "engforge.system.System.set_time", false]], "set_time() (water method)": [[111, "engforge.eng.fluid_material.Water.set_time", false]], "setattrs() (air method)": [[97, "engforge.eng.fluid_material.Air.setattrs", false]], "setattrs() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.setattrs", false]], "setattrs() (aluminum method)": [[139, "engforge.eng.solid_materials.Aluminum.setattrs", false]], "setattrs() (analysis method)": [[2, "engforge.analysis.Analysis.setattrs", false]], "setattrs() (ansi_4130 method)": [[137, "engforge.eng.solid_materials.ANSI_4130.setattrs", false]], "setattrs() (ansi_4340 method)": [[138, "engforge.eng.solid_materials.ANSI_4340.setattrs", false]], "setattrs() (attributedbasemixin method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.setattrs", false]], "setattrs() (beam method)": [[151, "engforge.eng.structure_beams.Beam.setattrs", false]], "setattrs() (carbonfiber method)": [[140, "engforge.eng.solid_materials.CarbonFiber.setattrs", false]], "setattrs() (circle method)": [[113, "engforge.eng.geometry.Circle.setattrs", false]], "setattrs() (component method)": [[48, "engforge.components.Component.setattrs", false]], "setattrs() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.setattrs", false]], "setattrs() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.setattrs", false]], "setattrs() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.setattrs", false]], "setattrs() (concrete method)": [[141, "engforge.eng.solid_materials.Concrete.setattrs", false]], "setattrs() (configuration method)": [[52, "engforge.configuration.Configuration.setattrs", false]], "setattrs() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.setattrs", false]], "setattrs() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.setattrs", false]], "setattrs() (costmodel method)": [[91, "engforge.eng.costs.CostModel.setattrs", false]], "setattrs() (drysoil method)": [[142, "engforge.eng.solid_materials.DrySoil.setattrs", false]], "setattrs() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.setattrs", false]], "setattrs() (economics method)": [[92, "engforge.eng.costs.Economics.setattrs", false]], "setattrs() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.setattrs", false]], "setattrs() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.setattrs", false]], "setattrs() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.setattrs", false]], "setattrs() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.setattrs", false]], "setattrs() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.setattrs", false]], "setattrs() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.setattrs", false]], "setattrs() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.setattrs", false]], "setattrs() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.setattrs", false]], "setattrs() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.setattrs", false]], "setattrs() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.setattrs", false]], "setattrs() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.setattrs", false]], "setattrs() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.setattrs", false]], "setattrs() (pipe method)": [[127, "engforge.eng.pipes.Pipe.setattrs", false]], "setattrs() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.setattrs", false]], "setattrs() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.setattrs", false]], "setattrs() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.setattrs", false]], "setattrs() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.setattrs", false]], "setattrs() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.setattrs", false]], "setattrs() (pump method)": [[133, "engforge.eng.pipes.Pump.setattrs", false]], "setattrs() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.setattrs", false]], "setattrs() (rock method)": [[143, "engforge.eng.solid_materials.Rock.setattrs", false]], "setattrs() (rubber method)": [[144, "engforge.eng.solid_materials.Rubber.setattrs", false]], "setattrs() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.setattrs", false]], "setattrs() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.setattrs", false]], "setattrs() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.setattrs", false]], "setattrs() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.setattrs", false]], "setattrs() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.setattrs", false]], "setattrs() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.setattrs", false]], "setattrs() (solidmaterial method)": [[146, "engforge.eng.solid_materials.SolidMaterial.setattrs", false]], "setattrs() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.setattrs", false]], "setattrs() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.setattrs", false]], "setattrs() (solvermixin method)": [[222, "engforge.solver.SolverMixin.setattrs", false]], "setattrs() (ss_316 method)": [[145, "engforge.eng.solid_materials.SS_316.setattrs", false]], "setattrs() (steam method)": [[110, "engforge.eng.fluid_material.Steam.setattrs", false]], "setattrs() (system method)": [[240, "engforge.system.System.setattrs", false]], "setattrs() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.setattrs", false]], "setattrs() (triangle method)": [[120, "engforge.eng.geometry.Triangle.setattrs", false]], "setattrs() (water method)": [[111, "engforge.eng.fluid_material.Water.setattrs", false]], "setattrs() (wetsoil method)": [[147, "engforge.eng.solid_materials.WetSoil.setattrs", false]], "setdefault() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.setdefault", false]], "setup_calls() (ref method)": [[243, "engforge.system_reference.Ref.setup_calls", false]], "setup_global_dynamics() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.setup_global_dynamics", false]], "setup_global_dynamics() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.setup_global_dynamics", false]], "setup_global_dynamics() (system method)": [[240, "engforge.system.System.setup_global_dynamics", false]], "shapelysection (class in engforge.eng.geometry)": [[119, "engforge.eng.geometry.ShapelySection", false]], "shear_modulus (aluminum property)": [[139, "engforge.eng.solid_materials.Aluminum.shear_modulus", false]], "shear_modulus (ansi_4130 property)": [[137, "engforge.eng.solid_materials.ANSI_4130.shear_modulus", false]], "shear_modulus (ansi_4340 property)": [[138, "engforge.eng.solid_materials.ANSI_4340.shear_modulus", false]], "shear_modulus (carbonfiber property)": [[140, "engforge.eng.solid_materials.CarbonFiber.shear_modulus", false]], "shear_modulus (concrete property)": [[141, "engforge.eng.solid_materials.Concrete.shear_modulus", false]], "shear_modulus (drysoil property)": [[142, "engforge.eng.solid_materials.DrySoil.shear_modulus", false]], "shear_modulus (rock property)": [[143, "engforge.eng.solid_materials.Rock.shear_modulus", false]], "shear_modulus (rubber property)": [[144, "engforge.eng.solid_materials.Rubber.shear_modulus", false]], "shear_modulus (solidmaterial property)": [[146, "engforge.eng.solid_materials.SolidMaterial.shear_modulus", false]], "shear_modulus (ss_316 property)": [[145, "engforge.eng.solid_materials.SS_316.shear_modulus", false]], "shear_modulus (wetsoil property)": [[147, "engforge.eng.solid_materials.WetSoil.shear_modulus", false]], "signal (class in engforge.attr_signals)": [[22, "engforge.attr_signals.Signal", false]], "signalinstance (class in engforge.attr_signals)": [[23, "engforge.attr_signals.SignalInstance", false]], "signals_attributes() (air class method)": [[97, "engforge.eng.fluid_material.Air.signals_attributes", false]], "signals_attributes() (airwatermix class method)": [[98, "engforge.eng.fluid_material.AirWaterMix.signals_attributes", false]], "signals_attributes() (aluminum class method)": [[139, "engforge.eng.solid_materials.Aluminum.signals_attributes", false]], "signals_attributes() (analysis class method)": [[2, "engforge.analysis.Analysis.signals_attributes", false]], "signals_attributes() (ansi_4130 class method)": [[137, "engforge.eng.solid_materials.ANSI_4130.signals_attributes", false]], "signals_attributes() (ansi_4340 class method)": [[138, "engforge.eng.solid_materials.ANSI_4340.signals_attributes", false]], "signals_attributes() (attributedbasemixin class method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.signals_attributes", false]], "signals_attributes() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.signals_attributes", false]], "signals_attributes() (carbonfiber class method)": [[140, "engforge.eng.solid_materials.CarbonFiber.signals_attributes", false]], "signals_attributes() (circle class method)": [[113, "engforge.eng.geometry.Circle.signals_attributes", false]], "signals_attributes() (component class method)": [[48, "engforge.components.Component.signals_attributes", false]], "signals_attributes() (componentdict class method)": [[42, "engforge.component_collections.ComponentDict.signals_attributes", false]], "signals_attributes() (componentiter class method)": [[43, "engforge.component_collections.ComponentIter.signals_attributes", false]], "signals_attributes() (componentiterator class method)": [[44, "engforge.component_collections.ComponentIterator.signals_attributes", false]], "signals_attributes() (concrete class method)": [[141, "engforge.eng.solid_materials.Concrete.signals_attributes", false]], "signals_attributes() (configuration class method)": [[52, "engforge.configuration.Configuration.signals_attributes", false]], "signals_attributes() (coolpropmaterial class method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.signals_attributes", false]], "signals_attributes() (coolpropmixture class method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.signals_attributes", false]], "signals_attributes() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.signals_attributes", false]], "signals_attributes() (drysoil class method)": [[142, "engforge.eng.solid_materials.DrySoil.signals_attributes", false]], "signals_attributes() (dynamicsmixin class method)": [[84, "engforge.dynamics.DynamicsMixin.signals_attributes", false]], "signals_attributes() (economics class method)": [[92, "engforge.eng.costs.Economics.signals_attributes", false]], "signals_attributes() (flowinput class method)": [[125, "engforge.eng.pipes.FlowInput.signals_attributes", false]], "signals_attributes() (flownode class method)": [[126, "engforge.eng.pipes.FlowNode.signals_attributes", false]], "signals_attributes() (fluidmaterial class method)": [[101, "engforge.eng.fluid_material.FluidMaterial.signals_attributes", false]], "signals_attributes() (globaldynamics class method)": [[85, "engforge.dynamics.GlobalDynamics.signals_attributes", false]], "signals_attributes() (hollowcircle class method)": [[115, "engforge.eng.geometry.HollowCircle.signals_attributes", false]], "signals_attributes() (hydrogen class method)": [[102, "engforge.eng.fluid_material.Hydrogen.signals_attributes", false]], "signals_attributes() (idealair class method)": [[103, "engforge.eng.fluid_material.IdealAir.signals_attributes", false]], "signals_attributes() (idealgas class method)": [[104, "engforge.eng.fluid_material.IdealGas.signals_attributes", false]], "signals_attributes() (idealh2 class method)": [[105, "engforge.eng.fluid_material.IdealH2.signals_attributes", false]], "signals_attributes() (idealoxygen class method)": [[106, "engforge.eng.fluid_material.IdealOxygen.signals_attributes", false]], "signals_attributes() (idealsteam class method)": [[107, "engforge.eng.fluid_material.IdealSteam.signals_attributes", false]], "signals_attributes() (oxygen class method)": [[108, "engforge.eng.fluid_material.Oxygen.signals_attributes", false]], "signals_attributes() (pipe class method)": [[127, "engforge.eng.pipes.Pipe.signals_attributes", false]], "signals_attributes() (pipefitting class method)": [[128, "engforge.eng.pipes.PipeFitting.signals_attributes", false]], "signals_attributes() (pipeflow class method)": [[129, "engforge.eng.pipes.PipeFlow.signals_attributes", false]], "signals_attributes() (pipenode class method)": [[131, "engforge.eng.pipes.PipeNode.signals_attributes", false]], "signals_attributes() (pipesystem class method)": [[132, "engforge.eng.pipes.PipeSystem.signals_attributes", false]], "signals_attributes() (profile2d class method)": [[117, "engforge.eng.geometry.Profile2D.signals_attributes", false]], "signals_attributes() (pump class method)": [[133, "engforge.eng.pipes.Pump.signals_attributes", false]], "signals_attributes() (rectangle class method)": [[118, "engforge.eng.geometry.Rectangle.signals_attributes", false]], "signals_attributes() (rock class method)": [[143, "engforge.eng.solid_materials.Rock.signals_attributes", false]], "signals_attributes() (rubber class method)": [[144, "engforge.eng.solid_materials.Rubber.signals_attributes", false]], "signals_attributes() (seawater class method)": [[109, "engforge.eng.fluid_material.SeaWater.signals_attributes", false]], "signals_attributes() (shapelysection class method)": [[119, "engforge.eng.geometry.ShapelySection.signals_attributes", false]], "signals_attributes() (simplecompressor class method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.signals_attributes", false]], "signals_attributes() (simpleheatexchanger class method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.signals_attributes", false]], "signals_attributes() (simplepump class method)": [[156, "engforge.eng.thermodynamics.SimplePump.signals_attributes", false]], "signals_attributes() (simpleturbine class method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.signals_attributes", false]], "signals_attributes() (solidmaterial class method)": [[146, "engforge.eng.solid_materials.SolidMaterial.signals_attributes", false]], "signals_attributes() (solveableinterface class method)": [[49, "engforge.components.SolveableInterface.signals_attributes", false]], "signals_attributes() (solveablemixin class method)": [[219, "engforge.solveable.SolveableMixin.signals_attributes", false]], "signals_attributes() (solvermixin class method)": [[222, "engforge.solver.SolverMixin.signals_attributes", false]], "signals_attributes() (ss_316 class method)": [[145, "engforge.eng.solid_materials.SS_316.signals_attributes", false]], "signals_attributes() (steam class method)": [[110, "engforge.eng.fluid_material.Steam.signals_attributes", false]], "signals_attributes() (system class method)": [[240, "engforge.system.System.signals_attributes", false]], "signals_attributes() (tabulationmixin class method)": [[253, "engforge.tabulation.TabulationMixin.signals_attributes", false]], "signals_attributes() (triangle class method)": [[120, "engforge.eng.geometry.Triangle.signals_attributes", false]], "signals_attributes() (water class method)": [[111, "engforge.eng.fluid_material.Water.signals_attributes", false]], "signals_attributes() (wetsoil class method)": [[147, "engforge.eng.solid_materials.WetSoil.signals_attributes", false]], "signals_slots_handler() (in module engforge.configuration)": [[59, "engforge.configuration.signals_slots_handler", false]], "sim_matrix() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.sim_matrix", false]], "sim_matrix() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.sim_matrix", false]], "sim_matrix() (system method)": [[240, "engforge.system.System.sim_matrix", false]], "simplecompressor (class in engforge.eng.thermodynamics)": [[154, "engforge.eng.thermodynamics.SimpleCompressor", false]], "simpleheatexchanger (class in engforge.eng.thermodynamics)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger", false]], "simplepump (class in engforge.eng.thermodynamics)": [[156, "engforge.eng.thermodynamics.SimplePump", false]], "simpleturbine (class in engforge.eng.thermodynamics)": [[157, "engforge.eng.thermodynamics.SimpleTurbine", false]], "simulate() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.simulate", false]], "simulate() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.simulate", false]], "simulate() (system method)": [[240, "engforge.system.System.simulate", false]], "singleton (class in engforge.patterns)": [[178, "engforge.patterns.Singleton", false]], "singleton_meta_object() (in module engforge.patterns)": [[184, "engforge.patterns.singleton_meta_object", false]], "singletonmeta (class in engforge.patterns)": [[179, "engforge.patterns.SingletonMeta", false]], "skip_plot_vars (air property)": [[97, "engforge.eng.fluid_material.Air.skip_plot_vars", false]], "skip_plot_vars (airwatermix property)": [[98, "engforge.eng.fluid_material.AirWaterMix.skip_plot_vars", false]], "skip_plot_vars (analysis property)": [[2, "engforge.analysis.Analysis.skip_plot_vars", false]], "skip_plot_vars (beam property)": [[151, "engforge.eng.structure_beams.Beam.skip_plot_vars", false]], "skip_plot_vars (component property)": [[48, "engforge.components.Component.skip_plot_vars", false]], "skip_plot_vars (componentdict property)": [[42, "engforge.component_collections.ComponentDict.skip_plot_vars", false]], "skip_plot_vars (componentiter property)": [[43, "engforge.component_collections.ComponentIter.skip_plot_vars", false]], "skip_plot_vars (componentiterator property)": [[44, "engforge.component_collections.ComponentIterator.skip_plot_vars", false]], "skip_plot_vars (coolpropmaterial property)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.skip_plot_vars", false]], "skip_plot_vars (coolpropmixture property)": [[100, "engforge.eng.fluid_material.CoolPropMixture.skip_plot_vars", false]], "skip_plot_vars (costmodel property)": [[91, "engforge.eng.costs.CostModel.skip_plot_vars", false]], "skip_plot_vars (dataframemixin property)": [[62, "engforge.dataframe.DataframeMixin.skip_plot_vars", false]], "skip_plot_vars (economics property)": [[92, "engforge.eng.costs.Economics.skip_plot_vars", false]], "skip_plot_vars (flowinput property)": [[125, "engforge.eng.pipes.FlowInput.skip_plot_vars", false]], "skip_plot_vars (flownode property)": [[126, "engforge.eng.pipes.FlowNode.skip_plot_vars", false]], "skip_plot_vars (fluidmaterial property)": [[101, "engforge.eng.fluid_material.FluidMaterial.skip_plot_vars", false]], "skip_plot_vars (hydrogen property)": [[102, "engforge.eng.fluid_material.Hydrogen.skip_plot_vars", false]], "skip_plot_vars (idealair property)": [[103, "engforge.eng.fluid_material.IdealAir.skip_plot_vars", false]], "skip_plot_vars (idealgas property)": [[104, "engforge.eng.fluid_material.IdealGas.skip_plot_vars", false]], "skip_plot_vars (idealh2 property)": [[105, "engforge.eng.fluid_material.IdealH2.skip_plot_vars", false]], "skip_plot_vars (idealoxygen property)": [[106, "engforge.eng.fluid_material.IdealOxygen.skip_plot_vars", false]], "skip_plot_vars (idealsteam property)": [[107, "engforge.eng.fluid_material.IdealSteam.skip_plot_vars", false]], "skip_plot_vars (oxygen property)": [[108, "engforge.eng.fluid_material.Oxygen.skip_plot_vars", false]], "skip_plot_vars (pipe property)": [[127, "engforge.eng.pipes.Pipe.skip_plot_vars", false]], "skip_plot_vars (pipefitting property)": [[128, "engforge.eng.pipes.PipeFitting.skip_plot_vars", false]], "skip_plot_vars (pipeflow property)": [[129, "engforge.eng.pipes.PipeFlow.skip_plot_vars", false]], "skip_plot_vars (pipenode property)": [[131, "engforge.eng.pipes.PipeNode.skip_plot_vars", false]], "skip_plot_vars (pipesystem property)": [[132, "engforge.eng.pipes.PipeSystem.skip_plot_vars", false]], "skip_plot_vars (problem property)": [[188, "engforge.problem_context.Problem.skip_plot_vars", false]], "skip_plot_vars (pump property)": [[133, "engforge.eng.pipes.Pump.skip_plot_vars", false]], "skip_plot_vars (seawater property)": [[109, "engforge.eng.fluid_material.SeaWater.skip_plot_vars", false]], "skip_plot_vars (simplecompressor property)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.skip_plot_vars", false]], "skip_plot_vars (simpleheatexchanger property)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.skip_plot_vars", false]], "skip_plot_vars (simplepump property)": [[156, "engforge.eng.thermodynamics.SimplePump.skip_plot_vars", false]], "skip_plot_vars (simpleturbine property)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.skip_plot_vars", false]], "skip_plot_vars (solveableinterface property)": [[49, "engforge.components.SolveableInterface.skip_plot_vars", false]], "skip_plot_vars (steam property)": [[110, "engforge.eng.fluid_material.Steam.skip_plot_vars", false]], "skip_plot_vars (system property)": [[240, "engforge.system.System.skip_plot_vars", false]], "skip_plot_vars (tabulationmixin property)": [[253, "engforge.tabulation.TabulationMixin.skip_plot_vars", false]], "skip_plot_vars (water property)": [[111, "engforge.eng.fluid_material.Water.skip_plot_vars", false]], "slot (class in engforge.attr_slots)": [[25, "engforge.attr_slots.Slot", false]], "slot_refs() (air class method)": [[97, "engforge.eng.fluid_material.Air.slot_refs", false]], "slot_refs() (airwatermix class method)": [[98, "engforge.eng.fluid_material.AirWaterMix.slot_refs", false]], "slot_refs() (aluminum class method)": [[139, "engforge.eng.solid_materials.Aluminum.slot_refs", false]], "slot_refs() (analysis class method)": [[2, "engforge.analysis.Analysis.slot_refs", false]], "slot_refs() (ansi_4130 class method)": [[137, "engforge.eng.solid_materials.ANSI_4130.slot_refs", false]], "slot_refs() (ansi_4340 class method)": [[138, "engforge.eng.solid_materials.ANSI_4340.slot_refs", false]], "slot_refs() (attributedbasemixin class method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.slot_refs", false]], "slot_refs() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.slot_refs", false]], "slot_refs() (carbonfiber class method)": [[140, "engforge.eng.solid_materials.CarbonFiber.slot_refs", false]], "slot_refs() (circle class method)": [[113, "engforge.eng.geometry.Circle.slot_refs", false]], "slot_refs() (component class method)": [[48, "engforge.components.Component.slot_refs", false]], "slot_refs() (componentdict class method)": [[42, "engforge.component_collections.ComponentDict.slot_refs", false]], "slot_refs() (componentiter class method)": [[43, "engforge.component_collections.ComponentIter.slot_refs", false]], "slot_refs() (componentiterator class method)": [[44, "engforge.component_collections.ComponentIterator.slot_refs", false]], "slot_refs() (concrete class method)": [[141, "engforge.eng.solid_materials.Concrete.slot_refs", false]], "slot_refs() (configuration class method)": [[52, "engforge.configuration.Configuration.slot_refs", false]], "slot_refs() (coolpropmaterial class method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.slot_refs", false]], "slot_refs() (coolpropmixture class method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.slot_refs", false]], "slot_refs() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.slot_refs", false]], "slot_refs() (drysoil class method)": [[142, "engforge.eng.solid_materials.DrySoil.slot_refs", false]], "slot_refs() (dynamicsmixin class method)": [[84, "engforge.dynamics.DynamicsMixin.slot_refs", false]], "slot_refs() (economics class method)": [[92, "engforge.eng.costs.Economics.slot_refs", false]], "slot_refs() (flowinput class method)": [[125, "engforge.eng.pipes.FlowInput.slot_refs", false]], "slot_refs() (flownode class method)": [[126, "engforge.eng.pipes.FlowNode.slot_refs", false]], "slot_refs() (fluidmaterial class method)": [[101, "engforge.eng.fluid_material.FluidMaterial.slot_refs", false]], "slot_refs() (globaldynamics class method)": [[85, "engforge.dynamics.GlobalDynamics.slot_refs", false]], "slot_refs() (hollowcircle class method)": [[115, "engforge.eng.geometry.HollowCircle.slot_refs", false]], "slot_refs() (hydrogen class method)": [[102, "engforge.eng.fluid_material.Hydrogen.slot_refs", false]], "slot_refs() (idealair class method)": [[103, "engforge.eng.fluid_material.IdealAir.slot_refs", false]], "slot_refs() (idealgas class method)": [[104, "engforge.eng.fluid_material.IdealGas.slot_refs", false]], "slot_refs() (idealh2 class method)": [[105, "engforge.eng.fluid_material.IdealH2.slot_refs", false]], "slot_refs() (idealoxygen class method)": [[106, "engforge.eng.fluid_material.IdealOxygen.slot_refs", false]], "slot_refs() (idealsteam class method)": [[107, "engforge.eng.fluid_material.IdealSteam.slot_refs", false]], "slot_refs() (oxygen class method)": [[108, "engforge.eng.fluid_material.Oxygen.slot_refs", false]], "slot_refs() (pipe class method)": [[127, "engforge.eng.pipes.Pipe.slot_refs", false]], "slot_refs() (pipefitting class method)": [[128, "engforge.eng.pipes.PipeFitting.slot_refs", false]], "slot_refs() (pipeflow class method)": [[129, "engforge.eng.pipes.PipeFlow.slot_refs", false]], "slot_refs() (pipenode class method)": [[131, "engforge.eng.pipes.PipeNode.slot_refs", false]], "slot_refs() (pipesystem class method)": [[132, "engforge.eng.pipes.PipeSystem.slot_refs", false]], "slot_refs() (profile2d class method)": [[117, "engforge.eng.geometry.Profile2D.slot_refs", false]], "slot_refs() (pump class method)": [[133, "engforge.eng.pipes.Pump.slot_refs", false]], "slot_refs() (rectangle class method)": [[118, "engforge.eng.geometry.Rectangle.slot_refs", false]], "slot_refs() (rock class method)": [[143, "engforge.eng.solid_materials.Rock.slot_refs", false]], "slot_refs() (rubber class method)": [[144, "engforge.eng.solid_materials.Rubber.slot_refs", false]], "slot_refs() (seawater class method)": [[109, "engforge.eng.fluid_material.SeaWater.slot_refs", false]], "slot_refs() (shapelysection class method)": [[119, "engforge.eng.geometry.ShapelySection.slot_refs", false]], "slot_refs() (simplecompressor class method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.slot_refs", false]], "slot_refs() (simpleheatexchanger class method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.slot_refs", false]], "slot_refs() (simplepump class method)": [[156, "engforge.eng.thermodynamics.SimplePump.slot_refs", false]], "slot_refs() (simpleturbine class method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.slot_refs", false]], "slot_refs() (solidmaterial class method)": [[146, "engforge.eng.solid_materials.SolidMaterial.slot_refs", false]], "slot_refs() (solveableinterface class method)": [[49, "engforge.components.SolveableInterface.slot_refs", false]], "slot_refs() (solveablemixin class method)": [[219, "engforge.solveable.SolveableMixin.slot_refs", false]], "slot_refs() (solvermixin class method)": [[222, "engforge.solver.SolverMixin.slot_refs", false]], "slot_refs() (ss_316 class method)": [[145, "engforge.eng.solid_materials.SS_316.slot_refs", false]], "slot_refs() (steam class method)": [[110, "engforge.eng.fluid_material.Steam.slot_refs", false]], "slot_refs() (system class method)": [[240, "engforge.system.System.slot_refs", false]], "slot_refs() (tabulationmixin class method)": [[253, "engforge.tabulation.TabulationMixin.slot_refs", false]], "slot_refs() (triangle class method)": [[120, "engforge.eng.geometry.Triangle.slot_refs", false]], "slot_refs() (water class method)": [[111, "engforge.eng.fluid_material.Water.slot_refs", false]], "slot_refs() (wetsoil class method)": [[147, "engforge.eng.solid_materials.WetSoil.slot_refs", false]], "slotlog (class in engforge.attr_slots)": [[26, "engforge.attr_slots.SlotLog", false]], "slots_attributes() (air class method)": [[97, "engforge.eng.fluid_material.Air.slots_attributes", false]], "slots_attributes() (airwatermix class method)": [[98, "engforge.eng.fluid_material.AirWaterMix.slots_attributes", false]], "slots_attributes() (aluminum class method)": [[139, "engforge.eng.solid_materials.Aluminum.slots_attributes", false]], "slots_attributes() (analysis class method)": [[2, "engforge.analysis.Analysis.slots_attributes", false]], "slots_attributes() (ansi_4130 class method)": [[137, "engforge.eng.solid_materials.ANSI_4130.slots_attributes", false]], "slots_attributes() (ansi_4340 class method)": [[138, "engforge.eng.solid_materials.ANSI_4340.slots_attributes", false]], "slots_attributes() (attributedbasemixin class method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.slots_attributes", false]], "slots_attributes() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.slots_attributes", false]], "slots_attributes() (carbonfiber class method)": [[140, "engforge.eng.solid_materials.CarbonFiber.slots_attributes", false]], "slots_attributes() (circle class method)": [[113, "engforge.eng.geometry.Circle.slots_attributes", false]], "slots_attributes() (component class method)": [[48, "engforge.components.Component.slots_attributes", false]], "slots_attributes() (componentdict class method)": [[42, "engforge.component_collections.ComponentDict.slots_attributes", false]], "slots_attributes() (componentiter class method)": [[43, "engforge.component_collections.ComponentIter.slots_attributes", false]], "slots_attributes() (componentiterator class method)": [[44, "engforge.component_collections.ComponentIterator.slots_attributes", false]], "slots_attributes() (concrete class method)": [[141, "engforge.eng.solid_materials.Concrete.slots_attributes", false]], "slots_attributes() (configuration class method)": [[52, "engforge.configuration.Configuration.slots_attributes", false]], "slots_attributes() (coolpropmaterial class method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.slots_attributes", false]], "slots_attributes() (coolpropmixture class method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.slots_attributes", false]], "slots_attributes() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.slots_attributes", false]], "slots_attributes() (drysoil class method)": [[142, "engforge.eng.solid_materials.DrySoil.slots_attributes", false]], "slots_attributes() (dynamicsmixin class method)": [[84, "engforge.dynamics.DynamicsMixin.slots_attributes", false]], "slots_attributes() (economics class method)": [[92, "engforge.eng.costs.Economics.slots_attributes", false]], "slots_attributes() (flowinput class method)": [[125, "engforge.eng.pipes.FlowInput.slots_attributes", false]], "slots_attributes() (flownode class method)": [[126, "engforge.eng.pipes.FlowNode.slots_attributes", false]], "slots_attributes() (fluidmaterial class method)": [[101, "engforge.eng.fluid_material.FluidMaterial.slots_attributes", false]], "slots_attributes() (globaldynamics class method)": [[85, "engforge.dynamics.GlobalDynamics.slots_attributes", false]], "slots_attributes() (hollowcircle class method)": [[115, "engforge.eng.geometry.HollowCircle.slots_attributes", false]], "slots_attributes() (hydrogen class method)": [[102, "engforge.eng.fluid_material.Hydrogen.slots_attributes", false]], "slots_attributes() (idealair class method)": [[103, "engforge.eng.fluid_material.IdealAir.slots_attributes", false]], "slots_attributes() (idealgas class method)": [[104, "engforge.eng.fluid_material.IdealGas.slots_attributes", false]], "slots_attributes() (idealh2 class method)": [[105, "engforge.eng.fluid_material.IdealH2.slots_attributes", false]], "slots_attributes() (idealoxygen class method)": [[106, "engforge.eng.fluid_material.IdealOxygen.slots_attributes", false]], "slots_attributes() (idealsteam class method)": [[107, "engforge.eng.fluid_material.IdealSteam.slots_attributes", false]], "slots_attributes() (oxygen class method)": [[108, "engforge.eng.fluid_material.Oxygen.slots_attributes", false]], "slots_attributes() (pipe class method)": [[127, "engforge.eng.pipes.Pipe.slots_attributes", false]], "slots_attributes() (pipefitting class method)": [[128, "engforge.eng.pipes.PipeFitting.slots_attributes", false]], "slots_attributes() (pipeflow class method)": [[129, "engforge.eng.pipes.PipeFlow.slots_attributes", false]], "slots_attributes() (pipenode class method)": [[131, "engforge.eng.pipes.PipeNode.slots_attributes", false]], "slots_attributes() (pipesystem class method)": [[132, "engforge.eng.pipes.PipeSystem.slots_attributes", false]], "slots_attributes() (profile2d class method)": [[117, "engforge.eng.geometry.Profile2D.slots_attributes", false]], "slots_attributes() (pump class method)": [[133, "engforge.eng.pipes.Pump.slots_attributes", false]], "slots_attributes() (rectangle class method)": [[118, "engforge.eng.geometry.Rectangle.slots_attributes", false]], "slots_attributes() (rock class method)": [[143, "engforge.eng.solid_materials.Rock.slots_attributes", false]], "slots_attributes() (rubber class method)": [[144, "engforge.eng.solid_materials.Rubber.slots_attributes", false]], "slots_attributes() (seawater class method)": [[109, "engforge.eng.fluid_material.SeaWater.slots_attributes", false]], "slots_attributes() (shapelysection class method)": [[119, "engforge.eng.geometry.ShapelySection.slots_attributes", false]], "slots_attributes() (simplecompressor class method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.slots_attributes", false]], "slots_attributes() (simpleheatexchanger class method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.slots_attributes", false]], "slots_attributes() (simplepump class method)": [[156, "engforge.eng.thermodynamics.SimplePump.slots_attributes", false]], "slots_attributes() (simpleturbine class method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.slots_attributes", false]], "slots_attributes() (solidmaterial class method)": [[146, "engforge.eng.solid_materials.SolidMaterial.slots_attributes", false]], "slots_attributes() (solveableinterface class method)": [[49, "engforge.components.SolveableInterface.slots_attributes", false]], "slots_attributes() (solveablemixin class method)": [[219, "engforge.solveable.SolveableMixin.slots_attributes", false]], "slots_attributes() (solvermixin class method)": [[222, "engforge.solver.SolverMixin.slots_attributes", false]], "slots_attributes() (ss_316 class method)": [[145, "engforge.eng.solid_materials.SS_316.slots_attributes", false]], "slots_attributes() (steam class method)": [[110, "engforge.eng.fluid_material.Steam.slots_attributes", false]], "slots_attributes() (system class method)": [[240, "engforge.system.System.slots_attributes", false]], "slots_attributes() (tabulationmixin class method)": [[253, "engforge.tabulation.TabulationMixin.slots_attributes", false]], "slots_attributes() (triangle class method)": [[120, "engforge.eng.geometry.Triangle.slots_attributes", false]], "slots_attributes() (water class method)": [[111, "engforge.eng.fluid_material.Water.slots_attributes", false]], "slots_attributes() (wetsoil class method)": [[147, "engforge.eng.solid_materials.WetSoil.slots_attributes", false]], "smart_split_dataframe() (air method)": [[97, "engforge.eng.fluid_material.Air.smart_split_dataframe", false]], "smart_split_dataframe() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.smart_split_dataframe", false]], "smart_split_dataframe() (analysis method)": [[2, "engforge.analysis.Analysis.smart_split_dataframe", false]], "smart_split_dataframe() (beam method)": [[151, "engforge.eng.structure_beams.Beam.smart_split_dataframe", false]], "smart_split_dataframe() (component method)": [[48, "engforge.components.Component.smart_split_dataframe", false]], "smart_split_dataframe() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.smart_split_dataframe", false]], "smart_split_dataframe() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.smart_split_dataframe", false]], "smart_split_dataframe() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.smart_split_dataframe", false]], "smart_split_dataframe() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.smart_split_dataframe", false]], "smart_split_dataframe() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.smart_split_dataframe", false]], "smart_split_dataframe() (costmodel method)": [[91, "engforge.eng.costs.CostModel.smart_split_dataframe", false]], "smart_split_dataframe() (dataframemixin method)": [[62, "engforge.dataframe.DataframeMixin.smart_split_dataframe", false]], "smart_split_dataframe() (economics method)": [[92, "engforge.eng.costs.Economics.smart_split_dataframe", false]], "smart_split_dataframe() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.smart_split_dataframe", false]], "smart_split_dataframe() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.smart_split_dataframe", false]], "smart_split_dataframe() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.smart_split_dataframe", false]], "smart_split_dataframe() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.smart_split_dataframe", false]], "smart_split_dataframe() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.smart_split_dataframe", false]], "smart_split_dataframe() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.smart_split_dataframe", false]], "smart_split_dataframe() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.smart_split_dataframe", false]], "smart_split_dataframe() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.smart_split_dataframe", false]], "smart_split_dataframe() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.smart_split_dataframe", false]], "smart_split_dataframe() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.smart_split_dataframe", false]], "smart_split_dataframe() (pipe method)": [[127, "engforge.eng.pipes.Pipe.smart_split_dataframe", false]], "smart_split_dataframe() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.smart_split_dataframe", false]], "smart_split_dataframe() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.smart_split_dataframe", false]], "smart_split_dataframe() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.smart_split_dataframe", false]], "smart_split_dataframe() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.smart_split_dataframe", false]], "smart_split_dataframe() (problem method)": [[188, "engforge.problem_context.Problem.smart_split_dataframe", false]], "smart_split_dataframe() (pump method)": [[133, "engforge.eng.pipes.Pump.smart_split_dataframe", false]], "smart_split_dataframe() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.smart_split_dataframe", false]], "smart_split_dataframe() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.smart_split_dataframe", false]], "smart_split_dataframe() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.smart_split_dataframe", false]], "smart_split_dataframe() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.smart_split_dataframe", false]], "smart_split_dataframe() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.smart_split_dataframe", false]], "smart_split_dataframe() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.smart_split_dataframe", false]], "smart_split_dataframe() (steam method)": [[110, "engforge.eng.fluid_material.Steam.smart_split_dataframe", false]], "smart_split_dataframe() (system method)": [[240, "engforge.system.System.smart_split_dataframe", false]], "smart_split_dataframe() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.smart_split_dataframe", false]], "smart_split_dataframe() (water method)": [[111, "engforge.eng.fluid_material.Water.smart_split_dataframe", false]], "solidmaterial (class in engforge.eng.solid_materials)": [[146, "engforge.eng.solid_materials.SolidMaterial", false]], "solvablelog (class in engforge.solveable)": [[218, "engforge.solveable.SolvableLog", false]], "solve_min() (problem method)": [[188, "engforge.problem_context.Problem.solve_min", false]], "solve_min() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.solve_min", false]], "solveable (problem property)": [[188, "engforge.problem_context.Problem.solveable", false]], "solveable (problemexec property)": [[189, "engforge.problem_context.ProblemExec.solveable", false]], "solveableinterface (class in engforge.components)": [[49, "engforge.components.SolveableInterface", false]], "solveablemixin (class in engforge.solveable)": [[219, "engforge.solveable.SolveableMixin", false]], "solver (class in engforge.attr_solver)": [[29, "engforge.attr_solver.Solver", false]], "solver() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.solver", false]], "solver() (solvermixin method)": [[222, "engforge.solver.SolverMixin.solver", false]], "solver() (system method)": [[240, "engforge.system.System.solver", false]], "solver_cached (class in engforge.properties)": [[201, "engforge.properties.solver_cached", false]], "solver_vars() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.solver_vars", false]], "solver_vars() (solvermixin method)": [[222, "engforge.solver.SolverMixin.solver_vars", false]], "solver_vars() (system method)": [[240, "engforge.system.System.solver_vars", false]], "solverinstance (class in engforge.attr_solver)": [[30, "engforge.attr_solver.SolverInstance", false]], "solverlog (class in engforge.solver)": [[221, "engforge.solver.SolverLog", false]], "solvermixin (class in engforge.solver)": [[222, "engforge.solver.SolverMixin", false]], "solvers_attributes() (air class method)": [[97, "engforge.eng.fluid_material.Air.solvers_attributes", false]], "solvers_attributes() (airwatermix class method)": [[98, "engforge.eng.fluid_material.AirWaterMix.solvers_attributes", false]], "solvers_attributes() (aluminum class method)": [[139, "engforge.eng.solid_materials.Aluminum.solvers_attributes", false]], "solvers_attributes() (analysis class method)": [[2, "engforge.analysis.Analysis.solvers_attributes", false]], "solvers_attributes() (ansi_4130 class method)": [[137, "engforge.eng.solid_materials.ANSI_4130.solvers_attributes", false]], "solvers_attributes() (ansi_4340 class method)": [[138, "engforge.eng.solid_materials.ANSI_4340.solvers_attributes", false]], "solvers_attributes() (attributedbasemixin class method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.solvers_attributes", false]], "solvers_attributes() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.solvers_attributes", false]], "solvers_attributes() (carbonfiber class method)": [[140, "engforge.eng.solid_materials.CarbonFiber.solvers_attributes", false]], "solvers_attributes() (circle class method)": [[113, "engforge.eng.geometry.Circle.solvers_attributes", false]], "solvers_attributes() (component class method)": [[48, "engforge.components.Component.solvers_attributes", false]], "solvers_attributes() (componentdict class method)": [[42, "engforge.component_collections.ComponentDict.solvers_attributes", false]], "solvers_attributes() (componentiter class method)": [[43, "engforge.component_collections.ComponentIter.solvers_attributes", false]], "solvers_attributes() (componentiterator class method)": [[44, "engforge.component_collections.ComponentIterator.solvers_attributes", false]], "solvers_attributes() (concrete class method)": [[141, "engforge.eng.solid_materials.Concrete.solvers_attributes", false]], "solvers_attributes() (configuration class method)": [[52, "engforge.configuration.Configuration.solvers_attributes", false]], "solvers_attributes() (coolpropmaterial class method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.solvers_attributes", false]], "solvers_attributes() (coolpropmixture class method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.solvers_attributes", false]], "solvers_attributes() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.solvers_attributes", false]], "solvers_attributes() (drysoil class method)": [[142, "engforge.eng.solid_materials.DrySoil.solvers_attributes", false]], "solvers_attributes() (dynamicsmixin class method)": [[84, "engforge.dynamics.DynamicsMixin.solvers_attributes", false]], "solvers_attributes() (economics class method)": [[92, "engforge.eng.costs.Economics.solvers_attributes", false]], "solvers_attributes() (flowinput class method)": [[125, "engforge.eng.pipes.FlowInput.solvers_attributes", false]], "solvers_attributes() (flownode class method)": [[126, "engforge.eng.pipes.FlowNode.solvers_attributes", false]], "solvers_attributes() (fluidmaterial class method)": [[101, "engforge.eng.fluid_material.FluidMaterial.solvers_attributes", false]], "solvers_attributes() (globaldynamics class method)": [[85, "engforge.dynamics.GlobalDynamics.solvers_attributes", false]], "solvers_attributes() (hollowcircle class method)": [[115, "engforge.eng.geometry.HollowCircle.solvers_attributes", false]], "solvers_attributes() (hydrogen class method)": [[102, "engforge.eng.fluid_material.Hydrogen.solvers_attributes", false]], "solvers_attributes() (idealair class method)": [[103, "engforge.eng.fluid_material.IdealAir.solvers_attributes", false]], "solvers_attributes() (idealgas class method)": [[104, "engforge.eng.fluid_material.IdealGas.solvers_attributes", false]], "solvers_attributes() (idealh2 class method)": [[105, "engforge.eng.fluid_material.IdealH2.solvers_attributes", false]], "solvers_attributes() (idealoxygen class method)": [[106, "engforge.eng.fluid_material.IdealOxygen.solvers_attributes", false]], "solvers_attributes() (idealsteam class method)": [[107, "engforge.eng.fluid_material.IdealSteam.solvers_attributes", false]], "solvers_attributes() (oxygen class method)": [[108, "engforge.eng.fluid_material.Oxygen.solvers_attributes", false]], "solvers_attributes() (pipe class method)": [[127, "engforge.eng.pipes.Pipe.solvers_attributes", false]], "solvers_attributes() (pipefitting class method)": [[128, "engforge.eng.pipes.PipeFitting.solvers_attributes", false]], "solvers_attributes() (pipeflow class method)": [[129, "engforge.eng.pipes.PipeFlow.solvers_attributes", false]], "solvers_attributes() (pipenode class method)": [[131, "engforge.eng.pipes.PipeNode.solvers_attributes", false]], "solvers_attributes() (pipesystem class method)": [[132, "engforge.eng.pipes.PipeSystem.solvers_attributes", false]], "solvers_attributes() (profile2d class method)": [[117, "engforge.eng.geometry.Profile2D.solvers_attributes", false]], "solvers_attributes() (pump class method)": [[133, "engforge.eng.pipes.Pump.solvers_attributes", false]], "solvers_attributes() (rectangle class method)": [[118, "engforge.eng.geometry.Rectangle.solvers_attributes", false]], "solvers_attributes() (rock class method)": [[143, "engforge.eng.solid_materials.Rock.solvers_attributes", false]], "solvers_attributes() (rubber class method)": [[144, "engforge.eng.solid_materials.Rubber.solvers_attributes", false]], "solvers_attributes() (seawater class method)": [[109, "engforge.eng.fluid_material.SeaWater.solvers_attributes", false]], "solvers_attributes() (shapelysection class method)": [[119, "engforge.eng.geometry.ShapelySection.solvers_attributes", false]], "solvers_attributes() (simplecompressor class method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.solvers_attributes", false]], "solvers_attributes() (simpleheatexchanger class method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.solvers_attributes", false]], "solvers_attributes() (simplepump class method)": [[156, "engforge.eng.thermodynamics.SimplePump.solvers_attributes", false]], "solvers_attributes() (simpleturbine class method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.solvers_attributes", false]], "solvers_attributes() (solidmaterial class method)": [[146, "engforge.eng.solid_materials.SolidMaterial.solvers_attributes", false]], "solvers_attributes() (solveableinterface class method)": [[49, "engforge.components.SolveableInterface.solvers_attributes", false]], "solvers_attributes() (solveablemixin class method)": [[219, "engforge.solveable.SolveableMixin.solvers_attributes", false]], "solvers_attributes() (solvermixin class method)": [[222, "engforge.solver.SolverMixin.solvers_attributes", false]], "solvers_attributes() (ss_316 class method)": [[145, "engforge.eng.solid_materials.SS_316.solvers_attributes", false]], "solvers_attributes() (steam class method)": [[110, "engforge.eng.fluid_material.Steam.solvers_attributes", false]], "solvers_attributes() (system class method)": [[240, "engforge.system.System.solvers_attributes", false]], "solvers_attributes() (tabulationmixin class method)": [[253, "engforge.tabulation.TabulationMixin.solvers_attributes", false]], "solvers_attributes() (triangle class method)": [[120, "engforge.eng.geometry.Triangle.solvers_attributes", false]], "solvers_attributes() (water class method)": [[111, "engforge.eng.fluid_material.Water.solvers_attributes", false]], "solvers_attributes() (wetsoil class method)": [[147, "engforge.eng.solid_materials.WetSoil.solvers_attributes", false]], "solverutillog (class in engforge.solver_utils)": [[224, "engforge.solver_utils.SolverUtilLog", false]], "split_dataframe() (in module engforge.dataframe)": [[69, "engforge.dataframe.split_dataframe", false]], "ss_316 (class in engforge.eng.solid_materials)": [[145, "engforge.eng.solid_materials.SS_316", false]], "steam (class in engforge.eng.fluid_material)": [[110, "engforge.eng.fluid_material.Steam", false]], "str_list_f() (in module engforge.solver_utils)": [[238, "engforge.solver_utils.str_list_f", false]], "str_validator() (in module engforge.typing)": [[258, "engforge.typing.STR_VALIDATOR", false]], "sub_costs() (beam method)": [[151, "engforge.eng.structure_beams.Beam.sub_costs", false]], "sub_costs() (costmodel method)": [[91, "engforge.eng.costs.CostModel.sub_costs", false]], "subclasses() (air class method)": [[97, "engforge.eng.fluid_material.Air.subclasses", false]], "subclasses() (airwatermix class method)": [[98, "engforge.eng.fluid_material.AirWaterMix.subclasses", false]], "subclasses() (aluminum class method)": [[139, "engforge.eng.solid_materials.Aluminum.subclasses", false]], "subclasses() (analysis class method)": [[2, "engforge.analysis.Analysis.subclasses", false]], "subclasses() (ansi_4130 class method)": [[137, "engforge.eng.solid_materials.ANSI_4130.subclasses", false]], "subclasses() (ansi_4340 class method)": [[138, "engforge.eng.solid_materials.ANSI_4340.subclasses", false]], "subclasses() (attr_base class method)": [[33, "engforge.attributes.ATTR_BASE.subclasses", false]], "subclasses() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.subclasses", false]], "subclasses() (carbonfiber class method)": [[140, "engforge.eng.solid_materials.CarbonFiber.subclasses", false]], "subclasses() (circle class method)": [[113, "engforge.eng.geometry.Circle.subclasses", false]], "subclasses() (component class method)": [[48, "engforge.components.Component.subclasses", false]], "subclasses() (componentdict class method)": [[42, "engforge.component_collections.ComponentDict.subclasses", false]], "subclasses() (componentiter class method)": [[43, "engforge.component_collections.ComponentIter.subclasses", false]], "subclasses() (componentiterator class method)": [[44, "engforge.component_collections.ComponentIterator.subclasses", false]], "subclasses() (concrete class method)": [[141, "engforge.eng.solid_materials.Concrete.subclasses", false]], "subclasses() (configuration class method)": [[52, "engforge.configuration.Configuration.subclasses", false]], "subclasses() (coolpropmaterial class method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.subclasses", false]], "subclasses() (coolpropmixture class method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.subclasses", false]], "subclasses() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.subclasses", false]], "subclasses() (csvreporter class method)": [[206, "engforge.reporting.CSVReporter.subclasses", false]], "subclasses() (diskplotreporter class method)": [[207, "engforge.reporting.DiskPlotReporter.subclasses", false]], "subclasses() (diskreportermixin class method)": [[208, "engforge.reporting.DiskReporterMixin.subclasses", false]], "subclasses() (drysoil class method)": [[142, "engforge.eng.solid_materials.DrySoil.subclasses", false]], "subclasses() (dynamicsmixin class method)": [[84, "engforge.dynamics.DynamicsMixin.subclasses", false]], "subclasses() (economics class method)": [[92, "engforge.eng.costs.Economics.subclasses", false]], "subclasses() (excelreporter class method)": [[209, "engforge.reporting.ExcelReporter.subclasses", false]], "subclasses() (flowinput class method)": [[125, "engforge.eng.pipes.FlowInput.subclasses", false]], "subclasses() (flownode class method)": [[126, "engforge.eng.pipes.FlowNode.subclasses", false]], "subclasses() (fluidmaterial class method)": [[101, "engforge.eng.fluid_material.FluidMaterial.subclasses", false]], "subclasses() (gdrivereporter class method)": [[210, "engforge.reporting.GdriveReporter.subclasses", false]], "subclasses() (globaldynamics class method)": [[85, "engforge.dynamics.GlobalDynamics.subclasses", false]], "subclasses() (gsheetsreporter class method)": [[211, "engforge.reporting.GsheetsReporter.subclasses", false]], "subclasses() (hollowcircle class method)": [[115, "engforge.eng.geometry.HollowCircle.subclasses", false]], "subclasses() (hydrogen class method)": [[102, "engforge.eng.fluid_material.Hydrogen.subclasses", false]], "subclasses() (idealair class method)": [[103, "engforge.eng.fluid_material.IdealAir.subclasses", false]], "subclasses() (idealgas class method)": [[104, "engforge.eng.fluid_material.IdealGas.subclasses", false]], "subclasses() (idealh2 class method)": [[105, "engforge.eng.fluid_material.IdealH2.subclasses", false]], "subclasses() (idealoxygen class method)": [[106, "engforge.eng.fluid_material.IdealOxygen.subclasses", false]], "subclasses() (idealsteam class method)": [[107, "engforge.eng.fluid_material.IdealSteam.subclasses", false]], "subclasses() (oxygen class method)": [[108, "engforge.eng.fluid_material.Oxygen.subclasses", false]], "subclasses() (pipe class method)": [[127, "engforge.eng.pipes.Pipe.subclasses", false]], "subclasses() (pipefitting class method)": [[128, "engforge.eng.pipes.PipeFitting.subclasses", false]], "subclasses() (pipeflow class method)": [[129, "engforge.eng.pipes.PipeFlow.subclasses", false]], "subclasses() (pipenode class method)": [[131, "engforge.eng.pipes.PipeNode.subclasses", false]], "subclasses() (pipesystem class method)": [[132, "engforge.eng.pipes.PipeSystem.subclasses", false]], "subclasses() (plot class method)": [[9, "engforge.attr_plotting.Plot.subclasses", false]], "subclasses() (plotbase class method)": [[10, "engforge.attr_plotting.PlotBase.subclasses", false]], "subclasses() (plotreporter class method)": [[212, "engforge.reporting.PlotReporter.subclasses", false]], "subclasses() (profile2d class method)": [[117, "engforge.eng.geometry.Profile2D.subclasses", false]], "subclasses() (pump class method)": [[133, "engforge.eng.pipes.Pump.subclasses", false]], "subclasses() (rectangle class method)": [[118, "engforge.eng.geometry.Rectangle.subclasses", false]], "subclasses() (reporter class method)": [[213, "engforge.reporting.Reporter.subclasses", false]], "subclasses() (rock class method)": [[143, "engforge.eng.solid_materials.Rock.subclasses", false]], "subclasses() (rubber class method)": [[144, "engforge.eng.solid_materials.Rubber.subclasses", false]], "subclasses() (seawater class method)": [[109, "engforge.eng.fluid_material.SeaWater.subclasses", false]], "subclasses() (shapelysection class method)": [[119, "engforge.eng.geometry.ShapelySection.subclasses", false]], "subclasses() (signal class method)": [[22, "engforge.attr_signals.Signal.subclasses", false]], "subclasses() (simplecompressor class method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.subclasses", false]], "subclasses() (simpleheatexchanger class method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.subclasses", false]], "subclasses() (simplepump class method)": [[156, "engforge.eng.thermodynamics.SimplePump.subclasses", false]], "subclasses() (simpleturbine class method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.subclasses", false]], "subclasses() (slot class method)": [[25, "engforge.attr_slots.Slot.subclasses", false]], "subclasses() (solidmaterial class method)": [[146, "engforge.eng.solid_materials.SolidMaterial.subclasses", false]], "subclasses() (solveableinterface class method)": [[49, "engforge.components.SolveableInterface.subclasses", false]], "subclasses() (solver class method)": [[29, "engforge.attr_solver.Solver.subclasses", false]], "subclasses() (ss_316 class method)": [[145, "engforge.eng.solid_materials.SS_316.subclasses", false]], "subclasses() (steam class method)": [[110, "engforge.eng.fluid_material.Steam.subclasses", false]], "subclasses() (system class method)": [[240, "engforge.system.System.subclasses", false]], "subclasses() (tablereporter class method)": [[214, "engforge.reporting.TableReporter.subclasses", false]], "subclasses() (temporalreportermixin class method)": [[215, "engforge.reporting.TemporalReporterMixin.subclasses", false]], "subclasses() (time class method)": [[7, "engforge.attr_dynamics.Time.subclasses", false]], "subclasses() (trace class method)": [[14, "engforge.attr_plotting.Trace.subclasses", false]], "subclasses() (triangle class method)": [[120, "engforge.eng.geometry.Triangle.subclasses", false]], "subclasses() (water class method)": [[111, "engforge.eng.fluid_material.Water.subclasses", false]], "subclasses() (wetsoil class method)": [[147, "engforge.eng.solid_materials.WetSoil.subclasses", false]], "subcls_compile() (air class method)": [[97, "engforge.eng.fluid_material.Air.subcls_compile", false]], "subcls_compile() (airwatermix class method)": [[98, "engforge.eng.fluid_material.AirWaterMix.subcls_compile", false]], "subcls_compile() (aluminum class method)": [[139, "engforge.eng.solid_materials.Aluminum.subcls_compile", false]], "subcls_compile() (analysis class method)": [[2, "engforge.analysis.Analysis.subcls_compile", false]], "subcls_compile() (ansi_4130 class method)": [[137, "engforge.eng.solid_materials.ANSI_4130.subcls_compile", false]], "subcls_compile() (ansi_4340 class method)": [[138, "engforge.eng.solid_materials.ANSI_4340.subcls_compile", false]], "subcls_compile() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.subcls_compile", false]], "subcls_compile() (carbonfiber class method)": [[140, "engforge.eng.solid_materials.CarbonFiber.subcls_compile", false]], "subcls_compile() (circle class method)": [[113, "engforge.eng.geometry.Circle.subcls_compile", false]], "subcls_compile() (component class method)": [[48, "engforge.components.Component.subcls_compile", false]], "subcls_compile() (componentdict class method)": [[42, "engforge.component_collections.ComponentDict.subcls_compile", false]], "subcls_compile() (componentiter class method)": [[43, "engforge.component_collections.ComponentIter.subcls_compile", false]], "subcls_compile() (componentiterator class method)": [[44, "engforge.component_collections.ComponentIterator.subcls_compile", false]], "subcls_compile() (concrete class method)": [[141, "engforge.eng.solid_materials.Concrete.subcls_compile", false]], "subcls_compile() (configuration class method)": [[52, "engforge.configuration.Configuration.subcls_compile", false]], "subcls_compile() (coolpropmaterial class method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.subcls_compile", false]], "subcls_compile() (coolpropmixture class method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.subcls_compile", false]], "subcls_compile() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.subcls_compile", false]], "subcls_compile() (drysoil class method)": [[142, "engforge.eng.solid_materials.DrySoil.subcls_compile", false]], "subcls_compile() (dynamicsmixin class method)": [[84, "engforge.dynamics.DynamicsMixin.subcls_compile", false]], "subcls_compile() (economics class method)": [[92, "engforge.eng.costs.Economics.subcls_compile", false]], "subcls_compile() (flowinput class method)": [[125, "engforge.eng.pipes.FlowInput.subcls_compile", false]], "subcls_compile() (flownode class method)": [[126, "engforge.eng.pipes.FlowNode.subcls_compile", false]], "subcls_compile() (fluidmaterial class method)": [[101, "engforge.eng.fluid_material.FluidMaterial.subcls_compile", false]], "subcls_compile() (globaldynamics class method)": [[85, "engforge.dynamics.GlobalDynamics.subcls_compile", false]], "subcls_compile() (hollowcircle class method)": [[115, "engforge.eng.geometry.HollowCircle.subcls_compile", false]], "subcls_compile() (hydrogen class method)": [[102, "engforge.eng.fluid_material.Hydrogen.subcls_compile", false]], "subcls_compile() (idealair class method)": [[103, "engforge.eng.fluid_material.IdealAir.subcls_compile", false]], "subcls_compile() (idealgas class method)": [[104, "engforge.eng.fluid_material.IdealGas.subcls_compile", false]], "subcls_compile() (idealh2 class method)": [[105, "engforge.eng.fluid_material.IdealH2.subcls_compile", false]], "subcls_compile() (idealoxygen class method)": [[106, "engforge.eng.fluid_material.IdealOxygen.subcls_compile", false]], "subcls_compile() (idealsteam class method)": [[107, "engforge.eng.fluid_material.IdealSteam.subcls_compile", false]], "subcls_compile() (oxygen class method)": [[108, "engforge.eng.fluid_material.Oxygen.subcls_compile", false]], "subcls_compile() (pipe class method)": [[127, "engforge.eng.pipes.Pipe.subcls_compile", false]], "subcls_compile() (pipefitting class method)": [[128, "engforge.eng.pipes.PipeFitting.subcls_compile", false]], "subcls_compile() (pipeflow class method)": [[129, "engforge.eng.pipes.PipeFlow.subcls_compile", false]], "subcls_compile() (pipenode class method)": [[131, "engforge.eng.pipes.PipeNode.subcls_compile", false]], "subcls_compile() (pipesystem class method)": [[132, "engforge.eng.pipes.PipeSystem.subcls_compile", false]], "subcls_compile() (profile2d class method)": [[117, "engforge.eng.geometry.Profile2D.subcls_compile", false]], "subcls_compile() (pump class method)": [[133, "engforge.eng.pipes.Pump.subcls_compile", false]], "subcls_compile() (rectangle class method)": [[118, "engforge.eng.geometry.Rectangle.subcls_compile", false]], "subcls_compile() (rock class method)": [[143, "engforge.eng.solid_materials.Rock.subcls_compile", false]], "subcls_compile() (rubber class method)": [[144, "engforge.eng.solid_materials.Rubber.subcls_compile", false]], "subcls_compile() (seawater class method)": [[109, "engforge.eng.fluid_material.SeaWater.subcls_compile", false]], "subcls_compile() (shapelysection class method)": [[119, "engforge.eng.geometry.ShapelySection.subcls_compile", false]], "subcls_compile() (simplecompressor class method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.subcls_compile", false]], "subcls_compile() (simpleheatexchanger class method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.subcls_compile", false]], "subcls_compile() (simplepump class method)": [[156, "engforge.eng.thermodynamics.SimplePump.subcls_compile", false]], "subcls_compile() (simpleturbine class method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.subcls_compile", false]], "subcls_compile() (solidmaterial class method)": [[146, "engforge.eng.solid_materials.SolidMaterial.subcls_compile", false]], "subcls_compile() (solveableinterface class method)": [[49, "engforge.components.SolveableInterface.subcls_compile", false]], "subcls_compile() (ss_316 class method)": [[145, "engforge.eng.solid_materials.SS_316.subcls_compile", false]], "subcls_compile() (steam class method)": [[110, "engforge.eng.fluid_material.Steam.subcls_compile", false]], "subcls_compile() (system class method)": [[240, "engforge.system.System.subcls_compile", false]], "subcls_compile() (triangle class method)": [[120, "engforge.eng.geometry.Triangle.subcls_compile", false]], "subcls_compile() (water class method)": [[111, "engforge.eng.fluid_material.Water.subcls_compile", false]], "subcls_compile() (wetsoil class method)": [[147, "engforge.eng.solid_materials.WetSoil.subcls_compile", false]], "sum_costs() (beam method)": [[151, "engforge.eng.structure_beams.Beam.sum_costs", false]], "sum_costs() (costmodel method)": [[91, "engforge.eng.costs.CostModel.sum_costs", false]], "sys_prop (in module engforge.properties)": [[202, "engforge.properties.sys_prop", false]], "sys_solver_constraints() (problem method)": [[188, "engforge.problem_context.Problem.sys_solver_constraints", false]], "sys_solver_constraints() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.sys_solver_constraints", false]], "sys_solver_objectives() (problem method)": [[188, "engforge.problem_context.Problem.sys_solver_objectives", false]], "sys_solver_objectives() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.sys_solver_objectives", false]], "system (class in engforge.system)": [[240, "engforge.system.System", false]], "system_id (air property)": [[97, "engforge.eng.fluid_material.Air.system_id", false]], "system_id (airwatermix property)": [[98, "engforge.eng.fluid_material.AirWaterMix.system_id", false]], "system_id (analysis property)": [[2, "engforge.analysis.Analysis.system_id", false]], "system_id (beam property)": [[151, "engforge.eng.structure_beams.Beam.system_id", false]], "system_id (component property)": [[48, "engforge.components.Component.system_id", false]], "system_id (componentdict property)": [[42, "engforge.component_collections.ComponentDict.system_id", false]], "system_id (componentiter property)": [[43, "engforge.component_collections.ComponentIter.system_id", false]], "system_id (componentiterator property)": [[44, "engforge.component_collections.ComponentIterator.system_id", false]], "system_id (coolpropmaterial property)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.system_id", false]], "system_id (coolpropmixture property)": [[100, "engforge.eng.fluid_material.CoolPropMixture.system_id", false]], "system_id (costmodel property)": [[91, "engforge.eng.costs.CostModel.system_id", false]], "system_id (economics property)": [[92, "engforge.eng.costs.Economics.system_id", false]], "system_id (flowinput property)": [[125, "engforge.eng.pipes.FlowInput.system_id", false]], "system_id (flownode property)": [[126, "engforge.eng.pipes.FlowNode.system_id", false]], "system_id (fluidmaterial property)": [[101, "engforge.eng.fluid_material.FluidMaterial.system_id", false]], "system_id (hydrogen property)": [[102, "engforge.eng.fluid_material.Hydrogen.system_id", false]], "system_id (idealair property)": [[103, "engforge.eng.fluid_material.IdealAir.system_id", false]], "system_id (idealgas property)": [[104, "engforge.eng.fluid_material.IdealGas.system_id", false]], "system_id (idealh2 property)": [[105, "engforge.eng.fluid_material.IdealH2.system_id", false]], "system_id (idealoxygen property)": [[106, "engforge.eng.fluid_material.IdealOxygen.system_id", false]], "system_id (idealsteam property)": [[107, "engforge.eng.fluid_material.IdealSteam.system_id", false]], "system_id (oxygen property)": [[108, "engforge.eng.fluid_material.Oxygen.system_id", false]], "system_id (pipe property)": [[127, "engforge.eng.pipes.Pipe.system_id", false]], "system_id (pipefitting property)": [[128, "engforge.eng.pipes.PipeFitting.system_id", false]], "system_id (pipeflow property)": [[129, "engforge.eng.pipes.PipeFlow.system_id", false]], "system_id (pipenode property)": [[131, "engforge.eng.pipes.PipeNode.system_id", false]], "system_id (pipesystem property)": [[132, "engforge.eng.pipes.PipeSystem.system_id", false]], "system_id (pump property)": [[133, "engforge.eng.pipes.Pump.system_id", false]], "system_id (seawater property)": [[109, "engforge.eng.fluid_material.SeaWater.system_id", false]], "system_id (simplecompressor property)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.system_id", false]], "system_id (simpleheatexchanger property)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.system_id", false]], "system_id (simplepump property)": [[156, "engforge.eng.thermodynamics.SimplePump.system_id", false]], "system_id (simpleturbine property)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.system_id", false]], "system_id (solveableinterface property)": [[49, "engforge.components.SolveableInterface.system_id", false]], "system_id (steam property)": [[110, "engforge.eng.fluid_material.Steam.system_id", false]], "system_id (system property)": [[240, "engforge.system.System.system_id", false]], "system_id (tabulationmixin property)": [[253, "engforge.tabulation.TabulationMixin.system_id", false]], "system_id (water property)": [[111, "engforge.eng.fluid_material.Water.system_id", false]], "system_prop (in module engforge.properties)": [[203, "engforge.properties.system_prop", false]], "system_properties_classdef() (air class method)": [[97, "engforge.eng.fluid_material.Air.system_properties_classdef", false]], "system_properties_classdef() (airwatermix class method)": [[98, "engforge.eng.fluid_material.AirWaterMix.system_properties_classdef", false]], "system_properties_classdef() (analysis class method)": [[2, "engforge.analysis.Analysis.system_properties_classdef", false]], "system_properties_classdef() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.system_properties_classdef", false]], "system_properties_classdef() (component class method)": [[48, "engforge.components.Component.system_properties_classdef", false]], "system_properties_classdef() (componentdict class method)": [[42, "engforge.component_collections.ComponentDict.system_properties_classdef", false]], "system_properties_classdef() (componentiter class method)": [[43, "engforge.component_collections.ComponentIter.system_properties_classdef", false]], "system_properties_classdef() (componentiterator class method)": [[44, "engforge.component_collections.ComponentIterator.system_properties_classdef", false]], "system_properties_classdef() (coolpropmaterial class method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.system_properties_classdef", false]], "system_properties_classdef() (coolpropmixture class method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.system_properties_classdef", false]], "system_properties_classdef() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.system_properties_classdef", false]], "system_properties_classdef() (economics class method)": [[92, "engforge.eng.costs.Economics.system_properties_classdef", false]], "system_properties_classdef() (flowinput class method)": [[125, "engforge.eng.pipes.FlowInput.system_properties_classdef", false]], "system_properties_classdef() (flownode class method)": [[126, "engforge.eng.pipes.FlowNode.system_properties_classdef", false]], "system_properties_classdef() (fluidmaterial class method)": [[101, "engforge.eng.fluid_material.FluidMaterial.system_properties_classdef", false]], "system_properties_classdef() (hydrogen class method)": [[102, "engforge.eng.fluid_material.Hydrogen.system_properties_classdef", false]], "system_properties_classdef() (idealair class method)": [[103, "engforge.eng.fluid_material.IdealAir.system_properties_classdef", false]], "system_properties_classdef() (idealgas class method)": [[104, "engforge.eng.fluid_material.IdealGas.system_properties_classdef", false]], "system_properties_classdef() (idealh2 class method)": [[105, "engforge.eng.fluid_material.IdealH2.system_properties_classdef", false]], "system_properties_classdef() (idealoxygen class method)": [[106, "engforge.eng.fluid_material.IdealOxygen.system_properties_classdef", false]], "system_properties_classdef() (idealsteam class method)": [[107, "engforge.eng.fluid_material.IdealSteam.system_properties_classdef", false]], "system_properties_classdef() (oxygen class method)": [[108, "engforge.eng.fluid_material.Oxygen.system_properties_classdef", false]], "system_properties_classdef() (pipe class method)": [[127, "engforge.eng.pipes.Pipe.system_properties_classdef", false]], "system_properties_classdef() (pipefitting class method)": [[128, "engforge.eng.pipes.PipeFitting.system_properties_classdef", false]], "system_properties_classdef() (pipeflow class method)": [[129, "engforge.eng.pipes.PipeFlow.system_properties_classdef", false]], "system_properties_classdef() (pipenode class method)": [[131, "engforge.eng.pipes.PipeNode.system_properties_classdef", false]], "system_properties_classdef() (pipesystem class method)": [[132, "engforge.eng.pipes.PipeSystem.system_properties_classdef", false]], "system_properties_classdef() (pump class method)": [[133, "engforge.eng.pipes.Pump.system_properties_classdef", false]], "system_properties_classdef() (seawater class method)": [[109, "engforge.eng.fluid_material.SeaWater.system_properties_classdef", false]], "system_properties_classdef() (simplecompressor class method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.system_properties_classdef", false]], "system_properties_classdef() (simpleheatexchanger class method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.system_properties_classdef", false]], "system_properties_classdef() (simplepump class method)": [[156, "engforge.eng.thermodynamics.SimplePump.system_properties_classdef", false]], "system_properties_classdef() (simpleturbine class method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.system_properties_classdef", false]], "system_properties_classdef() (solveableinterface class method)": [[49, "engforge.components.SolveableInterface.system_properties_classdef", false]], "system_properties_classdef() (steam class method)": [[110, "engforge.eng.fluid_material.Steam.system_properties_classdef", false]], "system_properties_classdef() (system class method)": [[240, "engforge.system.System.system_properties_classdef", false]], "system_properties_classdef() (tabulationmixin class method)": [[253, "engforge.tabulation.TabulationMixin.system_properties_classdef", false]], "system_properties_classdef() (water class method)": [[111, "engforge.eng.fluid_material.Water.system_properties_classdef", false]], "system_property (class in engforge.properties)": [[204, "engforge.properties.system_property", false]], "system_references() (air method)": [[97, "engforge.eng.fluid_material.Air.system_references", false]], "system_references() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.system_references", false]], "system_references() (analysis method)": [[2, "engforge.analysis.Analysis.system_references", false]], "system_references() (beam method)": [[151, "engforge.eng.structure_beams.Beam.system_references", false]], "system_references() (component method)": [[48, "engforge.components.Component.system_references", false]], "system_references() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.system_references", false]], "system_references() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.system_references", false]], "system_references() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.system_references", false]], "system_references() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.system_references", false]], "system_references() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.system_references", false]], "system_references() (costmodel method)": [[91, "engforge.eng.costs.CostModel.system_references", false]], "system_references() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.system_references", false]], "system_references() (economics method)": [[92, "engforge.eng.costs.Economics.system_references", false]], "system_references() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.system_references", false]], "system_references() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.system_references", false]], "system_references() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.system_references", false]], "system_references() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.system_references", false]], "system_references() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.system_references", false]], "system_references() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.system_references", false]], "system_references() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.system_references", false]], "system_references() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.system_references", false]], "system_references() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.system_references", false]], "system_references() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.system_references", false]], "system_references() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.system_references", false]], "system_references() (pipe method)": [[127, "engforge.eng.pipes.Pipe.system_references", false]], "system_references() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.system_references", false]], "system_references() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.system_references", false]], "system_references() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.system_references", false]], "system_references() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.system_references", false]], "system_references() (pump method)": [[133, "engforge.eng.pipes.Pump.system_references", false]], "system_references() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.system_references", false]], "system_references() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.system_references", false]], "system_references() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.system_references", false]], "system_references() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.system_references", false]], "system_references() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.system_references", false]], "system_references() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.system_references", false]], "system_references() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.system_references", false]], "system_references() (solvermixin method)": [[222, "engforge.solver.SolverMixin.system_references", false]], "system_references() (steam method)": [[110, "engforge.eng.fluid_material.Steam.system_references", false]], "system_references() (system method)": [[240, "engforge.system.System.system_references", false]], "system_references() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.system_references", false]], "system_references() (water method)": [[111, "engforge.eng.fluid_material.Water.system_references", false]], "systemslog (class in engforge.system)": [[241, "engforge.system.SystemsLog", false]], "tablelog (class in engforge.tabulation)": [[252, "engforge.tabulation.TableLog", false]], "tablereporter (class in engforge.reporting)": [[214, "engforge.reporting.TableReporter", false]], "tabulationmixin (class in engforge.tabulation)": [[253, "engforge.tabulation.TabulationMixin", false]], "temporalreportermixin (class in engforge.reporting)": [[215, "engforge.reporting.TemporalReporterMixin", false]], "test": [[262, "module-test", false]], "test.test_airfilter": [[263, "module-test.test_airfilter", false]], "test.test_comp_iter": [[264, "module-test.test_comp_iter", false]], "test.test_composition": [[265, "module-test.test_composition", false]], "test.test_costs": [[266, "module-test.test_costs", false]], "test.test_dynamics": [[267, "module-test.test_dynamics", false]], "test.test_dynamics_spaces": [[268, "module-test.test_dynamics_spaces", false]], "test.test_four_bar": [[269, "module-test.test_four_bar", false]], "test.test_modules": [[270, "module-test.test_modules", false]], "test.test_performance": [[271, "module-test.test_performance", false]], "test.test_pipes": [[272, "module-test.test_pipes", false]], "test.test_problem_deepscoping": [[273, "module-test.test_problem_deepscoping", false]], "test.test_slider_crank": [[274, "module-test.test_slider_crank", false]], "test.test_solver": [[275, "module-test.test_solver", false]], "test.test_tabulation": [[276, "module-test.test_tabulation", false]], "time (class in engforge.attr_dynamics)": [[7, "engforge.attr_dynamics.Time", false]], "trace (class in engforge.attr_plotting)": [[14, "engforge.attr_plotting.Trace", false]], "trace_attributes() (air class method)": [[97, "engforge.eng.fluid_material.Air.trace_attributes", false]], "trace_attributes() (airwatermix class method)": [[98, "engforge.eng.fluid_material.AirWaterMix.trace_attributes", false]], "trace_attributes() (aluminum class method)": [[139, "engforge.eng.solid_materials.Aluminum.trace_attributes", false]], "trace_attributes() (analysis class method)": [[2, "engforge.analysis.Analysis.trace_attributes", false]], "trace_attributes() (ansi_4130 class method)": [[137, "engforge.eng.solid_materials.ANSI_4130.trace_attributes", false]], "trace_attributes() (ansi_4340 class method)": [[138, "engforge.eng.solid_materials.ANSI_4340.trace_attributes", false]], "trace_attributes() (attributedbasemixin class method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.trace_attributes", false]], "trace_attributes() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.trace_attributes", false]], "trace_attributes() (carbonfiber class method)": [[140, "engforge.eng.solid_materials.CarbonFiber.trace_attributes", false]], "trace_attributes() (circle class method)": [[113, "engforge.eng.geometry.Circle.trace_attributes", false]], "trace_attributes() (component class method)": [[48, "engforge.components.Component.trace_attributes", false]], "trace_attributes() (componentdict class method)": [[42, "engforge.component_collections.ComponentDict.trace_attributes", false]], "trace_attributes() (componentiter class method)": [[43, "engforge.component_collections.ComponentIter.trace_attributes", false]], "trace_attributes() (componentiterator class method)": [[44, "engforge.component_collections.ComponentIterator.trace_attributes", false]], "trace_attributes() (concrete class method)": [[141, "engforge.eng.solid_materials.Concrete.trace_attributes", false]], "trace_attributes() (configuration class method)": [[52, "engforge.configuration.Configuration.trace_attributes", false]], "trace_attributes() (coolpropmaterial class method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.trace_attributes", false]], "trace_attributes() (coolpropmixture class method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.trace_attributes", false]], "trace_attributes() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.trace_attributes", false]], "trace_attributes() (drysoil class method)": [[142, "engforge.eng.solid_materials.DrySoil.trace_attributes", false]], "trace_attributes() (dynamicsmixin class method)": [[84, "engforge.dynamics.DynamicsMixin.trace_attributes", false]], "trace_attributes() (economics class method)": [[92, "engforge.eng.costs.Economics.trace_attributes", false]], "trace_attributes() (flowinput class method)": [[125, "engforge.eng.pipes.FlowInput.trace_attributes", false]], "trace_attributes() (flownode class method)": [[126, "engforge.eng.pipes.FlowNode.trace_attributes", false]], "trace_attributes() (fluidmaterial class method)": [[101, "engforge.eng.fluid_material.FluidMaterial.trace_attributes", false]], "trace_attributes() (globaldynamics class method)": [[85, "engforge.dynamics.GlobalDynamics.trace_attributes", false]], "trace_attributes() (hollowcircle class method)": [[115, "engforge.eng.geometry.HollowCircle.trace_attributes", false]], "trace_attributes() (hydrogen class method)": [[102, "engforge.eng.fluid_material.Hydrogen.trace_attributes", false]], "trace_attributes() (idealair class method)": [[103, "engforge.eng.fluid_material.IdealAir.trace_attributes", false]], "trace_attributes() (idealgas class method)": [[104, "engforge.eng.fluid_material.IdealGas.trace_attributes", false]], "trace_attributes() (idealh2 class method)": [[105, "engforge.eng.fluid_material.IdealH2.trace_attributes", false]], "trace_attributes() (idealoxygen class method)": [[106, "engforge.eng.fluid_material.IdealOxygen.trace_attributes", false]], "trace_attributes() (idealsteam class method)": [[107, "engforge.eng.fluid_material.IdealSteam.trace_attributes", false]], "trace_attributes() (oxygen class method)": [[108, "engforge.eng.fluid_material.Oxygen.trace_attributes", false]], "trace_attributes() (pipe class method)": [[127, "engforge.eng.pipes.Pipe.trace_attributes", false]], "trace_attributes() (pipefitting class method)": [[128, "engforge.eng.pipes.PipeFitting.trace_attributes", false]], "trace_attributes() (pipeflow class method)": [[129, "engforge.eng.pipes.PipeFlow.trace_attributes", false]], "trace_attributes() (pipenode class method)": [[131, "engforge.eng.pipes.PipeNode.trace_attributes", false]], "trace_attributes() (pipesystem class method)": [[132, "engforge.eng.pipes.PipeSystem.trace_attributes", false]], "trace_attributes() (profile2d class method)": [[117, "engforge.eng.geometry.Profile2D.trace_attributes", false]], "trace_attributes() (pump class method)": [[133, "engforge.eng.pipes.Pump.trace_attributes", false]], "trace_attributes() (rectangle class method)": [[118, "engforge.eng.geometry.Rectangle.trace_attributes", false]], "trace_attributes() (rock class method)": [[143, "engforge.eng.solid_materials.Rock.trace_attributes", false]], "trace_attributes() (rubber class method)": [[144, "engforge.eng.solid_materials.Rubber.trace_attributes", false]], "trace_attributes() (seawater class method)": [[109, "engforge.eng.fluid_material.SeaWater.trace_attributes", false]], "trace_attributes() (shapelysection class method)": [[119, "engforge.eng.geometry.ShapelySection.trace_attributes", false]], "trace_attributes() (simplecompressor class method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.trace_attributes", false]], "trace_attributes() (simpleheatexchanger class method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.trace_attributes", false]], "trace_attributes() (simplepump class method)": [[156, "engforge.eng.thermodynamics.SimplePump.trace_attributes", false]], "trace_attributes() (simpleturbine class method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.trace_attributes", false]], "trace_attributes() (solidmaterial class method)": [[146, "engforge.eng.solid_materials.SolidMaterial.trace_attributes", false]], "trace_attributes() (solveableinterface class method)": [[49, "engforge.components.SolveableInterface.trace_attributes", false]], "trace_attributes() (solveablemixin class method)": [[219, "engforge.solveable.SolveableMixin.trace_attributes", false]], "trace_attributes() (solvermixin class method)": [[222, "engforge.solver.SolverMixin.trace_attributes", false]], "trace_attributes() (ss_316 class method)": [[145, "engforge.eng.solid_materials.SS_316.trace_attributes", false]], "trace_attributes() (steam class method)": [[110, "engforge.eng.fluid_material.Steam.trace_attributes", false]], "trace_attributes() (system class method)": [[240, "engforge.system.System.trace_attributes", false]], "trace_attributes() (tabulationmixin class method)": [[253, "engforge.tabulation.TabulationMixin.trace_attributes", false]], "trace_attributes() (triangle class method)": [[120, "engforge.eng.geometry.Triangle.trace_attributes", false]], "trace_attributes() (water class method)": [[111, "engforge.eng.fluid_material.Water.trace_attributes", false]], "trace_attributes() (wetsoil class method)": [[147, "engforge.eng.solid_materials.WetSoil.trace_attributes", false]], "traceinstance (class in engforge.attr_plotting)": [[15, "engforge.attr_plotting.TraceInstance", false]], "train_compare() (circle method)": [[113, "engforge.eng.geometry.Circle.train_compare", false]], "train_compare() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.train_compare", false]], "train_compare() (predictionmixin method)": [[135, "engforge.eng.prediction.PredictionMixin.train_compare", false]], "train_compare() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.train_compare", false]], "train_compare() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.train_compare", false]], "train_compare() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.train_compare", false]], "train_compare() (triangle method)": [[120, "engforge.eng.geometry.Triangle.train_compare", false]], "train_until_valid() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.train_until_valid", false]], "training_callback() (circle method)": [[113, "engforge.eng.geometry.Circle.training_callback", false]], "training_callback() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.training_callback", false]], "training_callback() (predictionmixin method)": [[135, "engforge.eng.prediction.PredictionMixin.training_callback", false]], "training_callback() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.training_callback", false]], "training_callback() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.training_callback", false]], "training_callback() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.training_callback", false]], "training_callback() (triangle method)": [[120, "engforge.eng.geometry.Triangle.training_callback", false]], "transient (in module engforge.attr_dynamics)": [[6, "engforge.attr_dynamics.TRANSIENT", false]], "transients_attributes() (air class method)": [[97, "engforge.eng.fluid_material.Air.transients_attributes", false]], "transients_attributes() (airwatermix class method)": [[98, "engforge.eng.fluid_material.AirWaterMix.transients_attributes", false]], "transients_attributes() (aluminum class method)": [[139, "engforge.eng.solid_materials.Aluminum.transients_attributes", false]], "transients_attributes() (analysis class method)": [[2, "engforge.analysis.Analysis.transients_attributes", false]], "transients_attributes() (ansi_4130 class method)": [[137, "engforge.eng.solid_materials.ANSI_4130.transients_attributes", false]], "transients_attributes() (ansi_4340 class method)": [[138, "engforge.eng.solid_materials.ANSI_4340.transients_attributes", false]], "transients_attributes() (attributedbasemixin class method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.transients_attributes", false]], "transients_attributes() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.transients_attributes", false]], "transients_attributes() (carbonfiber class method)": [[140, "engforge.eng.solid_materials.CarbonFiber.transients_attributes", false]], "transients_attributes() (circle class method)": [[113, "engforge.eng.geometry.Circle.transients_attributes", false]], "transients_attributes() (component class method)": [[48, "engforge.components.Component.transients_attributes", false]], "transients_attributes() (componentdict class method)": [[42, "engforge.component_collections.ComponentDict.transients_attributes", false]], "transients_attributes() (componentiter class method)": [[43, "engforge.component_collections.ComponentIter.transients_attributes", false]], "transients_attributes() (componentiterator class method)": [[44, "engforge.component_collections.ComponentIterator.transients_attributes", false]], "transients_attributes() (concrete class method)": [[141, "engforge.eng.solid_materials.Concrete.transients_attributes", false]], "transients_attributes() (configuration class method)": [[52, "engforge.configuration.Configuration.transients_attributes", false]], "transients_attributes() (coolpropmaterial class method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.transients_attributes", false]], "transients_attributes() (coolpropmixture class method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.transients_attributes", false]], "transients_attributes() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.transients_attributes", false]], "transients_attributes() (drysoil class method)": [[142, "engforge.eng.solid_materials.DrySoil.transients_attributes", false]], "transients_attributes() (dynamicsmixin class method)": [[84, "engforge.dynamics.DynamicsMixin.transients_attributes", false]], "transients_attributes() (economics class method)": [[92, "engforge.eng.costs.Economics.transients_attributes", false]], "transients_attributes() (flowinput class method)": [[125, "engforge.eng.pipes.FlowInput.transients_attributes", false]], "transients_attributes() (flownode class method)": [[126, "engforge.eng.pipes.FlowNode.transients_attributes", false]], "transients_attributes() (fluidmaterial class method)": [[101, "engforge.eng.fluid_material.FluidMaterial.transients_attributes", false]], "transients_attributes() (globaldynamics class method)": [[85, "engforge.dynamics.GlobalDynamics.transients_attributes", false]], "transients_attributes() (hollowcircle class method)": [[115, "engforge.eng.geometry.HollowCircle.transients_attributes", false]], "transients_attributes() (hydrogen class method)": [[102, "engforge.eng.fluid_material.Hydrogen.transients_attributes", false]], "transients_attributes() (idealair class method)": [[103, "engforge.eng.fluid_material.IdealAir.transients_attributes", false]], "transients_attributes() (idealgas class method)": [[104, "engforge.eng.fluid_material.IdealGas.transients_attributes", false]], "transients_attributes() (idealh2 class method)": [[105, "engforge.eng.fluid_material.IdealH2.transients_attributes", false]], "transients_attributes() (idealoxygen class method)": [[106, "engforge.eng.fluid_material.IdealOxygen.transients_attributes", false]], "transients_attributes() (idealsteam class method)": [[107, "engforge.eng.fluid_material.IdealSteam.transients_attributes", false]], "transients_attributes() (oxygen class method)": [[108, "engforge.eng.fluid_material.Oxygen.transients_attributes", false]], "transients_attributes() (pipe class method)": [[127, "engforge.eng.pipes.Pipe.transients_attributes", false]], "transients_attributes() (pipefitting class method)": [[128, "engforge.eng.pipes.PipeFitting.transients_attributes", false]], "transients_attributes() (pipeflow class method)": [[129, "engforge.eng.pipes.PipeFlow.transients_attributes", false]], "transients_attributes() (pipenode class method)": [[131, "engforge.eng.pipes.PipeNode.transients_attributes", false]], "transients_attributes() (pipesystem class method)": [[132, "engforge.eng.pipes.PipeSystem.transients_attributes", false]], "transients_attributes() (profile2d class method)": [[117, "engforge.eng.geometry.Profile2D.transients_attributes", false]], "transients_attributes() (pump class method)": [[133, "engforge.eng.pipes.Pump.transients_attributes", false]], "transients_attributes() (rectangle class method)": [[118, "engforge.eng.geometry.Rectangle.transients_attributes", false]], "transients_attributes() (rock class method)": [[143, "engforge.eng.solid_materials.Rock.transients_attributes", false]], "transients_attributes() (rubber class method)": [[144, "engforge.eng.solid_materials.Rubber.transients_attributes", false]], "transients_attributes() (seawater class method)": [[109, "engforge.eng.fluid_material.SeaWater.transients_attributes", false]], "transients_attributes() (shapelysection class method)": [[119, "engforge.eng.geometry.ShapelySection.transients_attributes", false]], "transients_attributes() (simplecompressor class method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.transients_attributes", false]], "transients_attributes() (simpleheatexchanger class method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.transients_attributes", false]], "transients_attributes() (simplepump class method)": [[156, "engforge.eng.thermodynamics.SimplePump.transients_attributes", false]], "transients_attributes() (simpleturbine class method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.transients_attributes", false]], "transients_attributes() (solidmaterial class method)": [[146, "engforge.eng.solid_materials.SolidMaterial.transients_attributes", false]], "transients_attributes() (solveableinterface class method)": [[49, "engforge.components.SolveableInterface.transients_attributes", false]], "transients_attributes() (solveablemixin class method)": [[219, "engforge.solveable.SolveableMixin.transients_attributes", false]], "transients_attributes() (solvermixin class method)": [[222, "engforge.solver.SolverMixin.transients_attributes", false]], "transients_attributes() (ss_316 class method)": [[145, "engforge.eng.solid_materials.SS_316.transients_attributes", false]], "transients_attributes() (steam class method)": [[110, "engforge.eng.fluid_material.Steam.transients_attributes", false]], "transients_attributes() (system class method)": [[240, "engforge.system.System.transients_attributes", false]], "transients_attributes() (tabulationmixin class method)": [[253, "engforge.tabulation.TabulationMixin.transients_attributes", false]], "transients_attributes() (triangle class method)": [[120, "engforge.eng.geometry.Triangle.transients_attributes", false]], "transients_attributes() (water class method)": [[111, "engforge.eng.fluid_material.Water.transients_attributes", false]], "transients_attributes() (wetsoil class method)": [[147, "engforge.eng.solid_materials.WetSoil.transients_attributes", false]], "triangle (class in engforge.eng.geometry)": [[120, "engforge.eng.geometry.Triangle", false]], "update() (air method)": [[97, "engforge.eng.fluid_material.Air.update", false]], "update() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.update", false]], "update() (analysis method)": [[2, "engforge.analysis.Analysis.update", false]], "update() (beam method)": [[151, "engforge.eng.structure_beams.Beam.update", false]], "update() (component method)": [[48, "engforge.components.Component.update", false]], "update() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.update", false]], "update() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.update", false]], "update() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.update", false]], "update() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.update", false]], "update() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.update", false]], "update() (costmodel method)": [[91, "engforge.eng.costs.CostModel.update", false]], "update() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.update", false]], "update() (economics method)": [[92, "engforge.eng.costs.Economics.update", false]], "update() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.update", false]], "update() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.update", false]], "update() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.update", false]], "update() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.update", false]], "update() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.update", false]], "update() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.update", false]], "update() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.update", false]], "update() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.update", false]], "update() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.update", false]], "update() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.update", false]], "update() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.update", false]], "update() (pipe method)": [[127, "engforge.eng.pipes.Pipe.update", false]], "update() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.update", false]], "update() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.update", false]], "update() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.update", false]], "update() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.update", false]], "update() (pump method)": [[133, "engforge.eng.pipes.Pump.update", false]], "update() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.update", false]], "update() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.update", false]], "update() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.update", false]], "update() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.update", false]], "update() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.update", false]], "update() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.update", false]], "update() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.update", false]], "update() (solvermixin method)": [[222, "engforge.solver.SolverMixin.update", false]], "update() (steam method)": [[110, "engforge.eng.fluid_material.Steam.update", false]], "update() (system method)": [[240, "engforge.system.System.update", false]], "update() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.update", false]], "update() (water method)": [[111, "engforge.eng.fluid_material.Water.update", false]], "update_dflt_costs() (beam method)": [[151, "engforge.eng.structure_beams.Beam.update_dflt_costs", false]], "update_dflt_costs() (costmodel method)": [[91, "engforge.eng.costs.CostModel.update_dflt_costs", false]], "update_dynamics() (air method)": [[97, "engforge.eng.fluid_material.Air.update_dynamics", false]], "update_dynamics() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.update_dynamics", false]], "update_dynamics() (beam method)": [[151, "engforge.eng.structure_beams.Beam.update_dynamics", false]], "update_dynamics() (component method)": [[48, "engforge.components.Component.update_dynamics", false]], "update_dynamics() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.update_dynamics", false]], "update_dynamics() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.update_dynamics", false]], "update_dynamics() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.update_dynamics", false]], "update_dynamics() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.update_dynamics", false]], "update_dynamics() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.update_dynamics", false]], "update_dynamics() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.update_dynamics", false]], "update_dynamics() (economics method)": [[92, "engforge.eng.costs.Economics.update_dynamics", false]], "update_dynamics() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.update_dynamics", false]], "update_dynamics() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.update_dynamics", false]], "update_dynamics() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.update_dynamics", false]], "update_dynamics() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.update_dynamics", false]], "update_dynamics() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.update_dynamics", false]], "update_dynamics() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.update_dynamics", false]], "update_dynamics() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.update_dynamics", false]], "update_dynamics() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.update_dynamics", false]], "update_dynamics() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.update_dynamics", false]], "update_dynamics() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.update_dynamics", false]], "update_dynamics() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.update_dynamics", false]], "update_dynamics() (pipe method)": [[127, "engforge.eng.pipes.Pipe.update_dynamics", false]], "update_dynamics() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.update_dynamics", false]], "update_dynamics() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.update_dynamics", false]], "update_dynamics() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.update_dynamics", false]], "update_dynamics() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.update_dynamics", false]], "update_dynamics() (pump method)": [[133, "engforge.eng.pipes.Pump.update_dynamics", false]], "update_dynamics() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.update_dynamics", false]], "update_dynamics() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.update_dynamics", false]], "update_dynamics() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.update_dynamics", false]], "update_dynamics() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.update_dynamics", false]], "update_dynamics() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.update_dynamics", false]], "update_dynamics() (steam method)": [[110, "engforge.eng.fluid_material.Steam.update_dynamics", false]], "update_dynamics() (system method)": [[240, "engforge.system.System.update_dynamics", false]], "update_dynamics() (water method)": [[111, "engforge.eng.fluid_material.Water.update_dynamics", false]], "update_feedthrough() (air method)": [[97, "engforge.eng.fluid_material.Air.update_feedthrough", false]], "update_feedthrough() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.update_feedthrough", false]], "update_feedthrough() (beam method)": [[151, "engforge.eng.structure_beams.Beam.update_feedthrough", false]], "update_feedthrough() (component method)": [[48, "engforge.components.Component.update_feedthrough", false]], "update_feedthrough() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.update_feedthrough", false]], "update_feedthrough() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.update_feedthrough", false]], "update_feedthrough() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.update_feedthrough", false]], "update_feedthrough() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.update_feedthrough", false]], "update_feedthrough() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.update_feedthrough", false]], "update_feedthrough() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.update_feedthrough", false]], "update_feedthrough() (economics method)": [[92, "engforge.eng.costs.Economics.update_feedthrough", false]], "update_feedthrough() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.update_feedthrough", false]], "update_feedthrough() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.update_feedthrough", false]], "update_feedthrough() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.update_feedthrough", false]], "update_feedthrough() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.update_feedthrough", false]], "update_feedthrough() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.update_feedthrough", false]], "update_feedthrough() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.update_feedthrough", false]], "update_feedthrough() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.update_feedthrough", false]], "update_feedthrough() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.update_feedthrough", false]], "update_feedthrough() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.update_feedthrough", false]], "update_feedthrough() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.update_feedthrough", false]], "update_feedthrough() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.update_feedthrough", false]], "update_feedthrough() (pipe method)": [[127, "engforge.eng.pipes.Pipe.update_feedthrough", false]], "update_feedthrough() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.update_feedthrough", false]], "update_feedthrough() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.update_feedthrough", false]], "update_feedthrough() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.update_feedthrough", false]], "update_feedthrough() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.update_feedthrough", false]], "update_feedthrough() (pump method)": [[133, "engforge.eng.pipes.Pump.update_feedthrough", false]], "update_feedthrough() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.update_feedthrough", false]], "update_feedthrough() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.update_feedthrough", false]], "update_feedthrough() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.update_feedthrough", false]], "update_feedthrough() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.update_feedthrough", false]], "update_feedthrough() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.update_feedthrough", false]], "update_feedthrough() (steam method)": [[110, "engforge.eng.fluid_material.Steam.update_feedthrough", false]], "update_feedthrough() (system method)": [[240, "engforge.system.System.update_feedthrough", false]], "update_feedthrough() (water method)": [[111, "engforge.eng.fluid_material.Water.update_feedthrough", false]], "update_input() (air method)": [[97, "engforge.eng.fluid_material.Air.update_input", false]], "update_input() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.update_input", false]], "update_input() (beam method)": [[151, "engforge.eng.structure_beams.Beam.update_input", false]], "update_input() (component method)": [[48, "engforge.components.Component.update_input", false]], "update_input() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.update_input", false]], "update_input() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.update_input", false]], "update_input() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.update_input", false]], "update_input() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.update_input", false]], "update_input() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.update_input", false]], "update_input() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.update_input", false]], "update_input() (economics method)": [[92, "engforge.eng.costs.Economics.update_input", false]], "update_input() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.update_input", false]], "update_input() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.update_input", false]], "update_input() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.update_input", false]], "update_input() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.update_input", false]], "update_input() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.update_input", false]], "update_input() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.update_input", false]], "update_input() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.update_input", false]], "update_input() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.update_input", false]], "update_input() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.update_input", false]], "update_input() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.update_input", false]], "update_input() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.update_input", false]], "update_input() (pipe method)": [[127, "engforge.eng.pipes.Pipe.update_input", false]], "update_input() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.update_input", false]], "update_input() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.update_input", false]], "update_input() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.update_input", false]], "update_input() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.update_input", false]], "update_input() (pump method)": [[133, "engforge.eng.pipes.Pump.update_input", false]], "update_input() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.update_input", false]], "update_input() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.update_input", false]], "update_input() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.update_input", false]], "update_input() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.update_input", false]], "update_input() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.update_input", false]], "update_input() (steam method)": [[110, "engforge.eng.fluid_material.Steam.update_input", false]], "update_input() (system method)": [[240, "engforge.system.System.update_input", false]], "update_input() (water method)": [[111, "engforge.eng.fluid_material.Water.update_input", false]], "update_mass_ratios() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.update_mass_ratios", false]], "update_mass_ratios() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.update_mass_ratios", false]], "update_output_constants() (air method)": [[97, "engforge.eng.fluid_material.Air.update_output_constants", false]], "update_output_constants() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.update_output_constants", false]], "update_output_constants() (beam method)": [[151, "engforge.eng.structure_beams.Beam.update_output_constants", false]], "update_output_constants() (component method)": [[48, "engforge.components.Component.update_output_constants", false]], "update_output_constants() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.update_output_constants", false]], "update_output_constants() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.update_output_constants", false]], "update_output_constants() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.update_output_constants", false]], "update_output_constants() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.update_output_constants", false]], "update_output_constants() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.update_output_constants", false]], "update_output_constants() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.update_output_constants", false]], "update_output_constants() (economics method)": [[92, "engforge.eng.costs.Economics.update_output_constants", false]], "update_output_constants() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.update_output_constants", false]], "update_output_constants() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.update_output_constants", false]], "update_output_constants() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.update_output_constants", false]], "update_output_constants() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.update_output_constants", false]], "update_output_constants() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.update_output_constants", false]], "update_output_constants() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.update_output_constants", false]], "update_output_constants() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.update_output_constants", false]], "update_output_constants() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.update_output_constants", false]], "update_output_constants() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.update_output_constants", false]], "update_output_constants() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.update_output_constants", false]], "update_output_constants() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.update_output_constants", false]], "update_output_constants() (pipe method)": [[127, "engforge.eng.pipes.Pipe.update_output_constants", false]], "update_output_constants() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.update_output_constants", false]], "update_output_constants() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.update_output_constants", false]], "update_output_constants() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.update_output_constants", false]], "update_output_constants() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.update_output_constants", false]], "update_output_constants() (pump method)": [[133, "engforge.eng.pipes.Pump.update_output_constants", false]], "update_output_constants() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.update_output_constants", false]], "update_output_constants() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.update_output_constants", false]], "update_output_constants() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.update_output_constants", false]], "update_output_constants() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.update_output_constants", false]], "update_output_constants() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.update_output_constants", false]], "update_output_constants() (steam method)": [[110, "engforge.eng.fluid_material.Steam.update_output_constants", false]], "update_output_constants() (system method)": [[240, "engforge.system.System.update_output_constants", false]], "update_output_constants() (water method)": [[111, "engforge.eng.fluid_material.Water.update_output_constants", false]], "update_output_matrix() (air method)": [[97, "engforge.eng.fluid_material.Air.update_output_matrix", false]], "update_output_matrix() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.update_output_matrix", false]], "update_output_matrix() (beam method)": [[151, "engforge.eng.structure_beams.Beam.update_output_matrix", false]], "update_output_matrix() (component method)": [[48, "engforge.components.Component.update_output_matrix", false]], "update_output_matrix() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.update_output_matrix", false]], "update_output_matrix() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.update_output_matrix", false]], "update_output_matrix() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.update_output_matrix", false]], "update_output_matrix() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.update_output_matrix", false]], "update_output_matrix() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.update_output_matrix", false]], "update_output_matrix() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.update_output_matrix", false]], "update_output_matrix() (economics method)": [[92, "engforge.eng.costs.Economics.update_output_matrix", false]], "update_output_matrix() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.update_output_matrix", false]], "update_output_matrix() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.update_output_matrix", false]], "update_output_matrix() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.update_output_matrix", false]], "update_output_matrix() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.update_output_matrix", false]], "update_output_matrix() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.update_output_matrix", false]], "update_output_matrix() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.update_output_matrix", false]], "update_output_matrix() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.update_output_matrix", false]], "update_output_matrix() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.update_output_matrix", false]], "update_output_matrix() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.update_output_matrix", false]], "update_output_matrix() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.update_output_matrix", false]], "update_output_matrix() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.update_output_matrix", false]], "update_output_matrix() (pipe method)": [[127, "engforge.eng.pipes.Pipe.update_output_matrix", false]], "update_output_matrix() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.update_output_matrix", false]], "update_output_matrix() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.update_output_matrix", false]], "update_output_matrix() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.update_output_matrix", false]], "update_output_matrix() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.update_output_matrix", false]], "update_output_matrix() (pump method)": [[133, "engforge.eng.pipes.Pump.update_output_matrix", false]], "update_output_matrix() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.update_output_matrix", false]], "update_output_matrix() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.update_output_matrix", false]], "update_output_matrix() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.update_output_matrix", false]], "update_output_matrix() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.update_output_matrix", false]], "update_output_matrix() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.update_output_matrix", false]], "update_output_matrix() (steam method)": [[110, "engforge.eng.fluid_material.Steam.update_output_matrix", false]], "update_output_matrix() (system method)": [[240, "engforge.system.System.update_output_matrix", false]], "update_output_matrix() (water method)": [[111, "engforge.eng.fluid_material.Water.update_output_matrix", false]], "update_state() (air method)": [[97, "engforge.eng.fluid_material.Air.update_state", false]], "update_state() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.update_state", false]], "update_state() (beam method)": [[151, "engforge.eng.structure_beams.Beam.update_state", false]], "update_state() (component method)": [[48, "engforge.components.Component.update_state", false]], "update_state() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.update_state", false]], "update_state() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.update_state", false]], "update_state() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.update_state", false]], "update_state() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.update_state", false]], "update_state() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.update_state", false]], "update_state() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.update_state", false]], "update_state() (economics method)": [[92, "engforge.eng.costs.Economics.update_state", false]], "update_state() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.update_state", false]], "update_state() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.update_state", false]], "update_state() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.update_state", false]], "update_state() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.update_state", false]], "update_state() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.update_state", false]], "update_state() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.update_state", false]], "update_state() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.update_state", false]], "update_state() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.update_state", false]], "update_state() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.update_state", false]], "update_state() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.update_state", false]], "update_state() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.update_state", false]], "update_state() (pipe method)": [[127, "engforge.eng.pipes.Pipe.update_state", false]], "update_state() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.update_state", false]], "update_state() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.update_state", false]], "update_state() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.update_state", false]], "update_state() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.update_state", false]], "update_state() (pump method)": [[133, "engforge.eng.pipes.Pump.update_state", false]], "update_state() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.update_state", false]], "update_state() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.update_state", false]], "update_state() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.update_state", false]], "update_state() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.update_state", false]], "update_state() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.update_state", false]], "update_state() (steam method)": [[110, "engforge.eng.fluid_material.Steam.update_state", false]], "update_state() (system method)": [[240, "engforge.system.System.update_state", false]], "update_state() (water method)": [[111, "engforge.eng.fluid_material.Water.update_state", false]], "update_state_constants() (air method)": [[97, "engforge.eng.fluid_material.Air.update_state_constants", false]], "update_state_constants() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.update_state_constants", false]], "update_state_constants() (beam method)": [[151, "engforge.eng.structure_beams.Beam.update_state_constants", false]], "update_state_constants() (component method)": [[48, "engforge.components.Component.update_state_constants", false]], "update_state_constants() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.update_state_constants", false]], "update_state_constants() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.update_state_constants", false]], "update_state_constants() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.update_state_constants", false]], "update_state_constants() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.update_state_constants", false]], "update_state_constants() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.update_state_constants", false]], "update_state_constants() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.update_state_constants", false]], "update_state_constants() (economics method)": [[92, "engforge.eng.costs.Economics.update_state_constants", false]], "update_state_constants() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.update_state_constants", false]], "update_state_constants() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.update_state_constants", false]], "update_state_constants() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.update_state_constants", false]], "update_state_constants() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.update_state_constants", false]], "update_state_constants() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.update_state_constants", false]], "update_state_constants() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.update_state_constants", false]], "update_state_constants() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.update_state_constants", false]], "update_state_constants() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.update_state_constants", false]], "update_state_constants() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.update_state_constants", false]], "update_state_constants() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.update_state_constants", false]], "update_state_constants() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.update_state_constants", false]], "update_state_constants() (pipe method)": [[127, "engforge.eng.pipes.Pipe.update_state_constants", false]], "update_state_constants() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.update_state_constants", false]], "update_state_constants() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.update_state_constants", false]], "update_state_constants() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.update_state_constants", false]], "update_state_constants() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.update_state_constants", false]], "update_state_constants() (pump method)": [[133, "engforge.eng.pipes.Pump.update_state_constants", false]], "update_state_constants() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.update_state_constants", false]], "update_state_constants() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.update_state_constants", false]], "update_state_constants() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.update_state_constants", false]], "update_state_constants() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.update_state_constants", false]], "update_state_constants() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.update_state_constants", false]], "update_state_constants() (steam method)": [[110, "engforge.eng.fluid_material.Steam.update_state_constants", false]], "update_state_constants() (system method)": [[240, "engforge.system.System.update_state_constants", false]], "update_state_constants() (water method)": [[111, "engforge.eng.fluid_material.Water.update_state_constants", false]], "update_system() (problem method)": [[188, "engforge.problem_context.Problem.update_system", false]], "update_system() (problemexec method)": [[189, "engforge.problem_context.ProblemExec.update_system", false]], "ut_ref (air property)": [[97, "engforge.eng.fluid_material.Air.Ut_ref", false]], "ut_ref (airwatermix property)": [[98, "engforge.eng.fluid_material.AirWaterMix.Ut_ref", false]], "ut_ref (beam property)": [[151, "engforge.eng.structure_beams.Beam.Ut_ref", false]], "ut_ref (component property)": [[48, "engforge.components.Component.Ut_ref", false]], "ut_ref (componentdict property)": [[42, "engforge.component_collections.ComponentDict.Ut_ref", false]], "ut_ref (componentiter property)": [[43, "engforge.component_collections.ComponentIter.Ut_ref", false]], "ut_ref (componentiterator property)": [[44, "engforge.component_collections.ComponentIterator.Ut_ref", false]], "ut_ref (coolpropmaterial property)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.Ut_ref", false]], "ut_ref (coolpropmixture property)": [[100, "engforge.eng.fluid_material.CoolPropMixture.Ut_ref", false]], "ut_ref (dynamicsmixin property)": [[84, "engforge.dynamics.DynamicsMixin.Ut_ref", false]], "ut_ref (economics property)": [[92, "engforge.eng.costs.Economics.Ut_ref", false]], "ut_ref (flowinput property)": [[125, "engforge.eng.pipes.FlowInput.Ut_ref", false]], "ut_ref (flownode property)": [[126, "engforge.eng.pipes.FlowNode.Ut_ref", false]], "ut_ref (fluidmaterial property)": [[101, "engforge.eng.fluid_material.FluidMaterial.Ut_ref", false]], "ut_ref (globaldynamics property)": [[85, "engforge.dynamics.GlobalDynamics.Ut_ref", false]], "ut_ref (hydrogen property)": [[102, "engforge.eng.fluid_material.Hydrogen.Ut_ref", false]], "ut_ref (idealair property)": [[103, "engforge.eng.fluid_material.IdealAir.Ut_ref", false]], "ut_ref (idealgas property)": [[104, "engforge.eng.fluid_material.IdealGas.Ut_ref", false]], "ut_ref (idealh2 property)": [[105, "engforge.eng.fluid_material.IdealH2.Ut_ref", false]], "ut_ref (idealoxygen property)": [[106, "engforge.eng.fluid_material.IdealOxygen.Ut_ref", false]], "ut_ref (idealsteam property)": [[107, "engforge.eng.fluid_material.IdealSteam.Ut_ref", false]], "ut_ref (oxygen property)": [[108, "engforge.eng.fluid_material.Oxygen.Ut_ref", false]], "ut_ref (pipe property)": [[127, "engforge.eng.pipes.Pipe.Ut_ref", false]], "ut_ref (pipefitting property)": [[128, "engforge.eng.pipes.PipeFitting.Ut_ref", false]], "ut_ref (pipeflow property)": [[129, "engforge.eng.pipes.PipeFlow.Ut_ref", false]], "ut_ref (pipenode property)": [[131, "engforge.eng.pipes.PipeNode.Ut_ref", false]], "ut_ref (pipesystem property)": [[132, "engforge.eng.pipes.PipeSystem.Ut_ref", false]], "ut_ref (pump property)": [[133, "engforge.eng.pipes.Pump.Ut_ref", false]], "ut_ref (seawater property)": [[109, "engforge.eng.fluid_material.SeaWater.Ut_ref", false]], "ut_ref (simplecompressor property)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.Ut_ref", false]], "ut_ref (simpleheatexchanger property)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.Ut_ref", false]], "ut_ref (simplepump property)": [[156, "engforge.eng.thermodynamics.SimplePump.Ut_ref", false]], "ut_ref (simpleturbine property)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.Ut_ref", false]], "ut_ref (steam property)": [[110, "engforge.eng.fluid_material.Steam.Ut_ref", false]], "ut_ref (system property)": [[240, "engforge.system.System.Ut_ref", false]], "ut_ref (water property)": [[111, "engforge.eng.fluid_material.Water.Ut_ref", false]], "valid_mtx() (in module engforge.dynamics)": [[87, "engforge.dynamics.valid_mtx", false]], "validate_class() (air class method)": [[97, "engforge.eng.fluid_material.Air.validate_class", false]], "validate_class() (airwatermix class method)": [[98, "engforge.eng.fluid_material.AirWaterMix.validate_class", false]], "validate_class() (aluminum class method)": [[139, "engforge.eng.solid_materials.Aluminum.validate_class", false]], "validate_class() (analysis class method)": [[2, "engforge.analysis.Analysis.validate_class", false]], "validate_class() (ansi_4130 class method)": [[137, "engforge.eng.solid_materials.ANSI_4130.validate_class", false]], "validate_class() (ansi_4340 class method)": [[138, "engforge.eng.solid_materials.ANSI_4340.validate_class", false]], "validate_class() (beam class method)": [[151, "engforge.eng.structure_beams.Beam.validate_class", false]], "validate_class() (carbonfiber class method)": [[140, "engforge.eng.solid_materials.CarbonFiber.validate_class", false]], "validate_class() (circle class method)": [[113, "engforge.eng.geometry.Circle.validate_class", false]], "validate_class() (component class method)": [[48, "engforge.components.Component.validate_class", false]], "validate_class() (componentdict class method)": [[42, "engforge.component_collections.ComponentDict.validate_class", false]], "validate_class() (componentiter class method)": [[43, "engforge.component_collections.ComponentIter.validate_class", false]], "validate_class() (componentiterator class method)": [[44, "engforge.component_collections.ComponentIterator.validate_class", false]], "validate_class() (concrete class method)": [[141, "engforge.eng.solid_materials.Concrete.validate_class", false]], "validate_class() (configuration class method)": [[52, "engforge.configuration.Configuration.validate_class", false]], "validate_class() (coolpropmaterial class method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.validate_class", false]], "validate_class() (coolpropmixture class method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.validate_class", false]], "validate_class() (costmodel class method)": [[91, "engforge.eng.costs.CostModel.validate_class", false]], "validate_class() (drysoil class method)": [[142, "engforge.eng.solid_materials.DrySoil.validate_class", false]], "validate_class() (dynamicsmixin class method)": [[84, "engforge.dynamics.DynamicsMixin.validate_class", false]], "validate_class() (economics class method)": [[92, "engforge.eng.costs.Economics.validate_class", false]], "validate_class() (flowinput class method)": [[125, "engforge.eng.pipes.FlowInput.validate_class", false]], "validate_class() (flownode class method)": [[126, "engforge.eng.pipes.FlowNode.validate_class", false]], "validate_class() (fluidmaterial class method)": [[101, "engforge.eng.fluid_material.FluidMaterial.validate_class", false]], "validate_class() (globaldynamics class method)": [[85, "engforge.dynamics.GlobalDynamics.validate_class", false]], "validate_class() (hollowcircle class method)": [[115, "engforge.eng.geometry.HollowCircle.validate_class", false]], "validate_class() (hydrogen class method)": [[102, "engforge.eng.fluid_material.Hydrogen.validate_class", false]], "validate_class() (idealair class method)": [[103, "engforge.eng.fluid_material.IdealAir.validate_class", false]], "validate_class() (idealgas class method)": [[104, "engforge.eng.fluid_material.IdealGas.validate_class", false]], "validate_class() (idealh2 class method)": [[105, "engforge.eng.fluid_material.IdealH2.validate_class", false]], "validate_class() (idealoxygen class method)": [[106, "engforge.eng.fluid_material.IdealOxygen.validate_class", false]], "validate_class() (idealsteam class method)": [[107, "engforge.eng.fluid_material.IdealSteam.validate_class", false]], "validate_class() (oxygen class method)": [[108, "engforge.eng.fluid_material.Oxygen.validate_class", false]], "validate_class() (pipe class method)": [[127, "engforge.eng.pipes.Pipe.validate_class", false]], "validate_class() (pipefitting class method)": [[128, "engforge.eng.pipes.PipeFitting.validate_class", false]], "validate_class() (pipeflow class method)": [[129, "engforge.eng.pipes.PipeFlow.validate_class", false]], "validate_class() (pipenode class method)": [[131, "engforge.eng.pipes.PipeNode.validate_class", false]], "validate_class() (pipesystem class method)": [[132, "engforge.eng.pipes.PipeSystem.validate_class", false]], "validate_class() (profile2d class method)": [[117, "engforge.eng.geometry.Profile2D.validate_class", false]], "validate_class() (pump class method)": [[133, "engforge.eng.pipes.Pump.validate_class", false]], "validate_class() (rectangle class method)": [[118, "engforge.eng.geometry.Rectangle.validate_class", false]], "validate_class() (rock class method)": [[143, "engforge.eng.solid_materials.Rock.validate_class", false]], "validate_class() (rubber class method)": [[144, "engforge.eng.solid_materials.Rubber.validate_class", false]], "validate_class() (seawater class method)": [[109, "engforge.eng.fluid_material.SeaWater.validate_class", false]], "validate_class() (shapelysection class method)": [[119, "engforge.eng.geometry.ShapelySection.validate_class", false]], "validate_class() (simplecompressor class method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.validate_class", false]], "validate_class() (simpleheatexchanger class method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.validate_class", false]], "validate_class() (simplepump class method)": [[156, "engforge.eng.thermodynamics.SimplePump.validate_class", false]], "validate_class() (simpleturbine class method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.validate_class", false]], "validate_class() (solidmaterial class method)": [[146, "engforge.eng.solid_materials.SolidMaterial.validate_class", false]], "validate_class() (solveableinterface class method)": [[49, "engforge.components.SolveableInterface.validate_class", false]], "validate_class() (ss_316 class method)": [[145, "engforge.eng.solid_materials.SS_316.validate_class", false]], "validate_class() (steam class method)": [[110, "engforge.eng.fluid_material.Steam.validate_class", false]], "validate_class() (system class method)": [[240, "engforge.system.System.validate_class", false]], "validate_class() (triangle class method)": [[120, "engforge.eng.geometry.Triangle.validate_class", false]], "validate_class() (water class method)": [[111, "engforge.eng.fluid_material.Water.validate_class", false]], "validate_class() (wetsoil class method)": [[147, "engforge.eng.solid_materials.WetSoil.validate_class", false]], "validate_plot_args() (plot class method)": [[9, "engforge.attr_plotting.Plot.validate_plot_args", false]], "validate_plot_args() (plotbase class method)": [[10, "engforge.attr_plotting.PlotBase.validate_plot_args", false]], "validate_plot_args() (trace class method)": [[14, "engforge.attr_plotting.Trace.validate_plot_args", false]], "values() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.values", false]], "viscosity (fluidmaterial property)": [[101, "engforge.eng.fluid_material.FluidMaterial.viscosity", false]], "von_mises_stress_max() (aluminum method)": [[139, "engforge.eng.solid_materials.Aluminum.von_mises_stress_max", false]], "von_mises_stress_max() (ansi_4130 method)": [[137, "engforge.eng.solid_materials.ANSI_4130.von_mises_stress_max", false]], "von_mises_stress_max() (ansi_4340 method)": [[138, "engforge.eng.solid_materials.ANSI_4340.von_mises_stress_max", false]], "von_mises_stress_max() (carbonfiber method)": [[140, "engforge.eng.solid_materials.CarbonFiber.von_mises_stress_max", false]], "von_mises_stress_max() (concrete method)": [[141, "engforge.eng.solid_materials.Concrete.von_mises_stress_max", false]], "von_mises_stress_max() (drysoil method)": [[142, "engforge.eng.solid_materials.DrySoil.von_mises_stress_max", false]], "von_mises_stress_max() (rock method)": [[143, "engforge.eng.solid_materials.Rock.von_mises_stress_max", false]], "von_mises_stress_max() (rubber method)": [[144, "engforge.eng.solid_materials.Rubber.von_mises_stress_max", false]], "von_mises_stress_max() (solidmaterial method)": [[146, "engforge.eng.solid_materials.SolidMaterial.von_mises_stress_max", false]], "von_mises_stress_max() (ss_316 method)": [[145, "engforge.eng.solid_materials.SS_316.von_mises_stress_max", false]], "von_mises_stress_max() (wetsoil method)": [[147, "engforge.eng.solid_materials.WetSoil.von_mises_stress_max", false]], "warning() (air method)": [[97, "engforge.eng.fluid_material.Air.warning", false]], "warning() (airwatermix method)": [[98, "engforge.eng.fluid_material.AirWaterMix.warning", false]], "warning() (aluminum method)": [[139, "engforge.eng.solid_materials.Aluminum.warning", false]], "warning() (analysis method)": [[2, "engforge.analysis.Analysis.warning", false]], "warning() (ansi_4130 method)": [[137, "engforge.eng.solid_materials.ANSI_4130.warning", false]], "warning() (ansi_4340 method)": [[138, "engforge.eng.solid_materials.ANSI_4340.warning", false]], "warning() (attributedbasemixin method)": [[164, "engforge.engforge_attributes.AttributedBaseMixin.warning", false]], "warning() (attrlog method)": [[32, "engforge.attributes.ATTRLog.warning", false]], "warning() (attrsolverlog method)": [[28, "engforge.attr_solver.AttrSolverLog.warning", false]], "warning() (beam method)": [[151, "engforge.eng.structure_beams.Beam.warning", false]], "warning() (carbonfiber method)": [[140, "engforge.eng.solid_materials.CarbonFiber.warning", false]], "warning() (circle method)": [[113, "engforge.eng.geometry.Circle.warning", false]], "warning() (component method)": [[48, "engforge.components.Component.warning", false]], "warning() (componentdict method)": [[42, "engforge.component_collections.ComponentDict.warning", false]], "warning() (componentiter method)": [[43, "engforge.component_collections.ComponentIter.warning", false]], "warning() (componentiterator method)": [[44, "engforge.component_collections.ComponentIterator.warning", false]], "warning() (concrete method)": [[141, "engforge.eng.solid_materials.Concrete.warning", false]], "warning() (configlog method)": [[51, "engforge.configuration.ConfigLog.warning", false]], "warning() (configuration method)": [[52, "engforge.configuration.Configuration.warning", false]], "warning() (coolpropmaterial method)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.warning", false]], "warning() (coolpropmixture method)": [[100, "engforge.eng.fluid_material.CoolPropMixture.warning", false]], "warning() (costlog method)": [[90, "engforge.eng.costs.CostLog.warning", false]], "warning() (costmodel method)": [[91, "engforge.eng.costs.CostModel.warning", false]], "warning() (csvreporter method)": [[206, "engforge.reporting.CSVReporter.warning", false]], "warning() (dataframelog method)": [[61, "engforge.dataframe.DataFrameLog.warning", false]], "warning() (dbconnection method)": [[72, "engforge.datastores.data.DBConnection.warning", false]], "warning() (diskcachestore method)": [[73, "engforge.datastores.data.DiskCacheStore.warning", false]], "warning() (diskplotreporter method)": [[207, "engforge.reporting.DiskPlotReporter.warning", false]], "warning() (diskreportermixin method)": [[208, "engforge.reporting.DiskReporterMixin.warning", false]], "warning() (drysoil method)": [[142, "engforge.eng.solid_materials.DrySoil.warning", false]], "warning() (dynamicsmixin method)": [[84, "engforge.dynamics.DynamicsMixin.warning", false]], "warning() (economics method)": [[92, "engforge.eng.costs.Economics.warning", false]], "warning() (engattr method)": [[165, "engforge.engforge_attributes.EngAttr.warning", false]], "warning() (envvariable method)": [[168, "engforge.env_var.EnvVariable.warning", false]], "warning() (excelreporter method)": [[209, "engforge.reporting.ExcelReporter.warning", false]], "warning() (flowinput method)": [[125, "engforge.eng.pipes.FlowInput.warning", false]], "warning() (flownode method)": [[126, "engforge.eng.pipes.FlowNode.warning", false]], "warning() (fluidmaterial method)": [[101, "engforge.eng.fluid_material.FluidMaterial.warning", false]], "warning() (forgelog method)": [[36, "engforge.common.ForgeLog.warning", false]], "warning() (gdrivereporter method)": [[210, "engforge.reporting.GdriveReporter.warning", false]], "warning() (geometrylog method)": [[114, "engforge.eng.geometry.GeometryLog.warning", false]], "warning() (globaldynamics method)": [[85, "engforge.dynamics.GlobalDynamics.warning", false]], "warning() (gsheetsreporter method)": [[211, "engforge.reporting.GsheetsReporter.warning", false]], "warning() (hollowcircle method)": [[115, "engforge.eng.geometry.HollowCircle.warning", false]], "warning() (hydrogen method)": [[102, "engforge.eng.fluid_material.Hydrogen.warning", false]], "warning() (idealair method)": [[103, "engforge.eng.fluid_material.IdealAir.warning", false]], "warning() (idealgas method)": [[104, "engforge.eng.fluid_material.IdealGas.warning", false]], "warning() (idealh2 method)": [[105, "engforge.eng.fluid_material.IdealH2.warning", false]], "warning() (idealoxygen method)": [[106, "engforge.eng.fluid_material.IdealOxygen.warning", false]], "warning() (idealsteam method)": [[107, "engforge.eng.fluid_material.IdealSteam.warning", false]], "warning() (log method)": [[173, "engforge.logging.Log.warning", false]], "warning() (loggingmixin method)": [[174, "engforge.logging.LoggingMixin.warning", false]], "warning() (oxygen method)": [[108, "engforge.eng.fluid_material.Oxygen.warning", false]], "warning() (pipe method)": [[127, "engforge.eng.pipes.Pipe.warning", false]], "warning() (pipefitting method)": [[128, "engforge.eng.pipes.PipeFitting.warning", false]], "warning() (pipeflow method)": [[129, "engforge.eng.pipes.PipeFlow.warning", false]], "warning() (pipelog method)": [[130, "engforge.eng.pipes.PipeLog.warning", false]], "warning() (pipenode method)": [[131, "engforge.eng.pipes.PipeNode.warning", false]], "warning() (pipesystem method)": [[132, "engforge.eng.pipes.PipeSystem.warning", false]], "warning() (plotlog method)": [[12, "engforge.attr_plotting.PlotLog.warning", false]], "warning() (plotreporter method)": [[212, "engforge.reporting.PlotReporter.warning", false]], "warning() (problog method)": [[187, "engforge.problem_context.ProbLog.warning", false]], "warning() (profile2d method)": [[117, "engforge.eng.geometry.Profile2D.warning", false]], "warning() (propertylog method)": [[193, "engforge.properties.PropertyLog.warning", false]], "warning() (pump method)": [[133, "engforge.eng.pipes.Pump.warning", false]], "warning() (rectangle method)": [[118, "engforge.eng.geometry.Rectangle.warning", false]], "warning() (reflog method)": [[244, "engforge.system_reference.RefLog.warning", false]], "warning() (reporter method)": [[213, "engforge.reporting.Reporter.warning", false]], "warning() (rock method)": [[143, "engforge.eng.solid_materials.Rock.warning", false]], "warning() (rubber method)": [[144, "engforge.eng.solid_materials.Rubber.warning", false]], "warning() (seawater method)": [[109, "engforge.eng.fluid_material.SeaWater.warning", false]], "warning() (shapelysection method)": [[119, "engforge.eng.geometry.ShapelySection.warning", false]], "warning() (simplecompressor method)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.warning", false]], "warning() (simpleheatexchanger method)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.warning", false]], "warning() (simplepump method)": [[156, "engforge.eng.thermodynamics.SimplePump.warning", false]], "warning() (simpleturbine method)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.warning", false]], "warning() (slotlog method)": [[26, "engforge.attr_slots.SlotLog.warning", false]], "warning() (solidmaterial method)": [[146, "engforge.eng.solid_materials.SolidMaterial.warning", false]], "warning() (solvablelog method)": [[218, "engforge.solveable.SolvableLog.warning", false]], "warning() (solveableinterface method)": [[49, "engforge.components.SolveableInterface.warning", false]], "warning() (solveablemixin method)": [[219, "engforge.solveable.SolveableMixin.warning", false]], "warning() (solverlog method)": [[221, "engforge.solver.SolverLog.warning", false]], "warning() (solvermixin method)": [[222, "engforge.solver.SolverMixin.warning", false]], "warning() (solverutillog method)": [[224, "engforge.solver_utils.SolverUtilLog.warning", false]], "warning() (ss_316 method)": [[145, "engforge.eng.solid_materials.SS_316.warning", false]], "warning() (steam method)": [[110, "engforge.eng.fluid_material.Steam.warning", false]], "warning() (system method)": [[240, "engforge.system.System.warning", false]], "warning() (systemslog method)": [[241, "engforge.system.SystemsLog.warning", false]], "warning() (tablelog method)": [[252, "engforge.tabulation.TableLog.warning", false]], "warning() (tablereporter method)": [[214, "engforge.reporting.TableReporter.warning", false]], "warning() (tabulationmixin method)": [[253, "engforge.tabulation.TabulationMixin.warning", false]], "warning() (temporalreportermixin method)": [[215, "engforge.reporting.TemporalReporterMixin.warning", false]], "warning() (triangle method)": [[120, "engforge.eng.geometry.Triangle.warning", false]], "warning() (water method)": [[111, "engforge.eng.fluid_material.Water.warning", false]], "warning() (wetsoil method)": [[147, "engforge.eng.solid_materials.WetSoil.warning", false]], "water (class in engforge.eng.fluid_material)": [[111, "engforge.eng.fluid_material.Water", false]], "wetsoil (class in engforge.eng.solid_materials)": [[147, "engforge.eng.solid_materials.WetSoil", false]], "xt_ref (air property)": [[97, "engforge.eng.fluid_material.Air.Xt_ref", false]], "xt_ref (airwatermix property)": [[98, "engforge.eng.fluid_material.AirWaterMix.Xt_ref", false]], "xt_ref (beam property)": [[151, "engforge.eng.structure_beams.Beam.Xt_ref", false]], "xt_ref (component property)": [[48, "engforge.components.Component.Xt_ref", false]], "xt_ref (componentdict property)": [[42, "engforge.component_collections.ComponentDict.Xt_ref", false]], "xt_ref (componentiter property)": [[43, "engforge.component_collections.ComponentIter.Xt_ref", false]], "xt_ref (componentiterator property)": [[44, "engforge.component_collections.ComponentIterator.Xt_ref", false]], "xt_ref (coolpropmaterial property)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.Xt_ref", false]], "xt_ref (coolpropmixture property)": [[100, "engforge.eng.fluid_material.CoolPropMixture.Xt_ref", false]], "xt_ref (dynamicsmixin property)": [[84, "engforge.dynamics.DynamicsMixin.Xt_ref", false]], "xt_ref (economics property)": [[92, "engforge.eng.costs.Economics.Xt_ref", false]], "xt_ref (flowinput property)": [[125, "engforge.eng.pipes.FlowInput.Xt_ref", false]], "xt_ref (flownode property)": [[126, "engforge.eng.pipes.FlowNode.Xt_ref", false]], "xt_ref (fluidmaterial property)": [[101, "engforge.eng.fluid_material.FluidMaterial.Xt_ref", false]], "xt_ref (globaldynamics property)": [[85, "engforge.dynamics.GlobalDynamics.Xt_ref", false]], "xt_ref (hydrogen property)": [[102, "engforge.eng.fluid_material.Hydrogen.Xt_ref", false]], "xt_ref (idealair property)": [[103, "engforge.eng.fluid_material.IdealAir.Xt_ref", false]], "xt_ref (idealgas property)": [[104, "engforge.eng.fluid_material.IdealGas.Xt_ref", false]], "xt_ref (idealh2 property)": [[105, "engforge.eng.fluid_material.IdealH2.Xt_ref", false]], "xt_ref (idealoxygen property)": [[106, "engforge.eng.fluid_material.IdealOxygen.Xt_ref", false]], "xt_ref (idealsteam property)": [[107, "engforge.eng.fluid_material.IdealSteam.Xt_ref", false]], "xt_ref (oxygen property)": [[108, "engforge.eng.fluid_material.Oxygen.Xt_ref", false]], "xt_ref (pipe property)": [[127, "engforge.eng.pipes.Pipe.Xt_ref", false]], "xt_ref (pipefitting property)": [[128, "engforge.eng.pipes.PipeFitting.Xt_ref", false]], "xt_ref (pipeflow property)": [[129, "engforge.eng.pipes.PipeFlow.Xt_ref", false]], "xt_ref (pipenode property)": [[131, "engforge.eng.pipes.PipeNode.Xt_ref", false]], "xt_ref (pipesystem property)": [[132, "engforge.eng.pipes.PipeSystem.Xt_ref", false]], "xt_ref (pump property)": [[133, "engforge.eng.pipes.Pump.Xt_ref", false]], "xt_ref (seawater property)": [[109, "engforge.eng.fluid_material.SeaWater.Xt_ref", false]], "xt_ref (simplecompressor property)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.Xt_ref", false]], "xt_ref (simpleheatexchanger property)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.Xt_ref", false]], "xt_ref (simplepump property)": [[156, "engforge.eng.thermodynamics.SimplePump.Xt_ref", false]], "xt_ref (simpleturbine property)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.Xt_ref", false]], "xt_ref (steam property)": [[110, "engforge.eng.fluid_material.Steam.Xt_ref", false]], "xt_ref (system property)": [[240, "engforge.system.System.Xt_ref", false]], "xt_ref (water property)": [[111, "engforge.eng.fluid_material.Water.Xt_ref", false]], "yt_ref (air property)": [[97, "engforge.eng.fluid_material.Air.Yt_ref", false]], "yt_ref (airwatermix property)": [[98, "engforge.eng.fluid_material.AirWaterMix.Yt_ref", false]], "yt_ref (beam property)": [[151, "engforge.eng.structure_beams.Beam.Yt_ref", false]], "yt_ref (component property)": [[48, "engforge.components.Component.Yt_ref", false]], "yt_ref (componentdict property)": [[42, "engforge.component_collections.ComponentDict.Yt_ref", false]], "yt_ref (componentiter property)": [[43, "engforge.component_collections.ComponentIter.Yt_ref", false]], "yt_ref (componentiterator property)": [[44, "engforge.component_collections.ComponentIterator.Yt_ref", false]], "yt_ref (coolpropmaterial property)": [[99, "engforge.eng.fluid_material.CoolPropMaterial.Yt_ref", false]], "yt_ref (coolpropmixture property)": [[100, "engforge.eng.fluid_material.CoolPropMixture.Yt_ref", false]], "yt_ref (dynamicsmixin property)": [[84, "engforge.dynamics.DynamicsMixin.Yt_ref", false]], "yt_ref (economics property)": [[92, "engforge.eng.costs.Economics.Yt_ref", false]], "yt_ref (flowinput property)": [[125, "engforge.eng.pipes.FlowInput.Yt_ref", false]], "yt_ref (flownode property)": [[126, "engforge.eng.pipes.FlowNode.Yt_ref", false]], "yt_ref (fluidmaterial property)": [[101, "engforge.eng.fluid_material.FluidMaterial.Yt_ref", false]], "yt_ref (globaldynamics property)": [[85, "engforge.dynamics.GlobalDynamics.Yt_ref", false]], "yt_ref (hydrogen property)": [[102, "engforge.eng.fluid_material.Hydrogen.Yt_ref", false]], "yt_ref (idealair property)": [[103, "engforge.eng.fluid_material.IdealAir.Yt_ref", false]], "yt_ref (idealgas property)": [[104, "engforge.eng.fluid_material.IdealGas.Yt_ref", false]], "yt_ref (idealh2 property)": [[105, "engforge.eng.fluid_material.IdealH2.Yt_ref", false]], "yt_ref (idealoxygen property)": [[106, "engforge.eng.fluid_material.IdealOxygen.Yt_ref", false]], "yt_ref (idealsteam property)": [[107, "engforge.eng.fluid_material.IdealSteam.Yt_ref", false]], "yt_ref (oxygen property)": [[108, "engforge.eng.fluid_material.Oxygen.Yt_ref", false]], "yt_ref (pipe property)": [[127, "engforge.eng.pipes.Pipe.Yt_ref", false]], "yt_ref (pipefitting property)": [[128, "engforge.eng.pipes.PipeFitting.Yt_ref", false]], "yt_ref (pipeflow property)": [[129, "engforge.eng.pipes.PipeFlow.Yt_ref", false]], "yt_ref (pipenode property)": [[131, "engforge.eng.pipes.PipeNode.Yt_ref", false]], "yt_ref (pipesystem property)": [[132, "engforge.eng.pipes.PipeSystem.Yt_ref", false]], "yt_ref (pump property)": [[133, "engforge.eng.pipes.Pump.Yt_ref", false]], "yt_ref (seawater property)": [[109, "engforge.eng.fluid_material.SeaWater.Yt_ref", false]], "yt_ref (simplecompressor property)": [[154, "engforge.eng.thermodynamics.SimpleCompressor.Yt_ref", false]], "yt_ref (simpleheatexchanger property)": [[155, "engforge.eng.thermodynamics.SimpleHeatExchanger.Yt_ref", false]], "yt_ref (simplepump property)": [[156, "engforge.eng.thermodynamics.SimplePump.Yt_ref", false]], "yt_ref (simpleturbine property)": [[157, "engforge.eng.thermodynamics.SimpleTurbine.Yt_ref", false]], "yt_ref (steam property)": [[110, "engforge.eng.fluid_material.Steam.Yt_ref", false]], "yt_ref (system property)": [[240, "engforge.system.System.Yt_ref", false]], "yt_ref (water property)": [[111, "engforge.eng.fluid_material.Water.Yt_ref", false]]}, "objects": {"": [[0, 0, 0, "-", "engforge"], [259, 0, 0, "-", "examples"], [262, 0, 0, "-", "test"]], "engforge": [[1, 0, 0, "-", "analysis"], [4, 0, 0, "-", "attr_dynamics"], [8, 0, 0, "-", "attr_plotting"], [21, 0, 0, "-", "attr_signals"], [24, 0, 0, "-", "attr_slots"], [27, 0, 0, "-", "attr_solver"], [31, 0, 0, "-", "attributes"], [35, 0, 0, "-", "common"], [41, 0, 0, "-", "component_collections"], [47, 0, 0, "-", "components"], [50, 0, 0, "-", "configuration"], [60, 0, 0, "-", "dataframe"], [70, 0, 0, "-", "datastores"], [83, 0, 0, "-", "dynamics"], [88, 0, 0, "-", "eng"], [163, 0, 0, "-", "engforge_attributes"], [167, 0, 0, "-", "env_var"], [170, 0, 0, "-", "locations"], [172, 0, 0, "-", "logging"], [176, 0, 0, "-", "patterns"], [185, 0, 0, "-", "problem_context"], [192, 0, 0, "-", "properties"], [205, 0, 0, "-", "reporting"], [217, 0, 0, "-", "solveable"], [220, 0, 0, "-", "solver"], [223, 0, 0, "-", "solver_utils"], [239, 0, 0, "-", "system"], [242, 0, 0, "-", "system_reference"], [251, 0, 0, "-", "tabulation"], [254, 0, 0, "-", "typing"]], "engforge.analysis": [[2, 1, 1, "", "Analysis"], [3, 4, 1, "", "make_reporter_check"]], "engforge.analysis.Analysis": [[2, 2, 1, "", "add_fields"], [2, 3, 1, "", "anything_changed"], [2, 3, 1, "", "as_dict"], [2, 2, 1, "", "check_ref_slot_type"], [2, 3, 1, "", "classname"], [2, 2, 1, "", "cls_compile"], [2, 2, 1, "", "collect_all_attributes"], [2, 2, 1, "", "collect_comp_refs"], [2, 2, 1, "", "collect_dynamic_refs"], [2, 2, 1, "", "collect_inst_attributes"], [2, 2, 1, "", "collect_post_update_refs"], [2, 2, 1, "", "collect_solver_refs"], [2, 2, 1, "", "collect_update_refs"], [2, 2, 1, "", "comp_references"], [2, 2, 1, "", "compile_classes"], [2, 2, 1, "", "copy_config_at_state"], [2, 2, 1, "", "critical"], [2, 3, 1, "", "data_dict"], [2, 3, 1, "", "dataframe"], [2, 2, 1, "", "debug"], [2, 2, 1, "", "difference"], [2, 2, 1, "", "error"], [2, 3, 1, "", "filename"], [2, 2, 1, "", "filter"], [2, 2, 1, "", "get_system_input_refs"], [2, 2, 1, "", "go_through_configurations"], [2, 3, 1, "", "identity"], [2, 2, 1, "", "info"], [2, 3, 1, "", "input_as_dict"], [2, 2, 1, "", "input_fields"], [2, 2, 1, "", "installSTDLogger"], [2, 2, 1, "", "internal_components"], [2, 2, 1, "", "internal_configurations"], [2, 2, 1, "", "internal_references"], [2, 2, 1, "", "internal_systems"], [2, 2, 1, "", "internal_tabulations"], [2, 3, 1, "", "last_context"], [2, 2, 1, "", "locate"], [2, 2, 1, "", "locate_ref"], [2, 2, 1, "", "make_plots"], [2, 2, 1, "", "message_with_identiy"], [2, 2, 1, "", "msg"], [2, 2, 1, "", "parent_configurations_cls"], [2, 2, 1, "", "parse_run_kwargs"], [2, 2, 1, "", "parse_simulation_input"], [2, 2, 1, "", "plot_attributes"], [2, 3, 1, "", "plotable_variables"], [2, 2, 1, "", "post_process"], [2, 2, 1, "", "post_update"], [2, 2, 1, "", "pre_compile"], [2, 2, 1, "", "resetLog"], [2, 2, 1, "", "resetSystemLogs"], [2, 2, 1, "", "run"], [2, 2, 1, "", "setattrs"], [2, 2, 1, "", "signals_attributes"], [2, 3, 1, "", "skip_plot_vars"], [2, 2, 1, "", "slot_refs"], [2, 2, 1, "", "slots_attributes"], [2, 2, 1, "", "smart_split_dataframe"], [2, 2, 1, "", "solvers_attributes"], [2, 2, 1, "", "subclasses"], [2, 2, 1, "", "subcls_compile"], [2, 3, 1, "", "system_id"], [2, 2, 1, "", "system_properties_classdef"], [2, 2, 1, "", "system_references"], [2, 2, 1, "", "trace_attributes"], [2, 2, 1, "", "transients_attributes"], [2, 2, 1, "", "update"], [2, 2, 1, "", "validate_class"], [2, 2, 1, "", "warning"]], "engforge.attr_dynamics": [[5, 1, 1, "", "IntegratorInstance"], [6, 5, 1, "", "TRANSIENT"], [7, 1, 1, "", "Time"]], "engforge.attr_dynamics.Time": [[7, 2, 1, "", "add_var_constraint"], [7, 2, 1, "", "class_validate"], [7, 2, 1, "", "collect_attr_inst"], [7, 2, 1, "", "collect_cls"], [7, 2, 1, "", "configure_for_system"], [7, 2, 1, "", "configure_instance"], [7, 2, 1, "", "constraint_exists"], [7, 2, 1, "", "create_instance"], [7, 2, 1, "", "define"], [7, 2, 1, "", "define_validate"], [7, 2, 1, "", "evolve"], [7, 2, 1, "", "handle_instance"], [7, 5, 1, "", "instance_class"], [7, 2, 1, "", "integrate"], [7, 2, 1, "", "make_attribute"], [7, 2, 1, "", "subclasses"]], "engforge.attr_plotting": [[9, 1, 1, "", "Plot"], [10, 1, 1, "", "PlotBase"], [11, 1, 1, "", "PlotInstance"], [12, 1, 1, "", "PlotLog"], [13, 1, 1, "", "PlottingMixin"], [14, 1, 1, "", "Trace"], [15, 1, 1, "", "TraceInstance"], [16, 4, 1, "", "conv_ctx"], [17, 4, 1, "", "conv_maps"], [18, 4, 1, "", "conv_theme"], [19, 4, 1, "", "install_seaborn"], [20, 4, 1, "", "save_all_figures_to_pdf"]], "engforge.attr_plotting.Plot": [[9, 2, 1, "", "class_validate"], [9, 2, 1, "", "collect_attr_inst"], [9, 2, 1, "", "collect_cls"], [9, 2, 1, "", "configure_for_system"], [9, 2, 1, "", "configure_instance"], [9, 2, 1, "", "create_instance"], [9, 2, 1, "", "define"], [9, 2, 1, "", "define_validate"], [9, 2, 1, "", "evolve"], [9, 2, 1, "", "handle_instance"], [9, 5, 1, "", "instance_class"], [9, 2, 1, "", "make_attribute"], [9, 2, 1, "", "plot_vars"], [9, 2, 1, "", "subclasses"], [9, 2, 1, "", "validate_plot_args"]], "engforge.attr_plotting.PlotBase": [[10, 2, 1, "", "class_validate"], [10, 2, 1, "", "collect_attr_inst"], [10, 2, 1, "", "collect_cls"], [10, 2, 1, "", "configure_for_system"], [10, 2, 1, "", "configure_instance"], [10, 2, 1, "", "create_instance"], [10, 2, 1, "", "define"], [10, 2, 1, "", "define_validate"], [10, 2, 1, "", "evolve"], [10, 2, 1, "", "handle_instance"], [10, 5, 1, "", "instance_class"], [10, 2, 1, "", "make_attribute"], [10, 2, 1, "", "plot_vars"], [10, 2, 1, "", "subclasses"], [10, 2, 1, "", "validate_plot_args"]], "engforge.attr_plotting.PlotInstance": [[11, 2, 1, "", "__call__"], [11, 2, 1, "", "plot"]], "engforge.attr_plotting.PlotLog": [[12, 2, 1, "", "add_fields"], [12, 2, 1, "", "critical"], [12, 2, 1, "", "debug"], [12, 2, 1, "", "error"], [12, 2, 1, "", "filter"], [12, 2, 1, "", "info"], [12, 2, 1, "", "installSTDLogger"], [12, 2, 1, "", "message_with_identiy"], [12, 2, 1, "", "msg"], [12, 2, 1, "", "resetLog"], [12, 2, 1, "", "resetSystemLogs"], [12, 2, 1, "", "warning"]], "engforge.attr_plotting.PlottingMixin": [[13, 2, 1, "", "make_plots"]], "engforge.attr_plotting.Trace": [[14, 2, 1, "", "class_validate"], [14, 2, 1, "", "collect_attr_inst"], [14, 2, 1, "", "collect_cls"], [14, 2, 1, "", "configure_for_system"], [14, 2, 1, "", "configure_instance"], [14, 2, 1, "", "create_instance"], [14, 2, 1, "", "define"], [14, 2, 1, "", "define_validate"], [14, 2, 1, "", "evolve"], [14, 2, 1, "", "handle_instance"], [14, 5, 1, "", "instance_class"], [14, 2, 1, "", "make_attribute"], [14, 2, 1, "", "plot_vars"], [14, 2, 1, "", "subclasses"], [14, 2, 1, "", "validate_plot_args"]], "engforge.attr_plotting.TraceInstance": [[15, 2, 1, "", "__call__"], [15, 2, 1, "", "plot"]], "engforge.attr_signals": [[22, 1, 1, "", "Signal"], [23, 1, 1, "", "SignalInstance"]], "engforge.attr_signals.Signal": [[22, 2, 1, "", "class_validate"], [22, 2, 1, "", "collect_attr_inst"], [22, 2, 1, "", "collect_cls"], [22, 2, 1, "", "configure_for_system"], [22, 2, 1, "", "configure_instance"], [22, 2, 1, "", "create_instance"], [22, 2, 1, "", "define"], [22, 2, 1, "", "define_validate"], [22, 2, 1, "", "evolve"], [22, 2, 1, "", "handle_instance"], [22, 5, 1, "", "instance_class"], [22, 2, 1, "", "make_attribute"], [22, 2, 1, "", "subclasses"]], "engforge.attr_signals.SignalInstance": [[23, 2, 1, "", "apply"]], "engforge.attr_slots": [[25, 1, 1, "", "Slot"], [26, 1, 1, "", "SlotLog"]], "engforge.attr_slots.Slot": [[25, 2, 1, "", "class_validate"], [25, 2, 1, "", "collect_attr_inst"], [25, 2, 1, "", "collect_cls"], [25, 2, 1, "", "configure_for_system"], [25, 2, 1, "", "configure_instance"], [25, 2, 1, "", "create_instance"], [25, 2, 1, "", "define"], [25, 2, 1, "", "define_iterator"], [25, 2, 1, "", "define_validate"], [25, 2, 1, "", "evolve"], [25, 2, 1, "", "handle_instance"], [25, 2, 1, "", "make_attribute"], [25, 2, 1, "", "subclasses"]], "engforge.attr_slots.SlotLog": [[26, 2, 1, "", "add_fields"], [26, 2, 1, "", "critical"], [26, 2, 1, "", "debug"], [26, 2, 1, "", "error"], [26, 2, 1, "", "filter"], [26, 2, 1, "", "info"], [26, 2, 1, "", "installSTDLogger"], [26, 2, 1, "", "message_with_identiy"], [26, 2, 1, "", "msg"], [26, 2, 1, "", "resetLog"], [26, 2, 1, "", "resetSystemLogs"], [26, 2, 1, "", "warning"]], "engforge.attr_solver": [[28, 1, 1, "", "AttrSolverLog"], [29, 1, 1, "", "Solver"], [30, 1, 1, "", "SolverInstance"]], "engforge.attr_solver.AttrSolverLog": [[28, 2, 1, "", "add_fields"], [28, 2, 1, "", "critical"], [28, 2, 1, "", "debug"], [28, 2, 1, "", "error"], [28, 2, 1, "", "filter"], [28, 2, 1, "", "info"], [28, 2, 1, "", "installSTDLogger"], [28, 2, 1, "", "message_with_identiy"], [28, 2, 1, "", "msg"], [28, 2, 1, "", "resetLog"], [28, 2, 1, "", "resetSystemLogs"], [28, 2, 1, "", "warning"]], "engforge.attr_solver.Solver": [[29, 2, 1, "", "add_var_constraint"], [29, 2, 1, "", "class_validate"], [29, 2, 1, "", "collect_attr_inst"], [29, 2, 1, "", "collect_cls"], [29, 2, 1, "", "con_eq"], [29, 2, 1, "", "con_ineq"], [29, 2, 1, "", "configure_for_system"], [29, 2, 1, "", "configure_instance"], [29, 2, 1, "", "constraint_equality"], [29, 2, 1, "", "constraint_exists"], [29, 2, 1, "", "constraint_inequality"], [29, 2, 1, "", "create_instance"], [29, 2, 1, "", "declare_var"], [29, 5, 1, "", "define"], [29, 2, 1, "", "define_validate"], [29, 2, 1, "", "evolve"], [29, 2, 1, "", "handle_instance"], [29, 5, 1, "", "instance_class"], [29, 2, 1, "", "make_attribute"], [29, 2, 1, "", "obj"], [29, 2, 1, "", "objective"], [29, 2, 1, "", "subclasses"]], "engforge.attr_solver.SolverInstance": [[30, 2, 1, "", "compile"]], "engforge.attributes": [[32, 1, 1, "", "ATTRLog"], [33, 1, 1, "", "ATTR_BASE"], [34, 1, 1, "", "AttributeInstance"]], "engforge.attributes.ATTRLog": [[32, 2, 1, "", "add_fields"], [32, 2, 1, "", "critical"], [32, 2, 1, "", "debug"], [32, 2, 1, "", "error"], [32, 2, 1, "", "filter"], [32, 2, 1, "", "info"], [32, 2, 1, "", "installSTDLogger"], [32, 2, 1, "", "message_with_identiy"], [32, 2, 1, "", "msg"], [32, 2, 1, "", "resetLog"], [32, 2, 1, "", "resetSystemLogs"], [32, 2, 1, "", "warning"]], "engforge.attributes.ATTR_BASE": [[33, 2, 1, "", "class_validate"], [33, 2, 1, "", "collect_attr_inst"], [33, 2, 1, "", "collect_cls"], [33, 2, 1, "", "configure_for_system"], [33, 2, 1, "", "configure_instance"], [33, 2, 1, "", "create_instance"], [33, 2, 1, "", "define"], [33, 2, 1, "", "define_validate"], [33, 2, 1, "", "evolve"], [33, 2, 1, "", "handle_instance"], [33, 2, 1, "", "make_attribute"], [33, 2, 1, "", "subclasses"]], "engforge.common": [[36, 1, 1, "", "ForgeLog"], [37, 4, 1, "", "chunks"], [38, 4, 1, "", "get_size"], [39, 1, 1, "", "inst_vectorize"], [40, 4, 1, "", "is_ec2_instance"]], "engforge.common.ForgeLog": [[36, 2, 1, "", "add_fields"], [36, 2, 1, "", "critical"], [36, 2, 1, "", "debug"], [36, 2, 1, "", "error"], [36, 2, 1, "", "filter"], [36, 2, 1, "", "info"], [36, 2, 1, "", "installSTDLogger"], [36, 2, 1, "", "message_with_identiy"], [36, 2, 1, "", "msg"], [36, 2, 1, "", "resetLog"], [36, 2, 1, "", "resetSystemLogs"], [36, 2, 1, "", "warning"]], "engforge.common.inst_vectorize": [[39, 2, 1, "", "__call__"]], "engforge.component_collections": [[42, 1, 1, "", "ComponentDict"], [43, 1, 1, "", "ComponentIter"], [44, 1, 1, "", "ComponentIterator"], [45, 4, 1, "", "check_comp_type"], [46, 1, 1, "", "iter_tkn"]], "engforge.component_collections.ComponentDict": [[42, 3, 1, "", "Ut_ref"], [42, 3, 1, "", "Xt_ref"], [42, 3, 1, "", "Yt_ref"], [42, 2, 1, "", "add_fields"], [42, 3, 1, "", "anything_changed"], [42, 3, 1, "", "as_dict"], [42, 2, 1, "", "check_ref_slot_type"], [42, 3, 1, "", "classname"], [42, 2, 1, "", "clear"], [42, 2, 1, "", "cls_compile"], [42, 2, 1, "", "collect_all_attributes"], [42, 2, 1, "", "collect_comp_refs"], [42, 2, 1, "", "collect_dynamic_refs"], [42, 2, 1, "", "collect_inst_attributes"], [42, 2, 1, "", "collect_post_update_refs"], [42, 2, 1, "", "collect_solver_refs"], [42, 2, 1, "", "collect_update_refs"], [42, 2, 1, "", "comp_references"], [42, 2, 1, "", "compile_classes"], [42, 2, 1, "", "copy_config_at_state"], [42, 2, 1, "", "create_dynamic_matricies"], [42, 2, 1, "", "create_feedthrough_matrix"], [42, 2, 1, "", "create_input_matrix"], [42, 2, 1, "", "create_output_constants"], [42, 2, 1, "", "create_output_matrix"], [42, 2, 1, "", "create_state_constants"], [42, 2, 1, "", "create_state_matrix"], [42, 2, 1, "", "critical"], [42, 3, 1, "", "current"], [42, 3, 1, "", "dXtdt_ref"], [42, 3, 1, "", "data_dict"], [42, 2, 1, "", "debug"], [42, 2, 1, "", "determine_nearest_stationary_state"], [42, 2, 1, "", "difference"], [42, 2, 1, "", "error"], [42, 3, 1, "", "filename"], [42, 2, 1, "", "filter"], [42, 2, 1, "", "get"], [42, 2, 1, "", "get_system_input_refs"], [42, 2, 1, "", "go_through_configurations"], [42, 3, 1, "", "identity"], [42, 2, 1, "", "info"], [42, 3, 1, "", "input_as_dict"], [42, 2, 1, "", "input_fields"], [42, 2, 1, "", "installSTDLogger"], [42, 2, 1, "", "internal_components"], [42, 2, 1, "", "internal_configurations"], [42, 2, 1, "", "internal_references"], [42, 2, 1, "", "internal_systems"], [42, 2, 1, "", "internal_tabulations"], [42, 2, 1, "", "items"], [42, 2, 1, "", "keys"], [42, 3, 1, "", "last_context"], [42, 2, 1, "", "linear_output"], [42, 2, 1, "", "linear_step"], [42, 2, 1, "", "locate"], [42, 2, 1, "", "locate_ref"], [42, 2, 1, "", "message_with_identiy"], [42, 2, 1, "", "msg"], [42, 2, 1, "", "nonlinear_output"], [42, 2, 1, "", "nonlinear_step"], [42, 2, 1, "", "parent_configurations_cls"], [42, 2, 1, "", "parse_run_kwargs"], [42, 2, 1, "", "parse_simulation_input"], [42, 2, 1, "", "plot_attributes"], [42, 3, 1, "", "plotable_variables"], [42, 2, 1, "", "pop"], [42, 2, 1, "", "popitem"], [42, 2, 1, "", "post_update"], [42, 2, 1, "", "pre_compile"], [42, 2, 1, "", "rate"], [42, 2, 1, "", "rate_linear"], [42, 2, 1, "", "rate_nonlinear"], [42, 2, 1, "", "ref_dXdt"], [42, 2, 1, "", "resetLog"], [42, 2, 1, "", "resetSystemLogs"], [42, 2, 1, "", "set_time"], [42, 2, 1, "", "setattrs"], [42, 2, 1, "", "setdefault"], [42, 2, 1, "", "signals_attributes"], [42, 3, 1, "", "skip_plot_vars"], [42, 2, 1, "", "slot_refs"], [42, 2, 1, "", "slots_attributes"], [42, 2, 1, "", "smart_split_dataframe"], [42, 2, 1, "", "solvers_attributes"], [42, 2, 1, "", "subclasses"], [42, 2, 1, "", "subcls_compile"], [42, 3, 1, "", "system_id"], [42, 2, 1, "", "system_properties_classdef"], [42, 2, 1, "", "system_references"], [42, 2, 1, "", "trace_attributes"], [42, 2, 1, "", "transients_attributes"], [42, 2, 1, "", "update"], [42, 2, 1, "", "update_dynamics"], [42, 2, 1, "", "update_feedthrough"], [42, 2, 1, "", "update_input"], [42, 2, 1, "", "update_output_constants"], [42, 2, 1, "", "update_output_matrix"], [42, 2, 1, "", "update_state"], [42, 2, 1, "", "update_state_constants"], [42, 2, 1, "", "validate_class"], [42, 2, 1, "", "values"], [42, 2, 1, "", "warning"]], "engforge.component_collections.ComponentIter": [[43, 3, 1, "", "Ut_ref"], [43, 3, 1, "", "Xt_ref"], [43, 3, 1, "", "Yt_ref"], [43, 2, 1, "", "add_fields"], [43, 3, 1, "", "anything_changed"], [43, 3, 1, "", "as_dict"], [43, 2, 1, "", "check_ref_slot_type"], [43, 3, 1, "", "classname"], [43, 2, 1, "", "cls_compile"], [43, 2, 1, "", "collect_all_attributes"], [43, 2, 1, "", "collect_comp_refs"], [43, 2, 1, "", "collect_dynamic_refs"], [43, 2, 1, "", "collect_inst_attributes"], [43, 2, 1, "", "collect_post_update_refs"], [43, 2, 1, "", "collect_solver_refs"], [43, 2, 1, "", "collect_update_refs"], [43, 2, 1, "", "comp_references"], [43, 2, 1, "", "compile_classes"], [43, 2, 1, "", "copy_config_at_state"], [43, 2, 1, "", "create_dynamic_matricies"], [43, 2, 1, "", "create_feedthrough_matrix"], [43, 2, 1, "", "create_input_matrix"], [43, 2, 1, "", "create_output_constants"], [43, 2, 1, "", "create_output_matrix"], [43, 2, 1, "", "create_state_constants"], [43, 2, 1, "", "create_state_matrix"], [43, 2, 1, "", "critical"], [43, 3, 1, "", "current"], [43, 3, 1, "", "dXtdt_ref"], [43, 3, 1, "", "data_dict"], [43, 2, 1, "", "debug"], [43, 2, 1, "", "determine_nearest_stationary_state"], [43, 2, 1, "", "difference"], [43, 2, 1, "", "error"], [43, 3, 1, "", "filename"], [43, 2, 1, "", "filter"], [43, 2, 1, "", "get_system_input_refs"], [43, 2, 1, "", "go_through_configurations"], [43, 3, 1, "", "identity"], [43, 2, 1, "", "info"], [43, 3, 1, "", "input_as_dict"], [43, 2, 1, "", "input_fields"], [43, 2, 1, "", "installSTDLogger"], [43, 2, 1, "", "internal_components"], [43, 2, 1, "", "internal_configurations"], [43, 2, 1, "", "internal_references"], [43, 2, 1, "", "internal_systems"], [43, 2, 1, "", "internal_tabulations"], [43, 3, 1, "", "last_context"], [43, 2, 1, "", "linear_output"], [43, 2, 1, "", "linear_step"], [43, 2, 1, "", "locate"], [43, 2, 1, "", "locate_ref"], [43, 2, 1, "", "message_with_identiy"], [43, 2, 1, "", "msg"], [43, 2, 1, "", "nonlinear_output"], [43, 2, 1, "", "nonlinear_step"], [43, 2, 1, "", "parent_configurations_cls"], [43, 2, 1, "", "parse_run_kwargs"], [43, 2, 1, "", "parse_simulation_input"], [43, 2, 1, "", "plot_attributes"], [43, 3, 1, "", "plotable_variables"], [43, 2, 1, "", "post_update"], [43, 2, 1, "", "pre_compile"], [43, 2, 1, "", "rate"], [43, 2, 1, "", "rate_linear"], [43, 2, 1, "", "rate_nonlinear"], [43, 2, 1, "", "ref_dXdt"], [43, 2, 1, "", "resetLog"], [43, 2, 1, "", "resetSystemLogs"], [43, 2, 1, "", "set_time"], [43, 2, 1, "", "setattrs"], [43, 2, 1, "", "signals_attributes"], [43, 3, 1, "", "skip_plot_vars"], [43, 2, 1, "", "slot_refs"], [43, 2, 1, "", "slots_attributes"], [43, 2, 1, "", "smart_split_dataframe"], [43, 2, 1, "", "solvers_attributes"], [43, 2, 1, "", "subclasses"], [43, 2, 1, "", "subcls_compile"], [43, 3, 1, "", "system_id"], [43, 2, 1, "", "system_properties_classdef"], [43, 2, 1, "", "system_references"], [43, 2, 1, "", "trace_attributes"], [43, 2, 1, "", "transients_attributes"], [43, 2, 1, "", "update"], [43, 2, 1, "", "update_dynamics"], [43, 2, 1, "", "update_feedthrough"], [43, 2, 1, "", "update_input"], [43, 2, 1, "", "update_output_constants"], [43, 2, 1, "", "update_output_matrix"], [43, 2, 1, "", "update_state"], [43, 2, 1, "", "update_state_constants"], [43, 2, 1, "", "validate_class"], [43, 2, 1, "", "warning"]], "engforge.component_collections.ComponentIterator": [[44, 3, 1, "", "Ut_ref"], [44, 3, 1, "", "Xt_ref"], [44, 3, 1, "", "Yt_ref"], [44, 2, 1, "", "add_fields"], [44, 3, 1, "", "anything_changed"], [44, 2, 1, "", "append"], [44, 3, 1, "", "as_dict"], [44, 2, 1, "", "check_ref_slot_type"], [44, 3, 1, "", "classname"], [44, 2, 1, "", "clear"], [44, 2, 1, "", "cls_compile"], [44, 2, 1, "", "collect_all_attributes"], [44, 2, 1, "", "collect_comp_refs"], [44, 2, 1, "", "collect_dynamic_refs"], [44, 2, 1, "", "collect_inst_attributes"], [44, 2, 1, "", "collect_post_update_refs"], [44, 2, 1, "", "collect_solver_refs"], [44, 2, 1, "", "collect_update_refs"], [44, 2, 1, "", "comp_references"], [44, 2, 1, "", "compile_classes"], [44, 2, 1, "", "copy_config_at_state"], [44, 2, 1, "", "count"], [44, 2, 1, "", "create_dynamic_matricies"], [44, 2, 1, "", "create_feedthrough_matrix"], [44, 2, 1, "", "create_input_matrix"], [44, 2, 1, "", "create_output_constants"], [44, 2, 1, "", "create_output_matrix"], [44, 2, 1, "", "create_state_constants"], [44, 2, 1, "", "create_state_matrix"], [44, 2, 1, "", "critical"], [44, 3, 1, "", "current"], [44, 3, 1, "", "dXtdt_ref"], [44, 3, 1, "", "data_dict"], [44, 2, 1, "", "debug"], [44, 2, 1, "", "determine_nearest_stationary_state"], [44, 2, 1, "", "difference"], [44, 2, 1, "", "error"], [44, 2, 1, "", "extend"], [44, 3, 1, "", "filename"], [44, 2, 1, "", "filter"], [44, 2, 1, "", "get_system_input_refs"], [44, 2, 1, "", "go_through_configurations"], [44, 3, 1, "", "identity"], [44, 2, 1, "", "index"], [44, 2, 1, "", "info"], [44, 3, 1, "", "input_as_dict"], [44, 2, 1, "", "input_fields"], [44, 2, 1, "", "insert"], [44, 2, 1, "", "installSTDLogger"], [44, 2, 1, "", "internal_components"], [44, 2, 1, "", "internal_configurations"], [44, 2, 1, "", "internal_references"], [44, 2, 1, "", "internal_systems"], [44, 2, 1, "", "internal_tabulations"], [44, 3, 1, "", "last_context"], [44, 2, 1, "", "linear_output"], [44, 2, 1, "", "linear_step"], [44, 2, 1, "", "locate"], [44, 2, 1, "", "locate_ref"], [44, 2, 1, "", "message_with_identiy"], [44, 2, 1, "", "msg"], [44, 2, 1, "", "nonlinear_output"], [44, 2, 1, "", "nonlinear_step"], [44, 2, 1, "", "parent_configurations_cls"], [44, 2, 1, "", "parse_run_kwargs"], [44, 2, 1, "", "parse_simulation_input"], [44, 2, 1, "", "plot_attributes"], [44, 3, 1, "", "plotable_variables"], [44, 2, 1, "", "pop"], [44, 2, 1, "", "post_update"], [44, 2, 1, "", "pre_compile"], [44, 2, 1, "", "rate"], [44, 2, 1, "", "rate_linear"], [44, 2, 1, "", "rate_nonlinear"], [44, 2, 1, "", "ref_dXdt"], [44, 2, 1, "", "remove"], [44, 2, 1, "", "resetLog"], [44, 2, 1, "", "resetSystemLogs"], [44, 2, 1, "", "reverse"], [44, 2, 1, "", "set_time"], [44, 2, 1, "", "setattrs"], [44, 2, 1, "", "signals_attributes"], [44, 3, 1, "", "skip_plot_vars"], [44, 2, 1, "", "slot_refs"], [44, 2, 1, "", "slots_attributes"], [44, 2, 1, "", "smart_split_dataframe"], [44, 2, 1, "", "solvers_attributes"], [44, 2, 1, "", "subclasses"], [44, 2, 1, "", "subcls_compile"], [44, 3, 1, "", "system_id"], [44, 2, 1, "", "system_properties_classdef"], [44, 2, 1, "", "system_references"], [44, 2, 1, "", "trace_attributes"], [44, 2, 1, "", "transients_attributes"], [44, 2, 1, "", "update"], [44, 2, 1, "", "update_dynamics"], [44, 2, 1, "", "update_feedthrough"], [44, 2, 1, "", "update_input"], [44, 2, 1, "", "update_output_constants"], [44, 2, 1, "", "update_output_matrix"], [44, 2, 1, "", "update_state"], [44, 2, 1, "", "update_state_constants"], [44, 2, 1, "", "validate_class"], [44, 2, 1, "", "warning"]], "engforge.components": [[48, 1, 1, "", "Component"], [49, 1, 1, "", "SolveableInterface"]], "engforge.components.Component": [[48, 3, 1, "", "Ut_ref"], [48, 3, 1, "", "Xt_ref"], [48, 3, 1, "", "Yt_ref"], [48, 2, 1, "", "add_fields"], [48, 3, 1, "", "anything_changed"], [48, 3, 1, "", "as_dict"], [48, 2, 1, "", "check_ref_slot_type"], [48, 3, 1, "", "classname"], [48, 2, 1, "", "cls_compile"], [48, 2, 1, "", "collect_all_attributes"], [48, 2, 1, "", "collect_comp_refs"], [48, 2, 1, "", "collect_dynamic_refs"], [48, 2, 1, "", "collect_inst_attributes"], [48, 2, 1, "", "collect_post_update_refs"], [48, 2, 1, "", "collect_solver_refs"], [48, 2, 1, "", "collect_update_refs"], [48, 2, 1, "", "comp_references"], [48, 2, 1, "", "compile_classes"], [48, 2, 1, "", "copy_config_at_state"], [48, 2, 1, "", "create_dynamic_matricies"], [48, 2, 1, "", "create_feedthrough_matrix"], [48, 2, 1, "", "create_input_matrix"], [48, 2, 1, "", "create_output_constants"], [48, 2, 1, "", "create_output_matrix"], [48, 2, 1, "", "create_state_constants"], [48, 2, 1, "", "create_state_matrix"], [48, 2, 1, "", "critical"], [48, 3, 1, "", "dXtdt_ref"], [48, 3, 1, "", "data_dict"], [48, 2, 1, "", "debug"], [48, 2, 1, "", "determine_nearest_stationary_state"], [48, 2, 1, "", "difference"], [48, 2, 1, "", "error"], [48, 3, 1, "", "filename"], [48, 2, 1, "", "filter"], [48, 2, 1, "", "get_system_input_refs"], [48, 2, 1, "", "go_through_configurations"], [48, 3, 1, "", "identity"], [48, 2, 1, "", "info"], [48, 3, 1, "", "input_as_dict"], [48, 2, 1, "", "input_fields"], [48, 2, 1, "", "installSTDLogger"], [48, 2, 1, "", "internal_components"], [48, 2, 1, "", "internal_configurations"], [48, 2, 1, "", "internal_references"], [48, 2, 1, "", "internal_systems"], [48, 2, 1, "", "internal_tabulations"], [48, 3, 1, "", "last_context"], [48, 2, 1, "", "linear_output"], [48, 2, 1, "", "linear_step"], [48, 2, 1, "", "locate"], [48, 2, 1, "", "locate_ref"], [48, 2, 1, "", "message_with_identiy"], [48, 2, 1, "", "msg"], [48, 2, 1, "", "nonlinear_output"], [48, 2, 1, "", "nonlinear_step"], [48, 2, 1, "", "parent_configurations_cls"], [48, 2, 1, "", "parse_run_kwargs"], [48, 2, 1, "", "parse_simulation_input"], [48, 2, 1, "", "plot_attributes"], [48, 3, 1, "", "plotable_variables"], [48, 2, 1, "", "post_update"], [48, 2, 1, "", "pre_compile"], [48, 2, 1, "", "rate"], [48, 2, 1, "", "rate_linear"], [48, 2, 1, "", "rate_nonlinear"], [48, 2, 1, "", "ref_dXdt"], [48, 2, 1, "", "resetLog"], [48, 2, 1, "", "resetSystemLogs"], [48, 2, 1, "", "set_time"], [48, 2, 1, "", "setattrs"], [48, 2, 1, "", "signals_attributes"], [48, 3, 1, "", "skip_plot_vars"], [48, 2, 1, "", "slot_refs"], [48, 2, 1, "", "slots_attributes"], [48, 2, 1, "", "smart_split_dataframe"], [48, 2, 1, "", "solvers_attributes"], [48, 2, 1, "", "subclasses"], [48, 2, 1, "", "subcls_compile"], [48, 3, 1, "", "system_id"], [48, 2, 1, "", "system_properties_classdef"], [48, 2, 1, "", "system_references"], [48, 2, 1, "", "trace_attributes"], [48, 2, 1, "", "transients_attributes"], [48, 2, 1, "", "update"], [48, 2, 1, "", "update_dynamics"], [48, 2, 1, "", "update_feedthrough"], [48, 2, 1, "", "update_input"], [48, 2, 1, "", "update_output_constants"], [48, 2, 1, "", "update_output_matrix"], [48, 2, 1, "", "update_state"], [48, 2, 1, "", "update_state_constants"], [48, 2, 1, "", "validate_class"], [48, 2, 1, "", "warning"]], "engforge.components.SolveableInterface": [[49, 2, 1, "", "add_fields"], [49, 3, 1, "", "anything_changed"], [49, 3, 1, "", "as_dict"], [49, 2, 1, "", "check_ref_slot_type"], [49, 3, 1, "", "classname"], [49, 2, 1, "", "cls_compile"], [49, 2, 1, "", "collect_all_attributes"], [49, 2, 1, "", "collect_comp_refs"], [49, 2, 1, "", "collect_dynamic_refs"], [49, 2, 1, "", "collect_inst_attributes"], [49, 2, 1, "", "collect_post_update_refs"], [49, 2, 1, "", "collect_solver_refs"], [49, 2, 1, "", "collect_update_refs"], [49, 2, 1, "", "comp_references"], [49, 2, 1, "", "compile_classes"], [49, 2, 1, "", "copy_config_at_state"], [49, 2, 1, "", "critical"], [49, 3, 1, "", "data_dict"], [49, 2, 1, "", "debug"], [49, 2, 1, "", "difference"], [49, 2, 1, "", "error"], [49, 3, 1, "", "filename"], [49, 2, 1, "", "filter"], [49, 2, 1, "", "get_system_input_refs"], [49, 2, 1, "", "go_through_configurations"], [49, 3, 1, "", "identity"], [49, 2, 1, "", "info"], [49, 3, 1, "", "input_as_dict"], [49, 2, 1, "", "input_fields"], [49, 2, 1, "", "installSTDLogger"], [49, 2, 1, "", "internal_components"], [49, 2, 1, "", "internal_configurations"], [49, 2, 1, "", "internal_references"], [49, 2, 1, "", "internal_systems"], [49, 2, 1, "", "internal_tabulations"], [49, 3, 1, "", "last_context"], [49, 2, 1, "", "locate"], [49, 2, 1, "", "locate_ref"], [49, 2, 1, "", "message_with_identiy"], [49, 2, 1, "", "msg"], [49, 2, 1, "", "parent_configurations_cls"], [49, 2, 1, "", "parse_run_kwargs"], [49, 2, 1, "", "parse_simulation_input"], [49, 2, 1, "", "plot_attributes"], [49, 3, 1, "", "plotable_variables"], [49, 2, 1, "", "post_update"], [49, 2, 1, "", "pre_compile"], [49, 2, 1, "", "resetLog"], [49, 2, 1, "", "resetSystemLogs"], [49, 2, 1, "", "setattrs"], [49, 2, 1, "", "signals_attributes"], [49, 3, 1, "", "skip_plot_vars"], [49, 2, 1, "", "slot_refs"], [49, 2, 1, "", "slots_attributes"], [49, 2, 1, "", "smart_split_dataframe"], [49, 2, 1, "", "solvers_attributes"], [49, 2, 1, "", "subclasses"], [49, 2, 1, "", "subcls_compile"], [49, 3, 1, "", "system_id"], [49, 2, 1, "", "system_properties_classdef"], [49, 2, 1, "", "system_references"], [49, 2, 1, "", "trace_attributes"], [49, 2, 1, "", "transients_attributes"], [49, 2, 1, "", "update"], [49, 2, 1, "", "validate_class"], [49, 2, 1, "", "warning"]], "engforge.configuration": [[51, 1, 1, "", "ConfigLog"], [52, 1, 1, "", "Configuration"], [53, 4, 1, "", "comp_transform"], [54, 4, 1, "", "conv_nms"], [55, 4, 1, "", "forge"], [56, 4, 1, "", "meta"], [57, 4, 1, "", "name_generator"], [58, 4, 1, "", "property_changed"], [59, 4, 1, "", "signals_slots_handler"]], "engforge.configuration.ConfigLog": [[51, 2, 1, "", "add_fields"], [51, 2, 1, "", "critical"], [51, 2, 1, "", "debug"], [51, 2, 1, "", "error"], [51, 2, 1, "", "filter"], [51, 2, 1, "", "info"], [51, 2, 1, "", "installSTDLogger"], [51, 2, 1, "", "message_with_identiy"], [51, 2, 1, "", "msg"], [51, 2, 1, "", "resetLog"], [51, 2, 1, "", "resetSystemLogs"], [51, 2, 1, "", "warning"]], "engforge.configuration.Configuration": [[52, 2, 1, "", "add_fields"], [52, 3, 1, "", "as_dict"], [52, 2, 1, "", "check_ref_slot_type"], [52, 3, 1, "", "classname"], [52, 2, 1, "", "cls_compile"], [52, 2, 1, "", "collect_all_attributes"], [52, 2, 1, "", "collect_inst_attributes"], [52, 2, 1, "", "compile_classes"], [52, 2, 1, "", "copy_config_at_state"], [52, 2, 1, "", "critical"], [52, 2, 1, "", "debug"], [52, 2, 1, "", "difference"], [52, 2, 1, "", "error"], [52, 3, 1, "", "filename"], [52, 2, 1, "", "filter"], [52, 2, 1, "", "go_through_configurations"], [52, 3, 1, "", "identity"], [52, 2, 1, "", "info"], [52, 3, 1, "", "input_as_dict"], [52, 2, 1, "", "input_fields"], [52, 2, 1, "", "installSTDLogger"], [52, 2, 1, "", "internal_configurations"], [52, 2, 1, "", "message_with_identiy"], [52, 2, 1, "", "msg"], [52, 2, 1, "", "parent_configurations_cls"], [52, 2, 1, "", "plot_attributes"], [52, 2, 1, "", "pre_compile"], [52, 2, 1, "", "resetLog"], [52, 2, 1, "", "resetSystemLogs"], [52, 2, 1, "", "setattrs"], [52, 2, 1, "", "signals_attributes"], [52, 2, 1, "", "slot_refs"], [52, 2, 1, "", "slots_attributes"], [52, 2, 1, "", "solvers_attributes"], [52, 2, 1, "", "subclasses"], [52, 2, 1, "", "subcls_compile"], [52, 2, 1, "", "trace_attributes"], [52, 2, 1, "", "transients_attributes"], [52, 2, 1, "", "validate_class"], [52, 2, 1, "", "warning"]], "engforge.dataframe": [[61, 1, 1, "", "DataFrameLog"], [62, 1, 1, "", "DataframeMixin"], [63, 5, 1, "", "dataframe_prop"], [64, 1, 1, "", "dataframe_property"], [65, 4, 1, "", "determine_split"], [66, 5, 1, "", "df_prop"], [67, 4, 1, "", "is_uniform"], [68, 4, 1, "", "key_func"], [69, 4, 1, "", "split_dataframe"]], "engforge.dataframe.DataFrameLog": [[61, 2, 1, "", "add_fields"], [61, 2, 1, "", "critical"], [61, 2, 1, "", "debug"], [61, 2, 1, "", "error"], [61, 2, 1, "", "filter"], [61, 2, 1, "", "info"], [61, 2, 1, "", "installSTDLogger"], [61, 2, 1, "", "message_with_identiy"], [61, 2, 1, "", "msg"], [61, 2, 1, "", "resetLog"], [61, 2, 1, "", "resetSystemLogs"], [61, 2, 1, "", "warning"]], "engforge.dataframe.DataframeMixin": [[62, 3, 1, "", "dataframe"], [62, 3, 1, "", "skip_plot_vars"], [62, 2, 1, "", "smart_split_dataframe"]], "engforge.dataframe.dataframe_property": [[64, 2, 1, "", "__call__"], [64, 2, 1, "", "get_func_return"]], "engforge.datastores": [[71, 0, 0, "-", "data"]], "engforge.datastores.data": [[72, 1, 1, "", "DBConnection"], [73, 1, 1, "", "DiskCacheStore"], [74, 4, 1, "", "addapt_numpy_array"], [75, 4, 1, "", "addapt_numpy_float32"], [76, 4, 1, "", "addapt_numpy_float64"], [77, 4, 1, "", "addapt_numpy_int32"], [78, 4, 1, "", "addapt_numpy_int64"], [79, 4, 1, "", "autocorrelation_direct"], [80, 4, 1, "", "autocorrelation_fft"], [81, 4, 1, "", "autocorrelation_numpy"], [82, 4, 1, "", "nan_to_null"]], "engforge.datastores.data.DBConnection": [[72, 2, 1, "", "add_fields"], [72, 2, 1, "", "configure"], [72, 2, 1, "", "critical"], [72, 2, 1, "", "debug"], [72, 2, 1, "", "ensure_database_exists"], [72, 2, 1, "", "error"], [72, 2, 1, "", "filter"], [72, 2, 1, "", "info"], [72, 2, 1, "", "installSTDLogger"], [72, 2, 1, "", "message_with_identiy"], [72, 2, 1, "", "msg"], [72, 2, 1, "", "rebuild_database"], [72, 2, 1, "", "resetLog"], [72, 2, 1, "", "resetSystemLogs"], [72, 2, 1, "", "session_scope"], [72, 2, 1, "", "warning"]], "engforge.datastores.data.DiskCacheStore": [[73, 2, 1, "", "add_fields"], [73, 5, 1, "", "cache_class"], [73, 2, 1, "", "critical"], [73, 2, 1, "", "debug"], [73, 2, 1, "", "error"], [73, 2, 1, "", "expire"], [73, 2, 1, "", "filter"], [73, 2, 1, "", "get"], [73, 2, 1, "", "info"], [73, 2, 1, "", "installSTDLogger"], [73, 2, 1, "", "message_with_identiy"], [73, 2, 1, "", "msg"], [73, 2, 1, "", "resetLog"], [73, 2, 1, "", "resetSystemLogs"], [73, 2, 1, "", "set"], [73, 2, 1, "", "warning"]], "engforge.dynamics": [[84, 1, 1, "", "DynamicsMixin"], [85, 1, 1, "", "GlobalDynamics"], [86, 1, 1, "", "INDEX_MAP"], [87, 4, 1, "", "valid_mtx"]], "engforge.dynamics.DynamicsMixin": [[84, 3, 1, "", "Ut_ref"], [84, 3, 1, "", "Xt_ref"], [84, 3, 1, "", "Yt_ref"], [84, 2, 1, "", "add_fields"], [84, 3, 1, "", "as_dict"], [84, 2, 1, "", "check_ref_slot_type"], [84, 3, 1, "", "classname"], [84, 2, 1, "", "cls_compile"], [84, 2, 1, "", "collect_all_attributes"], [84, 2, 1, "", "collect_comp_refs"], [84, 2, 1, "", "collect_dynamic_refs"], [84, 2, 1, "", "collect_inst_attributes"], [84, 2, 1, "", "collect_post_update_refs"], [84, 2, 1, "", "collect_solver_refs"], [84, 2, 1, "", "collect_update_refs"], [84, 2, 1, "", "comp_references"], [84, 2, 1, "", "compile_classes"], [84, 2, 1, "", "copy_config_at_state"], [84, 2, 1, "", "create_dynamic_matricies"], [84, 2, 1, "", "create_feedthrough_matrix"], [84, 2, 1, "", "create_input_matrix"], [84, 2, 1, "", "create_output_constants"], [84, 2, 1, "", "create_output_matrix"], [84, 2, 1, "", "create_state_constants"], [84, 2, 1, "", "create_state_matrix"], [84, 2, 1, "", "critical"], [84, 3, 1, "", "dXtdt_ref"], [84, 2, 1, "", "debug"], [84, 2, 1, "", "determine_nearest_stationary_state"], [84, 2, 1, "", "difference"], [84, 2, 1, "", "error"], [84, 3, 1, "", "filename"], [84, 2, 1, "", "filter"], [84, 2, 1, "", "get_system_input_refs"], [84, 2, 1, "", "go_through_configurations"], [84, 3, 1, "", "identity"], [84, 2, 1, "", "info"], [84, 3, 1, "", "input_as_dict"], [84, 2, 1, "", "input_fields"], [84, 2, 1, "", "installSTDLogger"], [84, 2, 1, "", "internal_components"], [84, 2, 1, "", "internal_configurations"], [84, 2, 1, "", "internal_references"], [84, 2, 1, "", "internal_systems"], [84, 2, 1, "", "internal_tabulations"], [84, 2, 1, "", "linear_output"], [84, 2, 1, "", "linear_step"], [84, 2, 1, "", "locate"], [84, 2, 1, "", "locate_ref"], [84, 2, 1, "", "message_with_identiy"], [84, 2, 1, "", "msg"], [84, 2, 1, "", "nonlinear_output"], [84, 2, 1, "", "nonlinear_step"], [84, 2, 1, "", "parent_configurations_cls"], [84, 2, 1, "", "parse_run_kwargs"], [84, 2, 1, "", "parse_simulation_input"], [84, 2, 1, "", "plot_attributes"], [84, 2, 1, "", "post_update"], [84, 2, 1, "", "pre_compile"], [84, 2, 1, "", "rate"], [84, 2, 1, "", "rate_linear"], [84, 2, 1, "", "rate_nonlinear"], [84, 2, 1, "", "ref_dXdt"], [84, 2, 1, "", "resetLog"], [84, 2, 1, "", "resetSystemLogs"], [84, 2, 1, "", "set_time"], [84, 2, 1, "", "setattrs"], [84, 2, 1, "", "signals_attributes"], [84, 2, 1, "", "slot_refs"], [84, 2, 1, "", "slots_attributes"], [84, 2, 1, "", "solvers_attributes"], [84, 2, 1, "", "subclasses"], [84, 2, 1, "", "subcls_compile"], [84, 2, 1, "", "system_references"], [84, 2, 1, "", "trace_attributes"], [84, 2, 1, "", "transients_attributes"], [84, 2, 1, "", "update"], [84, 2, 1, "", "update_dynamics"], [84, 2, 1, "", "update_feedthrough"], [84, 2, 1, "", "update_input"], [84, 2, 1, "", "update_output_constants"], [84, 2, 1, "", "update_output_matrix"], [84, 2, 1, "", "update_state"], [84, 2, 1, "", "update_state_constants"], [84, 2, 1, "", "validate_class"], [84, 2, 1, "", "warning"]], "engforge.dynamics.GlobalDynamics": [[85, 3, 1, "", "Ut_ref"], [85, 3, 1, "", "Xt_ref"], [85, 3, 1, "", "Yt_ref"], [85, 2, 1, "", "add_fields"], [85, 3, 1, "", "as_dict"], [85, 2, 1, "", "check_ref_slot_type"], [85, 3, 1, "", "classname"], [85, 2, 1, "", "cls_compile"], [85, 2, 1, "", "collect_all_attributes"], [85, 2, 1, "", "collect_comp_refs"], [85, 2, 1, "", "collect_dynamic_refs"], [85, 2, 1, "", "collect_inst_attributes"], [85, 2, 1, "", "collect_post_update_refs"], [85, 2, 1, "", "collect_solver_refs"], [85, 2, 1, "", "collect_update_refs"], [85, 2, 1, "", "comp_references"], [85, 2, 1, "", "compile_classes"], [85, 2, 1, "", "copy_config_at_state"], [85, 2, 1, "", "create_dynamic_matricies"], [85, 2, 1, "", "create_feedthrough_matrix"], [85, 2, 1, "", "create_input_matrix"], [85, 2, 1, "", "create_output_constants"], [85, 2, 1, "", "create_output_matrix"], [85, 2, 1, "", "create_state_constants"], [85, 2, 1, "", "create_state_matrix"], [85, 2, 1, "", "critical"], [85, 3, 1, "", "dXtdt_ref"], [85, 2, 1, "", "debug"], [85, 2, 1, "", "determine_nearest_stationary_state"], [85, 2, 1, "", "difference"], [85, 2, 1, "", "error"], [85, 3, 1, "", "filename"], [85, 2, 1, "", "filter"], [85, 2, 1, "", "get_system_input_refs"], [85, 2, 1, "", "go_through_configurations"], [85, 3, 1, "", "identity"], [85, 2, 1, "", "info"], [85, 3, 1, "", "input_as_dict"], [85, 2, 1, "", "input_fields"], [85, 2, 1, "", "installSTDLogger"], [85, 2, 1, "", "internal_components"], [85, 2, 1, "", "internal_configurations"], [85, 2, 1, "", "internal_references"], [85, 2, 1, "", "internal_systems"], [85, 2, 1, "", "internal_tabulations"], [85, 2, 1, "", "linear_output"], [85, 2, 1, "", "linear_step"], [85, 2, 1, "", "locate"], [85, 2, 1, "", "locate_ref"], [85, 2, 1, "", "message_with_identiy"], [85, 2, 1, "", "msg"], [85, 2, 1, "", "nonlinear_output"], [85, 2, 1, "", "nonlinear_step"], [85, 2, 1, "", "parent_configurations_cls"], [85, 2, 1, "", "parse_run_kwargs"], [85, 2, 1, "", "parse_simulation_input"], [85, 2, 1, "", "plot_attributes"], [85, 2, 1, "", "post_update"], [85, 2, 1, "", "pre_compile"], [85, 2, 1, "", "rate"], [85, 2, 1, "", "rate_linear"], [85, 2, 1, "", "rate_nonlinear"], [85, 2, 1, "", "ref_dXdt"], [85, 2, 1, "", "resetLog"], [85, 2, 1, "", "resetSystemLogs"], [85, 2, 1, "", "set_time"], [85, 2, 1, "", "setattrs"], [85, 2, 1, "", "setup_global_dynamics"], [85, 2, 1, "", "signals_attributes"], [85, 2, 1, "", "sim_matrix"], [85, 2, 1, "", "simulate"], [85, 2, 1, "", "slot_refs"], [85, 2, 1, "", "slots_attributes"], [85, 2, 1, "", "solvers_attributes"], [85, 2, 1, "", "subclasses"], [85, 2, 1, "", "subcls_compile"], [85, 2, 1, "", "system_references"], [85, 2, 1, "", "trace_attributes"], [85, 2, 1, "", "transients_attributes"], [85, 2, 1, "", "update"], [85, 2, 1, "", "update_dynamics"], [85, 2, 1, "", "update_feedthrough"], [85, 2, 1, "", "update_input"], [85, 2, 1, "", "update_output_constants"], [85, 2, 1, "", "update_output_matrix"], [85, 2, 1, "", "update_state"], [85, 2, 1, "", "update_state_constants"], [85, 2, 1, "", "validate_class"], [85, 2, 1, "", "warning"]], "engforge.dynamics.INDEX_MAP": [[86, 2, 1, "", "__call__"]], "engforge.eng": [[89, 0, 0, "-", "costs"], [96, 0, 0, "-", "fluid_material"], [112, 0, 0, "-", "geometry"], [124, 0, 0, "-", "pipes"], [134, 0, 0, "-", "prediction"], [136, 0, 0, "-", "solid_materials"], [150, 0, 0, "-", "structure_beams"], [153, 0, 0, "-", "thermodynamics"]], "engforge.eng.costs": [[90, 1, 1, "", "CostLog"], [91, 1, 1, "", "CostModel"], [92, 1, 1, "", "Economics"], [93, 1, 1, "", "cost_property"], [94, 4, 1, "", "eval_slot_cost"], [95, 4, 1, "", "gend"]], "engforge.eng.costs.CostLog": [[90, 2, 1, "", "add_fields"], [90, 2, 1, "", "critical"], [90, 2, 1, "", "debug"], [90, 2, 1, "", "error"], [90, 2, 1, "", "filter"], [90, 2, 1, "", "info"], [90, 2, 1, "", "installSTDLogger"], [90, 2, 1, "", "message_with_identiy"], [90, 2, 1, "", "msg"], [90, 2, 1, "", "resetLog"], [90, 2, 1, "", "resetSystemLogs"], [90, 2, 1, "", "warning"]], "engforge.eng.costs.CostModel": [[91, 2, 1, "", "add_fields"], [91, 3, 1, "", "anything_changed"], [91, 3, 1, "", "as_dict"], [91, 2, 1, "", "calculate_item_cost"], [91, 2, 1, "", "check_ref_slot_type"], [91, 2, 1, "", "class_cost_properties"], [91, 3, 1, "", "classname"], [91, 2, 1, "", "cls_compile"], [91, 2, 1, "", "collect_all_attributes"], [91, 2, 1, "", "collect_comp_refs"], [91, 2, 1, "", "collect_dynamic_refs"], [91, 2, 1, "", "collect_inst_attributes"], [91, 2, 1, "", "collect_post_update_refs"], [91, 2, 1, "", "collect_solver_refs"], [91, 2, 1, "", "collect_update_refs"], [91, 2, 1, "", "comp_references"], [91, 2, 1, "", "compile_classes"], [91, 2, 1, "", "copy_config_at_state"], [91, 3, 1, "", "cost_categories"], [91, 3, 1, "", "cost_properties"], [91, 2, 1, "", "costs_at_term"], [91, 2, 1, "", "critical"], [91, 2, 1, "", "custom_cost"], [91, 3, 1, "", "data_dict"], [91, 2, 1, "", "debug"], [91, 2, 1, "", "default_cost"], [91, 2, 1, "", "difference"], [91, 2, 1, "", "error"], [91, 3, 1, "", "filename"], [91, 2, 1, "", "filter"], [91, 2, 1, "", "get_system_input_refs"], [91, 2, 1, "", "go_through_configurations"], [91, 3, 1, "", "identity"], [91, 2, 1, "", "info"], [91, 3, 1, "", "input_as_dict"], [91, 2, 1, "", "input_fields"], [91, 2, 1, "", "installSTDLogger"], [91, 2, 1, "", "internal_components"], [91, 2, 1, "", "internal_configurations"], [91, 2, 1, "", "internal_references"], [91, 2, 1, "", "internal_systems"], [91, 2, 1, "", "internal_tabulations"], [91, 3, 1, "", "last_context"], [91, 2, 1, "", "locate"], [91, 2, 1, "", "locate_ref"], [91, 2, 1, "", "message_with_identiy"], [91, 2, 1, "", "msg"], [91, 2, 1, "", "parent_configurations_cls"], [91, 2, 1, "", "parse_run_kwargs"], [91, 2, 1, "", "parse_simulation_input"], [91, 2, 1, "", "plot_attributes"], [91, 3, 1, "", "plotable_variables"], [91, 2, 1, "", "post_update"], [91, 2, 1, "", "pre_compile"], [91, 2, 1, "", "resetLog"], [91, 2, 1, "", "resetSystemLogs"], [91, 2, 1, "", "set_default_costs"], [91, 2, 1, "", "setattrs"], [91, 2, 1, "", "signals_attributes"], [91, 3, 1, "", "skip_plot_vars"], [91, 2, 1, "", "slot_refs"], [91, 2, 1, "", "slots_attributes"], [91, 2, 1, "", "smart_split_dataframe"], [91, 2, 1, "", "solvers_attributes"], [91, 2, 1, "", "sub_costs"], [91, 2, 1, "", "subclasses"], [91, 2, 1, "", "subcls_compile"], [91, 2, 1, "", "sum_costs"], [91, 3, 1, "", "system_id"], [91, 2, 1, "", "system_properties_classdef"], [91, 2, 1, "", "system_references"], [91, 2, 1, "", "trace_attributes"], [91, 2, 1, "", "transients_attributes"], [91, 2, 1, "", "update"], [91, 2, 1, "", "update_dflt_costs"], [91, 2, 1, "", "validate_class"], [91, 2, 1, "", "warning"]], "engforge.eng.costs.Economics": [[92, 3, 1, "", "Ut_ref"], [92, 3, 1, "", "Xt_ref"], [92, 3, 1, "", "Yt_ref"], [92, 2, 1, "", "add_fields"], [92, 3, 1, "", "anything_changed"], [92, 3, 1, "", "as_dict"], [92, 2, 1, "", "calculate_costs"], [92, 2, 1, "", "calculate_production"], [92, 2, 1, "", "check_ref_slot_type"], [92, 3, 1, "", "classname"], [92, 2, 1, "", "cls_compile"], [92, 2, 1, "", "collect_all_attributes"], [92, 2, 1, "", "collect_comp_refs"], [92, 2, 1, "", "collect_dynamic_refs"], [92, 2, 1, "", "collect_inst_attributes"], [92, 2, 1, "", "collect_post_update_refs"], [92, 2, 1, "", "collect_solver_refs"], [92, 2, 1, "", "collect_update_refs"], [92, 2, 1, "", "comp_references"], [92, 2, 1, "", "compile_classes"], [92, 2, 1, "", "copy_config_at_state"], [92, 2, 1, "", "create_dynamic_matricies"], [92, 2, 1, "", "create_feedthrough_matrix"], [92, 2, 1, "", "create_input_matrix"], [92, 2, 1, "", "create_output_constants"], [92, 2, 1, "", "create_output_matrix"], [92, 2, 1, "", "create_state_constants"], [92, 2, 1, "", "create_state_matrix"], [92, 2, 1, "", "critical"], [92, 3, 1, "", "dXtdt_ref"], [92, 3, 1, "", "data_dict"], [92, 2, 1, "", "debug"], [92, 2, 1, "", "determine_nearest_stationary_state"], [92, 2, 1, "", "difference"], [92, 2, 1, "", "error"], [92, 3, 1, "", "filename"], [92, 2, 1, "", "filter"], [92, 2, 1, "", "get_system_input_refs"], [92, 2, 1, "", "go_through_configurations"], [92, 3, 1, "", "identity"], [92, 2, 1, "", "info"], [92, 3, 1, "", "input_as_dict"], [92, 2, 1, "", "input_fields"], [92, 2, 1, "", "installSTDLogger"], [92, 2, 1, "", "internal_components"], [92, 2, 1, "", "internal_configurations"], [92, 2, 1, "", "internal_references"], [92, 2, 1, "", "internal_systems"], [92, 2, 1, "", "internal_tabulations"], [92, 3, 1, "", "last_context"], [92, 3, 1, "", "lifecycle_dataframe"], [92, 3, 1, "", "lifecycle_output"], [92, 2, 1, "", "linear_output"], [92, 2, 1, "", "linear_step"], [92, 2, 1, "", "locate"], [92, 2, 1, "", "locate_ref"], [92, 2, 1, "", "message_with_identiy"], [92, 2, 1, "", "msg"], [92, 2, 1, "", "nonlinear_output"], [92, 2, 1, "", "nonlinear_step"], [92, 2, 1, "", "parent_configurations_cls"], [92, 2, 1, "", "parse_run_kwargs"], [92, 2, 1, "", "parse_simulation_input"], [92, 2, 1, "", "plot_attributes"], [92, 3, 1, "", "plotable_variables"], [92, 2, 1, "", "post_update"], [92, 2, 1, "", "pre_compile"], [92, 2, 1, "", "rate"], [92, 2, 1, "", "rate_linear"], [92, 2, 1, "", "rate_nonlinear"], [92, 2, 1, "", "ref_dXdt"], [92, 2, 1, "", "resetLog"], [92, 2, 1, "", "resetSystemLogs"], [92, 2, 1, "", "set_time"], [92, 2, 1, "", "setattrs"], [92, 2, 1, "", "signals_attributes"], [92, 3, 1, "", "skip_plot_vars"], [92, 2, 1, "", "slot_refs"], [92, 2, 1, "", "slots_attributes"], [92, 2, 1, "", "smart_split_dataframe"], [92, 2, 1, "", "solvers_attributes"], [92, 2, 1, "", "subclasses"], [92, 2, 1, "", "subcls_compile"], [92, 3, 1, "", "system_id"], [92, 2, 1, "", "system_properties_classdef"], [92, 2, 1, "", "system_references"], [92, 2, 1, "", "trace_attributes"], [92, 2, 1, "", "transients_attributes"], [92, 2, 1, "", "update"], [92, 2, 1, "", "update_dynamics"], [92, 2, 1, "", "update_feedthrough"], [92, 2, 1, "", "update_input"], [92, 2, 1, "", "update_output_constants"], [92, 2, 1, "", "update_output_matrix"], [92, 2, 1, "", "update_state"], [92, 2, 1, "", "update_state_constants"], [92, 2, 1, "", "validate_class"], [92, 2, 1, "", "warning"]], "engforge.eng.costs.cost_property": [[93, 2, 1, "", "__call__"], [93, 2, 1, "", "get_func_return"]], "engforge.eng.fluid_material": [[97, 1, 1, "", "Air"], [98, 1, 1, "", "AirWaterMix"], [99, 1, 1, "", "CoolPropMaterial"], [100, 1, 1, "", "CoolPropMixture"], [101, 1, 1, "", "FluidMaterial"], [102, 1, 1, "", "Hydrogen"], [103, 1, 1, "", "IdealAir"], [104, 1, 1, "", "IdealGas"], [105, 1, 1, "", "IdealH2"], [106, 1, 1, "", "IdealOxygen"], [107, 1, 1, "", "IdealSteam"], [108, 1, 1, "", "Oxygen"], [109, 1, 1, "", "SeaWater"], [110, 1, 1, "", "Steam"], [111, 1, 1, "", "Water"]], "engforge.eng.fluid_material.Air": [[97, 3, 1, "", "Ut_ref"], [97, 3, 1, "", "Xt_ref"], [97, 3, 1, "", "Yt_ref"], [97, 2, 1, "", "__call__"], [97, 2, 1, "", "add_fields"], [97, 3, 1, "", "anything_changed"], [97, 3, 1, "", "as_dict"], [97, 2, 1, "", "check_ref_slot_type"], [97, 3, 1, "", "classname"], [97, 2, 1, "", "cls_compile"], [97, 2, 1, "", "collect_all_attributes"], [97, 2, 1, "", "collect_comp_refs"], [97, 2, 1, "", "collect_dynamic_refs"], [97, 2, 1, "", "collect_inst_attributes"], [97, 2, 1, "", "collect_post_update_refs"], [97, 2, 1, "", "collect_solver_refs"], [97, 2, 1, "", "collect_update_refs"], [97, 2, 1, "", "comp_references"], [97, 2, 1, "", "compile_classes"], [97, 2, 1, "", "copy_config_at_state"], [97, 2, 1, "", "create_dynamic_matricies"], [97, 2, 1, "", "create_feedthrough_matrix"], [97, 2, 1, "", "create_input_matrix"], [97, 2, 1, "", "create_output_constants"], [97, 2, 1, "", "create_output_matrix"], [97, 2, 1, "", "create_state_constants"], [97, 2, 1, "", "create_state_matrix"], [97, 2, 1, "", "critical"], [97, 3, 1, "", "dXtdt_ref"], [97, 3, 1, "", "data_dict"], [97, 2, 1, "", "debug"], [97, 2, 1, "", "determine_nearest_stationary_state"], [97, 2, 1, "", "difference"], [97, 2, 1, "", "error"], [97, 3, 1, "", "filename"], [97, 2, 1, "", "filter"], [97, 2, 1, "", "get_system_input_refs"], [97, 2, 1, "", "go_through_configurations"], [97, 3, 1, "", "identity"], [97, 2, 1, "", "info"], [97, 3, 1, "", "input_as_dict"], [97, 2, 1, "", "input_fields"], [97, 2, 1, "", "installSTDLogger"], [97, 2, 1, "", "internal_components"], [97, 2, 1, "", "internal_configurations"], [97, 2, 1, "", "internal_references"], [97, 2, 1, "", "internal_systems"], [97, 2, 1, "", "internal_tabulations"], [97, 3, 1, "", "last_context"], [97, 2, 1, "", "linear_output"], [97, 2, 1, "", "linear_step"], [97, 2, 1, "", "locate"], [97, 2, 1, "", "locate_ref"], [97, 2, 1, "", "message_with_identiy"], [97, 2, 1, "", "msg"], [97, 2, 1, "", "nonlinear_output"], [97, 2, 1, "", "nonlinear_step"], [97, 2, 1, "", "parent_configurations_cls"], [97, 2, 1, "", "parse_run_kwargs"], [97, 2, 1, "", "parse_simulation_input"], [97, 2, 1, "", "plot_attributes"], [97, 3, 1, "", "plotable_variables"], [97, 2, 1, "", "post_update"], [97, 2, 1, "", "pre_compile"], [97, 2, 1, "", "rate"], [97, 2, 1, "", "rate_linear"], [97, 2, 1, "", "rate_nonlinear"], [97, 2, 1, "", "ref_dXdt"], [97, 2, 1, "", "resetLog"], [97, 2, 1, "", "resetSystemLogs"], [97, 2, 1, "", "set_time"], [97, 2, 1, "", "setattrs"], [97, 2, 1, "", "signals_attributes"], [97, 3, 1, "", "skip_plot_vars"], [97, 2, 1, "", "slot_refs"], [97, 2, 1, "", "slots_attributes"], [97, 2, 1, "", "smart_split_dataframe"], [97, 2, 1, "", "solvers_attributes"], [97, 2, 1, "", "subclasses"], [97, 2, 1, "", "subcls_compile"], [97, 3, 1, "", "system_id"], [97, 2, 1, "", "system_properties_classdef"], [97, 2, 1, "", "system_references"], [97, 2, 1, "", "trace_attributes"], [97, 2, 1, "", "transients_attributes"], [97, 2, 1, "", "update"], [97, 2, 1, "", "update_dynamics"], [97, 2, 1, "", "update_feedthrough"], [97, 2, 1, "", "update_input"], [97, 2, 1, "", "update_output_constants"], [97, 2, 1, "", "update_output_matrix"], [97, 2, 1, "", "update_state"], [97, 2, 1, "", "update_state_constants"], [97, 2, 1, "", "validate_class"], [97, 2, 1, "", "warning"]], "engforge.eng.fluid_material.AirWaterMix": [[98, 3, 1, "", "Ut_ref"], [98, 3, 1, "", "Xt_ref"], [98, 3, 1, "", "Yt_ref"], [98, 2, 1, "", "__call__"], [98, 2, 1, "", "add_fields"], [98, 3, 1, "", "anything_changed"], [98, 3, 1, "", "as_dict"], [98, 2, 1, "", "check_ref_slot_type"], [98, 3, 1, "", "classname"], [98, 2, 1, "", "cls_compile"], [98, 2, 1, "", "collect_all_attributes"], [98, 2, 1, "", "collect_comp_refs"], [98, 2, 1, "", "collect_dynamic_refs"], [98, 2, 1, "", "collect_inst_attributes"], [98, 2, 1, "", "collect_post_update_refs"], [98, 2, 1, "", "collect_solver_refs"], [98, 2, 1, "", "collect_update_refs"], [98, 2, 1, "", "comp_references"], [98, 2, 1, "", "compile_classes"], [98, 2, 1, "", "copy_config_at_state"], [98, 2, 1, "", "create_dynamic_matricies"], [98, 2, 1, "", "create_feedthrough_matrix"], [98, 2, 1, "", "create_input_matrix"], [98, 2, 1, "", "create_output_constants"], [98, 2, 1, "", "create_output_matrix"], [98, 2, 1, "", "create_state_constants"], [98, 2, 1, "", "create_state_matrix"], [98, 2, 1, "", "critical"], [98, 3, 1, "", "dXtdt_ref"], [98, 3, 1, "", "data_dict"], [98, 2, 1, "", "debug"], [98, 2, 1, "", "determine_nearest_stationary_state"], [98, 2, 1, "", "difference"], [98, 2, 1, "", "error"], [98, 3, 1, "", "filename"], [98, 2, 1, "", "filter"], [98, 2, 1, "", "get_system_input_refs"], [98, 2, 1, "", "go_through_configurations"], [98, 3, 1, "", "identity"], [98, 2, 1, "", "info"], [98, 3, 1, "", "input_as_dict"], [98, 2, 1, "", "input_fields"], [98, 2, 1, "", "installSTDLogger"], [98, 2, 1, "", "internal_components"], [98, 2, 1, "", "internal_configurations"], [98, 2, 1, "", "internal_references"], [98, 2, 1, "", "internal_systems"], [98, 2, 1, "", "internal_tabulations"], [98, 3, 1, "", "last_context"], [98, 2, 1, "", "linear_output"], [98, 2, 1, "", "linear_step"], [98, 2, 1, "", "locate"], [98, 2, 1, "", "locate_ref"], [98, 2, 1, "", "message_with_identiy"], [98, 2, 1, "", "msg"], [98, 2, 1, "", "nonlinear_output"], [98, 2, 1, "", "nonlinear_step"], [98, 2, 1, "", "parent_configurations_cls"], [98, 2, 1, "", "parse_run_kwargs"], [98, 2, 1, "", "parse_simulation_input"], [98, 2, 1, "", "plot_attributes"], [98, 3, 1, "", "plotable_variables"], [98, 2, 1, "", "post_update"], [98, 2, 1, "", "pre_compile"], [98, 2, 1, "", "rate"], [98, 2, 1, "", "rate_linear"], [98, 2, 1, "", "rate_nonlinear"], [98, 2, 1, "", "ref_dXdt"], [98, 2, 1, "", "resetLog"], [98, 2, 1, "", "resetSystemLogs"], [98, 2, 1, "", "set_time"], [98, 2, 1, "", "setattrs"], [98, 2, 1, "", "signals_attributes"], [98, 3, 1, "", "skip_plot_vars"], [98, 2, 1, "", "slot_refs"], [98, 2, 1, "", "slots_attributes"], [98, 2, 1, "", "smart_split_dataframe"], [98, 2, 1, "", "solvers_attributes"], [98, 2, 1, "", "subclasses"], [98, 2, 1, "", "subcls_compile"], [98, 3, 1, "", "system_id"], [98, 2, 1, "", "system_properties_classdef"], [98, 2, 1, "", "system_references"], [98, 2, 1, "", "trace_attributes"], [98, 2, 1, "", "transients_attributes"], [98, 2, 1, "", "update"], [98, 2, 1, "", "update_dynamics"], [98, 2, 1, "", "update_feedthrough"], [98, 2, 1, "", "update_input"], [98, 2, 1, "", "update_mass_ratios"], [98, 2, 1, "", "update_output_constants"], [98, 2, 1, "", "update_output_matrix"], [98, 2, 1, "", "update_state"], [98, 2, 1, "", "update_state_constants"], [98, 2, 1, "", "validate_class"], [98, 2, 1, "", "warning"]], "engforge.eng.fluid_material.CoolPropMaterial": [[99, 3, 1, "", "Ut_ref"], [99, 3, 1, "", "Xt_ref"], [99, 3, 1, "", "Yt_ref"], [99, 2, 1, "", "__call__"], [99, 2, 1, "", "add_fields"], [99, 3, 1, "", "anything_changed"], [99, 3, 1, "", "as_dict"], [99, 2, 1, "", "check_ref_slot_type"], [99, 3, 1, "", "classname"], [99, 2, 1, "", "cls_compile"], [99, 2, 1, "", "collect_all_attributes"], [99, 2, 1, "", "collect_comp_refs"], [99, 2, 1, "", "collect_dynamic_refs"], [99, 2, 1, "", "collect_inst_attributes"], [99, 2, 1, "", "collect_post_update_refs"], [99, 2, 1, "", "collect_solver_refs"], [99, 2, 1, "", "collect_update_refs"], [99, 2, 1, "", "comp_references"], [99, 2, 1, "", "compile_classes"], [99, 2, 1, "", "copy_config_at_state"], [99, 2, 1, "", "create_dynamic_matricies"], [99, 2, 1, "", "create_feedthrough_matrix"], [99, 2, 1, "", "create_input_matrix"], [99, 2, 1, "", "create_output_constants"], [99, 2, 1, "", "create_output_matrix"], [99, 2, 1, "", "create_state_constants"], [99, 2, 1, "", "create_state_matrix"], [99, 2, 1, "", "critical"], [99, 3, 1, "", "dXtdt_ref"], [99, 3, 1, "", "data_dict"], [99, 2, 1, "", "debug"], [99, 2, 1, "", "determine_nearest_stationary_state"], [99, 2, 1, "", "difference"], [99, 2, 1, "", "error"], [99, 3, 1, "", "filename"], [99, 2, 1, "", "filter"], [99, 2, 1, "", "get_system_input_refs"], [99, 2, 1, "", "go_through_configurations"], [99, 3, 1, "", "identity"], [99, 2, 1, "", "info"], [99, 3, 1, "", "input_as_dict"], [99, 2, 1, "", "input_fields"], [99, 2, 1, "", "installSTDLogger"], [99, 2, 1, "", "internal_components"], [99, 2, 1, "", "internal_configurations"], [99, 2, 1, "", "internal_references"], [99, 2, 1, "", "internal_systems"], [99, 2, 1, "", "internal_tabulations"], [99, 3, 1, "", "last_context"], [99, 2, 1, "", "linear_output"], [99, 2, 1, "", "linear_step"], [99, 2, 1, "", "locate"], [99, 2, 1, "", "locate_ref"], [99, 2, 1, "", "message_with_identiy"], [99, 2, 1, "", "msg"], [99, 2, 1, "", "nonlinear_output"], [99, 2, 1, "", "nonlinear_step"], [99, 2, 1, "", "parent_configurations_cls"], [99, 2, 1, "", "parse_run_kwargs"], [99, 2, 1, "", "parse_simulation_input"], [99, 2, 1, "", "plot_attributes"], [99, 3, 1, "", "plotable_variables"], [99, 2, 1, "", "post_update"], [99, 2, 1, "", "pre_compile"], [99, 2, 1, "", "rate"], [99, 2, 1, "", "rate_linear"], [99, 2, 1, "", "rate_nonlinear"], [99, 2, 1, "", "ref_dXdt"], [99, 2, 1, "", "resetLog"], [99, 2, 1, "", "resetSystemLogs"], [99, 2, 1, "", "set_time"], [99, 2, 1, "", "setattrs"], [99, 2, 1, "", "signals_attributes"], [99, 3, 1, "", "skip_plot_vars"], [99, 2, 1, "", "slot_refs"], [99, 2, 1, "", "slots_attributes"], [99, 2, 1, "", "smart_split_dataframe"], [99, 2, 1, "", "solvers_attributes"], [99, 2, 1, "", "subclasses"], [99, 2, 1, "", "subcls_compile"], [99, 3, 1, "", "system_id"], [99, 2, 1, "", "system_properties_classdef"], [99, 2, 1, "", "system_references"], [99, 2, 1, "", "trace_attributes"], [99, 2, 1, "", "transients_attributes"], [99, 2, 1, "", "update"], [99, 2, 1, "", "update_dynamics"], [99, 2, 1, "", "update_feedthrough"], [99, 2, 1, "", "update_input"], [99, 2, 1, "", "update_output_constants"], [99, 2, 1, "", "update_output_matrix"], [99, 2, 1, "", "update_state"], [99, 2, 1, "", "update_state_constants"], [99, 2, 1, "", "validate_class"], [99, 2, 1, "", "warning"]], "engforge.eng.fluid_material.CoolPropMixture": [[100, 3, 1, "", "Ut_ref"], [100, 3, 1, "", "Xt_ref"], [100, 3, 1, "", "Yt_ref"], [100, 2, 1, "", "__call__"], [100, 2, 1, "", "add_fields"], [100, 3, 1, "", "anything_changed"], [100, 3, 1, "", "as_dict"], [100, 2, 1, "", "check_ref_slot_type"], [100, 3, 1, "", "classname"], [100, 2, 1, "", "cls_compile"], [100, 2, 1, "", "collect_all_attributes"], [100, 2, 1, "", "collect_comp_refs"], [100, 2, 1, "", "collect_dynamic_refs"], [100, 2, 1, "", "collect_inst_attributes"], [100, 2, 1, "", "collect_post_update_refs"], [100, 2, 1, "", "collect_solver_refs"], [100, 2, 1, "", "collect_update_refs"], [100, 2, 1, "", "comp_references"], [100, 2, 1, "", "compile_classes"], [100, 2, 1, "", "copy_config_at_state"], [100, 2, 1, "", "create_dynamic_matricies"], [100, 2, 1, "", "create_feedthrough_matrix"], [100, 2, 1, "", "create_input_matrix"], [100, 2, 1, "", "create_output_constants"], [100, 2, 1, "", "create_output_matrix"], [100, 2, 1, "", "create_state_constants"], [100, 2, 1, "", "create_state_matrix"], [100, 2, 1, "", "critical"], [100, 3, 1, "", "dXtdt_ref"], [100, 3, 1, "", "data_dict"], [100, 2, 1, "", "debug"], [100, 2, 1, "", "determine_nearest_stationary_state"], [100, 2, 1, "", "difference"], [100, 2, 1, "", "error"], [100, 3, 1, "", "filename"], [100, 2, 1, "", "filter"], [100, 2, 1, "", "get_system_input_refs"], [100, 2, 1, "", "go_through_configurations"], [100, 3, 1, "", "identity"], [100, 2, 1, "", "info"], [100, 3, 1, "", "input_as_dict"], [100, 2, 1, "", "input_fields"], [100, 2, 1, "", "installSTDLogger"], [100, 2, 1, "", "internal_components"], [100, 2, 1, "", "internal_configurations"], [100, 2, 1, "", "internal_references"], [100, 2, 1, "", "internal_systems"], [100, 2, 1, "", "internal_tabulations"], [100, 3, 1, "", "last_context"], [100, 2, 1, "", "linear_output"], [100, 2, 1, "", "linear_step"], [100, 2, 1, "", "locate"], [100, 2, 1, "", "locate_ref"], [100, 2, 1, "", "message_with_identiy"], [100, 2, 1, "", "msg"], [100, 2, 1, "", "nonlinear_output"], [100, 2, 1, "", "nonlinear_step"], [100, 2, 1, "", "parent_configurations_cls"], [100, 2, 1, "", "parse_run_kwargs"], [100, 2, 1, "", "parse_simulation_input"], [100, 2, 1, "", "plot_attributes"], [100, 3, 1, "", "plotable_variables"], [100, 2, 1, "", "post_update"], [100, 2, 1, "", "pre_compile"], [100, 2, 1, "", "rate"], [100, 2, 1, "", "rate_linear"], [100, 2, 1, "", "rate_nonlinear"], [100, 2, 1, "", "ref_dXdt"], [100, 2, 1, "", "resetLog"], [100, 2, 1, "", "resetSystemLogs"], [100, 2, 1, "", "set_time"], [100, 2, 1, "", "setattrs"], [100, 2, 1, "", "signals_attributes"], [100, 3, 1, "", "skip_plot_vars"], [100, 2, 1, "", "slot_refs"], [100, 2, 1, "", "slots_attributes"], [100, 2, 1, "", "smart_split_dataframe"], [100, 2, 1, "", "solvers_attributes"], [100, 2, 1, "", "subclasses"], [100, 2, 1, "", "subcls_compile"], [100, 3, 1, "", "system_id"], [100, 2, 1, "", "system_properties_classdef"], [100, 2, 1, "", "system_references"], [100, 2, 1, "", "trace_attributes"], [100, 2, 1, "", "transients_attributes"], [100, 2, 1, "", "update"], [100, 2, 1, "", "update_dynamics"], [100, 2, 1, "", "update_feedthrough"], [100, 2, 1, "", "update_input"], [100, 2, 1, "", "update_mass_ratios"], [100, 2, 1, "", "update_output_constants"], [100, 2, 1, "", "update_output_matrix"], [100, 2, 1, "", "update_state"], [100, 2, 1, "", "update_state_constants"], [100, 2, 1, "", "validate_class"], [100, 2, 1, "", "warning"]], "engforge.eng.fluid_material.FluidMaterial": [[101, 3, 1, "", "Ut_ref"], [101, 3, 1, "", "Xt_ref"], [101, 3, 1, "", "Yt_ref"], [101, 2, 1, "", "add_fields"], [101, 3, 1, "", "anything_changed"], [101, 3, 1, "", "as_dict"], [101, 2, 1, "", "check_ref_slot_type"], [101, 3, 1, "", "classname"], [101, 2, 1, "", "cls_compile"], [101, 2, 1, "", "collect_all_attributes"], [101, 2, 1, "", "collect_comp_refs"], [101, 2, 1, "", "collect_dynamic_refs"], [101, 2, 1, "", "collect_inst_attributes"], [101, 2, 1, "", "collect_post_update_refs"], [101, 2, 1, "", "collect_solver_refs"], [101, 2, 1, "", "collect_update_refs"], [101, 2, 1, "", "comp_references"], [101, 2, 1, "", "compile_classes"], [101, 2, 1, "", "copy_config_at_state"], [101, 2, 1, "", "create_dynamic_matricies"], [101, 2, 1, "", "create_feedthrough_matrix"], [101, 2, 1, "", "create_input_matrix"], [101, 2, 1, "", "create_output_constants"], [101, 2, 1, "", "create_output_matrix"], [101, 2, 1, "", "create_state_constants"], [101, 2, 1, "", "create_state_matrix"], [101, 2, 1, "", "critical"], [101, 3, 1, "", "dXtdt_ref"], [101, 3, 1, "", "data_dict"], [101, 2, 1, "", "debug"], [101, 3, 1, "", "density"], [101, 2, 1, "", "determine_nearest_stationary_state"], [101, 2, 1, "", "difference"], [101, 2, 1, "", "error"], [101, 3, 1, "", "filename"], [101, 2, 1, "", "filter"], [101, 2, 1, "", "get_system_input_refs"], [101, 2, 1, "", "go_through_configurations"], [101, 3, 1, "", "identity"], [101, 2, 1, "", "info"], [101, 3, 1, "", "input_as_dict"], [101, 2, 1, "", "input_fields"], [101, 2, 1, "", "installSTDLogger"], [101, 2, 1, "", "internal_components"], [101, 2, 1, "", "internal_configurations"], [101, 2, 1, "", "internal_references"], [101, 2, 1, "", "internal_systems"], [101, 2, 1, "", "internal_tabulations"], [101, 3, 1, "", "last_context"], [101, 2, 1, "", "linear_output"], [101, 2, 1, "", "linear_step"], [101, 2, 1, "", "locate"], [101, 2, 1, "", "locate_ref"], [101, 2, 1, "", "message_with_identiy"], [101, 2, 1, "", "msg"], [101, 2, 1, "", "nonlinear_output"], [101, 2, 1, "", "nonlinear_step"], [101, 2, 1, "", "parent_configurations_cls"], [101, 2, 1, "", "parse_run_kwargs"], [101, 2, 1, "", "parse_simulation_input"], [101, 2, 1, "", "plot_attributes"], [101, 3, 1, "", "plotable_variables"], [101, 2, 1, "", "post_update"], [101, 2, 1, "", "pre_compile"], [101, 2, 1, "", "rate"], [101, 2, 1, "", "rate_linear"], [101, 2, 1, "", "rate_nonlinear"], [101, 2, 1, "", "ref_dXdt"], [101, 2, 1, "", "resetLog"], [101, 2, 1, "", "resetSystemLogs"], [101, 2, 1, "", "set_time"], [101, 2, 1, "", "setattrs"], [101, 2, 1, "", "signals_attributes"], [101, 3, 1, "", "skip_plot_vars"], [101, 2, 1, "", "slot_refs"], [101, 2, 1, "", "slots_attributes"], [101, 2, 1, "", "smart_split_dataframe"], [101, 2, 1, "", "solvers_attributes"], [101, 2, 1, "", "subclasses"], [101, 2, 1, "", "subcls_compile"], [101, 3, 1, "", "system_id"], [101, 2, 1, "", "system_properties_classdef"], [101, 2, 1, "", "system_references"], [101, 2, 1, "", "trace_attributes"], [101, 2, 1, "", "transients_attributes"], [101, 2, 1, "", "update"], [101, 2, 1, "", "update_dynamics"], [101, 2, 1, "", "update_feedthrough"], [101, 2, 1, "", "update_input"], [101, 2, 1, "", "update_output_constants"], [101, 2, 1, "", "update_output_matrix"], [101, 2, 1, "", "update_state"], [101, 2, 1, "", "update_state_constants"], [101, 2, 1, "", "validate_class"], [101, 3, 1, "", "viscosity"], [101, 2, 1, "", "warning"]], "engforge.eng.fluid_material.Hydrogen": [[102, 3, 1, "", "Ut_ref"], [102, 3, 1, "", "Xt_ref"], [102, 3, 1, "", "Yt_ref"], [102, 2, 1, "", "__call__"], [102, 2, 1, "", "add_fields"], [102, 3, 1, "", "anything_changed"], [102, 3, 1, "", "as_dict"], [102, 2, 1, "", "check_ref_slot_type"], [102, 3, 1, "", "classname"], [102, 2, 1, "", "cls_compile"], [102, 2, 1, "", "collect_all_attributes"], [102, 2, 1, "", "collect_comp_refs"], [102, 2, 1, "", "collect_dynamic_refs"], [102, 2, 1, "", "collect_inst_attributes"], [102, 2, 1, "", "collect_post_update_refs"], [102, 2, 1, "", "collect_solver_refs"], [102, 2, 1, "", "collect_update_refs"], [102, 2, 1, "", "comp_references"], [102, 2, 1, "", "compile_classes"], [102, 2, 1, "", "copy_config_at_state"], [102, 2, 1, "", "create_dynamic_matricies"], [102, 2, 1, "", "create_feedthrough_matrix"], [102, 2, 1, "", "create_input_matrix"], [102, 2, 1, "", "create_output_constants"], [102, 2, 1, "", "create_output_matrix"], [102, 2, 1, "", "create_state_constants"], [102, 2, 1, "", "create_state_matrix"], [102, 2, 1, "", "critical"], [102, 3, 1, "", "dXtdt_ref"], [102, 3, 1, "", "data_dict"], [102, 2, 1, "", "debug"], [102, 2, 1, "", "determine_nearest_stationary_state"], [102, 2, 1, "", "difference"], [102, 2, 1, "", "error"], [102, 3, 1, "", "filename"], [102, 2, 1, "", "filter"], [102, 2, 1, "", "get_system_input_refs"], [102, 2, 1, "", "go_through_configurations"], [102, 3, 1, "", "identity"], [102, 2, 1, "", "info"], [102, 3, 1, "", "input_as_dict"], [102, 2, 1, "", "input_fields"], [102, 2, 1, "", "installSTDLogger"], [102, 2, 1, "", "internal_components"], [102, 2, 1, "", "internal_configurations"], [102, 2, 1, "", "internal_references"], [102, 2, 1, "", "internal_systems"], [102, 2, 1, "", "internal_tabulations"], [102, 3, 1, "", "last_context"], [102, 2, 1, "", "linear_output"], [102, 2, 1, "", "linear_step"], [102, 2, 1, "", "locate"], [102, 2, 1, "", "locate_ref"], [102, 2, 1, "", "message_with_identiy"], [102, 2, 1, "", "msg"], [102, 2, 1, "", "nonlinear_output"], [102, 2, 1, "", "nonlinear_step"], [102, 2, 1, "", "parent_configurations_cls"], [102, 2, 1, "", "parse_run_kwargs"], [102, 2, 1, "", "parse_simulation_input"], [102, 2, 1, "", "plot_attributes"], [102, 3, 1, "", "plotable_variables"], [102, 2, 1, "", "post_update"], [102, 2, 1, "", "pre_compile"], [102, 2, 1, "", "rate"], [102, 2, 1, "", "rate_linear"], [102, 2, 1, "", "rate_nonlinear"], [102, 2, 1, "", "ref_dXdt"], [102, 2, 1, "", "resetLog"], [102, 2, 1, "", "resetSystemLogs"], [102, 2, 1, "", "set_time"], [102, 2, 1, "", "setattrs"], [102, 2, 1, "", "signals_attributes"], [102, 3, 1, "", "skip_plot_vars"], [102, 2, 1, "", "slot_refs"], [102, 2, 1, "", "slots_attributes"], [102, 2, 1, "", "smart_split_dataframe"], [102, 2, 1, "", "solvers_attributes"], [102, 2, 1, "", "subclasses"], [102, 2, 1, "", "subcls_compile"], [102, 3, 1, "", "system_id"], [102, 2, 1, "", "system_properties_classdef"], [102, 2, 1, "", "system_references"], [102, 2, 1, "", "trace_attributes"], [102, 2, 1, "", "transients_attributes"], [102, 2, 1, "", "update"], [102, 2, 1, "", "update_dynamics"], [102, 2, 1, "", "update_feedthrough"], [102, 2, 1, "", "update_input"], [102, 2, 1, "", "update_output_constants"], [102, 2, 1, "", "update_output_matrix"], [102, 2, 1, "", "update_state"], [102, 2, 1, "", "update_state_constants"], [102, 2, 1, "", "validate_class"], [102, 2, 1, "", "warning"]], "engforge.eng.fluid_material.IdealAir": [[103, 3, 1, "", "Ut_ref"], [103, 3, 1, "", "Xt_ref"], [103, 3, 1, "", "Yt_ref"], [103, 2, 1, "", "add_fields"], [103, 3, 1, "", "anything_changed"], [103, 3, 1, "", "as_dict"], [103, 2, 1, "", "check_ref_slot_type"], [103, 3, 1, "", "classname"], [103, 2, 1, "", "cls_compile"], [103, 2, 1, "", "collect_all_attributes"], [103, 2, 1, "", "collect_comp_refs"], [103, 2, 1, "", "collect_dynamic_refs"], [103, 2, 1, "", "collect_inst_attributes"], [103, 2, 1, "", "collect_post_update_refs"], [103, 2, 1, "", "collect_solver_refs"], [103, 2, 1, "", "collect_update_refs"], [103, 2, 1, "", "comp_references"], [103, 2, 1, "", "compile_classes"], [103, 2, 1, "", "copy_config_at_state"], [103, 2, 1, "", "create_dynamic_matricies"], [103, 2, 1, "", "create_feedthrough_matrix"], [103, 2, 1, "", "create_input_matrix"], [103, 2, 1, "", "create_output_constants"], [103, 2, 1, "", "create_output_matrix"], [103, 2, 1, "", "create_state_constants"], [103, 2, 1, "", "create_state_matrix"], [103, 2, 1, "", "critical"], [103, 3, 1, "", "dXtdt_ref"], [103, 3, 1, "", "data_dict"], [103, 2, 1, "", "debug"], [103, 2, 1, "", "determine_nearest_stationary_state"], [103, 2, 1, "", "difference"], [103, 2, 1, "", "error"], [103, 3, 1, "", "filename"], [103, 2, 1, "", "filter"], [103, 2, 1, "", "get_system_input_refs"], [103, 2, 1, "", "go_through_configurations"], [103, 3, 1, "", "identity"], [103, 2, 1, "", "info"], [103, 3, 1, "", "input_as_dict"], [103, 2, 1, "", "input_fields"], [103, 2, 1, "", "installSTDLogger"], [103, 2, 1, "", "internal_components"], [103, 2, 1, "", "internal_configurations"], [103, 2, 1, "", "internal_references"], [103, 2, 1, "", "internal_systems"], [103, 2, 1, "", "internal_tabulations"], [103, 3, 1, "", "last_context"], [103, 2, 1, "", "linear_output"], [103, 2, 1, "", "linear_step"], [103, 2, 1, "", "locate"], [103, 2, 1, "", "locate_ref"], [103, 2, 1, "", "message_with_identiy"], [103, 2, 1, "", "msg"], [103, 2, 1, "", "nonlinear_output"], [103, 2, 1, "", "nonlinear_step"], [103, 2, 1, "", "parent_configurations_cls"], [103, 2, 1, "", "parse_run_kwargs"], [103, 2, 1, "", "parse_simulation_input"], [103, 2, 1, "", "plot_attributes"], [103, 3, 1, "", "plotable_variables"], [103, 2, 1, "", "post_update"], [103, 2, 1, "", "pre_compile"], [103, 2, 1, "", "rate"], [103, 2, 1, "", "rate_linear"], [103, 2, 1, "", "rate_nonlinear"], [103, 2, 1, "", "ref_dXdt"], [103, 2, 1, "", "resetLog"], [103, 2, 1, "", "resetSystemLogs"], [103, 2, 1, "", "set_time"], [103, 2, 1, "", "setattrs"], [103, 2, 1, "", "signals_attributes"], [103, 3, 1, "", "skip_plot_vars"], [103, 2, 1, "", "slot_refs"], [103, 2, 1, "", "slots_attributes"], [103, 2, 1, "", "smart_split_dataframe"], [103, 2, 1, "", "solvers_attributes"], [103, 2, 1, "", "subclasses"], [103, 2, 1, "", "subcls_compile"], [103, 3, 1, "", "system_id"], [103, 2, 1, "", "system_properties_classdef"], [103, 2, 1, "", "system_references"], [103, 2, 1, "", "trace_attributes"], [103, 2, 1, "", "transients_attributes"], [103, 2, 1, "", "update"], [103, 2, 1, "", "update_dynamics"], [103, 2, 1, "", "update_feedthrough"], [103, 2, 1, "", "update_input"], [103, 2, 1, "", "update_output_constants"], [103, 2, 1, "", "update_output_matrix"], [103, 2, 1, "", "update_state"], [103, 2, 1, "", "update_state_constants"], [103, 2, 1, "", "validate_class"], [103, 2, 1, "", "warning"]], "engforge.eng.fluid_material.IdealGas": [[104, 3, 1, "", "Ut_ref"], [104, 3, 1, "", "Xt_ref"], [104, 3, 1, "", "Yt_ref"], [104, 2, 1, "", "add_fields"], [104, 3, 1, "", "anything_changed"], [104, 3, 1, "", "as_dict"], [104, 2, 1, "", "check_ref_slot_type"], [104, 3, 1, "", "classname"], [104, 2, 1, "", "cls_compile"], [104, 2, 1, "", "collect_all_attributes"], [104, 2, 1, "", "collect_comp_refs"], [104, 2, 1, "", "collect_dynamic_refs"], [104, 2, 1, "", "collect_inst_attributes"], [104, 2, 1, "", "collect_post_update_refs"], [104, 2, 1, "", "collect_solver_refs"], [104, 2, 1, "", "collect_update_refs"], [104, 2, 1, "", "comp_references"], [104, 2, 1, "", "compile_classes"], [104, 2, 1, "", "copy_config_at_state"], [104, 2, 1, "", "create_dynamic_matricies"], [104, 2, 1, "", "create_feedthrough_matrix"], [104, 2, 1, "", "create_input_matrix"], [104, 2, 1, "", "create_output_constants"], [104, 2, 1, "", "create_output_matrix"], [104, 2, 1, "", "create_state_constants"], [104, 2, 1, "", "create_state_matrix"], [104, 2, 1, "", "critical"], [104, 3, 1, "", "dXtdt_ref"], [104, 3, 1, "", "data_dict"], [104, 2, 1, "", "debug"], [104, 2, 1, "", "determine_nearest_stationary_state"], [104, 2, 1, "", "difference"], [104, 2, 1, "", "error"], [104, 3, 1, "", "filename"], [104, 2, 1, "", "filter"], [104, 2, 1, "", "get_system_input_refs"], [104, 2, 1, "", "go_through_configurations"], [104, 3, 1, "", "identity"], [104, 2, 1, "", "info"], [104, 3, 1, "", "input_as_dict"], [104, 2, 1, "", "input_fields"], [104, 2, 1, "", "installSTDLogger"], [104, 2, 1, "", "internal_components"], [104, 2, 1, "", "internal_configurations"], [104, 2, 1, "", "internal_references"], [104, 2, 1, "", "internal_systems"], [104, 2, 1, "", "internal_tabulations"], [104, 3, 1, "", "last_context"], [104, 2, 1, "", "linear_output"], [104, 2, 1, "", "linear_step"], [104, 2, 1, "", "locate"], [104, 2, 1, "", "locate_ref"], [104, 2, 1, "", "message_with_identiy"], [104, 2, 1, "", "msg"], [104, 2, 1, "", "nonlinear_output"], [104, 2, 1, "", "nonlinear_step"], [104, 2, 1, "", "parent_configurations_cls"], [104, 2, 1, "", "parse_run_kwargs"], [104, 2, 1, "", "parse_simulation_input"], [104, 2, 1, "", "plot_attributes"], [104, 3, 1, "", "plotable_variables"], [104, 2, 1, "", "post_update"], [104, 2, 1, "", "pre_compile"], [104, 2, 1, "", "rate"], [104, 2, 1, "", "rate_linear"], [104, 2, 1, "", "rate_nonlinear"], [104, 2, 1, "", "ref_dXdt"], [104, 2, 1, "", "resetLog"], [104, 2, 1, "", "resetSystemLogs"], [104, 2, 1, "", "set_time"], [104, 2, 1, "", "setattrs"], [104, 2, 1, "", "signals_attributes"], [104, 3, 1, "", "skip_plot_vars"], [104, 2, 1, "", "slot_refs"], [104, 2, 1, "", "slots_attributes"], [104, 2, 1, "", "smart_split_dataframe"], [104, 2, 1, "", "solvers_attributes"], [104, 2, 1, "", "subclasses"], [104, 2, 1, "", "subcls_compile"], [104, 3, 1, "", "system_id"], [104, 2, 1, "", "system_properties_classdef"], [104, 2, 1, "", "system_references"], [104, 2, 1, "", "trace_attributes"], [104, 2, 1, "", "transients_attributes"], [104, 2, 1, "", "update"], [104, 2, 1, "", "update_dynamics"], [104, 2, 1, "", "update_feedthrough"], [104, 2, 1, "", "update_input"], [104, 2, 1, "", "update_output_constants"], [104, 2, 1, "", "update_output_matrix"], [104, 2, 1, "", "update_state"], [104, 2, 1, "", "update_state_constants"], [104, 2, 1, "", "validate_class"], [104, 2, 1, "", "warning"]], "engforge.eng.fluid_material.IdealH2": [[105, 3, 1, "", "Ut_ref"], [105, 3, 1, "", "Xt_ref"], [105, 3, 1, "", "Yt_ref"], [105, 2, 1, "", "add_fields"], [105, 3, 1, "", "anything_changed"], [105, 3, 1, "", "as_dict"], [105, 2, 1, "", "check_ref_slot_type"], [105, 3, 1, "", "classname"], [105, 2, 1, "", "cls_compile"], [105, 2, 1, "", "collect_all_attributes"], [105, 2, 1, "", "collect_comp_refs"], [105, 2, 1, "", "collect_dynamic_refs"], [105, 2, 1, "", "collect_inst_attributes"], [105, 2, 1, "", "collect_post_update_refs"], [105, 2, 1, "", "collect_solver_refs"], [105, 2, 1, "", "collect_update_refs"], [105, 2, 1, "", "comp_references"], [105, 2, 1, "", "compile_classes"], [105, 2, 1, "", "copy_config_at_state"], [105, 2, 1, "", "create_dynamic_matricies"], [105, 2, 1, "", "create_feedthrough_matrix"], [105, 2, 1, "", "create_input_matrix"], [105, 2, 1, "", "create_output_constants"], [105, 2, 1, "", "create_output_matrix"], [105, 2, 1, "", "create_state_constants"], [105, 2, 1, "", "create_state_matrix"], [105, 2, 1, "", "critical"], [105, 3, 1, "", "dXtdt_ref"], [105, 3, 1, "", "data_dict"], [105, 2, 1, "", "debug"], [105, 2, 1, "", "determine_nearest_stationary_state"], [105, 2, 1, "", "difference"], [105, 2, 1, "", "error"], [105, 3, 1, "", "filename"], [105, 2, 1, "", "filter"], [105, 2, 1, "", "get_system_input_refs"], [105, 2, 1, "", "go_through_configurations"], [105, 3, 1, "", "identity"], [105, 2, 1, "", "info"], [105, 3, 1, "", "input_as_dict"], [105, 2, 1, "", "input_fields"], [105, 2, 1, "", "installSTDLogger"], [105, 2, 1, "", "internal_components"], [105, 2, 1, "", "internal_configurations"], [105, 2, 1, "", "internal_references"], [105, 2, 1, "", "internal_systems"], [105, 2, 1, "", "internal_tabulations"], [105, 3, 1, "", "last_context"], [105, 2, 1, "", "linear_output"], [105, 2, 1, "", "linear_step"], [105, 2, 1, "", "locate"], [105, 2, 1, "", "locate_ref"], [105, 2, 1, "", "message_with_identiy"], [105, 2, 1, "", "msg"], [105, 2, 1, "", "nonlinear_output"], [105, 2, 1, "", "nonlinear_step"], [105, 2, 1, "", "parent_configurations_cls"], [105, 2, 1, "", "parse_run_kwargs"], [105, 2, 1, "", "parse_simulation_input"], [105, 2, 1, "", "plot_attributes"], [105, 3, 1, "", "plotable_variables"], [105, 2, 1, "", "post_update"], [105, 2, 1, "", "pre_compile"], [105, 2, 1, "", "rate"], [105, 2, 1, "", "rate_linear"], [105, 2, 1, "", "rate_nonlinear"], [105, 2, 1, "", "ref_dXdt"], [105, 2, 1, "", "resetLog"], [105, 2, 1, "", "resetSystemLogs"], [105, 2, 1, "", "set_time"], [105, 2, 1, "", "setattrs"], [105, 2, 1, "", "signals_attributes"], [105, 3, 1, "", "skip_plot_vars"], [105, 2, 1, "", "slot_refs"], [105, 2, 1, "", "slots_attributes"], [105, 2, 1, "", "smart_split_dataframe"], [105, 2, 1, "", "solvers_attributes"], [105, 2, 1, "", "subclasses"], [105, 2, 1, "", "subcls_compile"], [105, 3, 1, "", "system_id"], [105, 2, 1, "", "system_properties_classdef"], [105, 2, 1, "", "system_references"], [105, 2, 1, "", "trace_attributes"], [105, 2, 1, "", "transients_attributes"], [105, 2, 1, "", "update"], [105, 2, 1, "", "update_dynamics"], [105, 2, 1, "", "update_feedthrough"], [105, 2, 1, "", "update_input"], [105, 2, 1, "", "update_output_constants"], [105, 2, 1, "", "update_output_matrix"], [105, 2, 1, "", "update_state"], [105, 2, 1, "", "update_state_constants"], [105, 2, 1, "", "validate_class"], [105, 2, 1, "", "warning"]], "engforge.eng.fluid_material.IdealOxygen": [[106, 3, 1, "", "Ut_ref"], [106, 3, 1, "", "Xt_ref"], [106, 3, 1, "", "Yt_ref"], [106, 2, 1, "", "add_fields"], [106, 3, 1, "", "anything_changed"], [106, 3, 1, "", "as_dict"], [106, 2, 1, "", "check_ref_slot_type"], [106, 3, 1, "", "classname"], [106, 2, 1, "", "cls_compile"], [106, 2, 1, "", "collect_all_attributes"], [106, 2, 1, "", "collect_comp_refs"], [106, 2, 1, "", "collect_dynamic_refs"], [106, 2, 1, "", "collect_inst_attributes"], [106, 2, 1, "", "collect_post_update_refs"], [106, 2, 1, "", "collect_solver_refs"], [106, 2, 1, "", "collect_update_refs"], [106, 2, 1, "", "comp_references"], [106, 2, 1, "", "compile_classes"], [106, 2, 1, "", "copy_config_at_state"], [106, 2, 1, "", "create_dynamic_matricies"], [106, 2, 1, "", "create_feedthrough_matrix"], [106, 2, 1, "", "create_input_matrix"], [106, 2, 1, "", "create_output_constants"], [106, 2, 1, "", "create_output_matrix"], [106, 2, 1, "", "create_state_constants"], [106, 2, 1, "", "create_state_matrix"], [106, 2, 1, "", "critical"], [106, 3, 1, "", "dXtdt_ref"], [106, 3, 1, "", "data_dict"], [106, 2, 1, "", "debug"], [106, 2, 1, "", "determine_nearest_stationary_state"], [106, 2, 1, "", "difference"], [106, 2, 1, "", "error"], [106, 3, 1, "", "filename"], [106, 2, 1, "", "filter"], [106, 2, 1, "", "get_system_input_refs"], [106, 2, 1, "", "go_through_configurations"], [106, 3, 1, "", "identity"], [106, 2, 1, "", "info"], [106, 3, 1, "", "input_as_dict"], [106, 2, 1, "", "input_fields"], [106, 2, 1, "", "installSTDLogger"], [106, 2, 1, "", "internal_components"], [106, 2, 1, "", "internal_configurations"], [106, 2, 1, "", "internal_references"], [106, 2, 1, "", "internal_systems"], [106, 2, 1, "", "internal_tabulations"], [106, 3, 1, "", "last_context"], [106, 2, 1, "", "linear_output"], [106, 2, 1, "", "linear_step"], [106, 2, 1, "", "locate"], [106, 2, 1, "", "locate_ref"], [106, 2, 1, "", "message_with_identiy"], [106, 2, 1, "", "msg"], [106, 2, 1, "", "nonlinear_output"], [106, 2, 1, "", "nonlinear_step"], [106, 2, 1, "", "parent_configurations_cls"], [106, 2, 1, "", "parse_run_kwargs"], [106, 2, 1, "", "parse_simulation_input"], [106, 2, 1, "", "plot_attributes"], [106, 3, 1, "", "plotable_variables"], [106, 2, 1, "", "post_update"], [106, 2, 1, "", "pre_compile"], [106, 2, 1, "", "rate"], [106, 2, 1, "", "rate_linear"], [106, 2, 1, "", "rate_nonlinear"], [106, 2, 1, "", "ref_dXdt"], [106, 2, 1, "", "resetLog"], [106, 2, 1, "", "resetSystemLogs"], [106, 2, 1, "", "set_time"], [106, 2, 1, "", "setattrs"], [106, 2, 1, "", "signals_attributes"], [106, 3, 1, "", "skip_plot_vars"], [106, 2, 1, "", "slot_refs"], [106, 2, 1, "", "slots_attributes"], [106, 2, 1, "", "smart_split_dataframe"], [106, 2, 1, "", "solvers_attributes"], [106, 2, 1, "", "subclasses"], [106, 2, 1, "", "subcls_compile"], [106, 3, 1, "", "system_id"], [106, 2, 1, "", "system_properties_classdef"], [106, 2, 1, "", "system_references"], [106, 2, 1, "", "trace_attributes"], [106, 2, 1, "", "transients_attributes"], [106, 2, 1, "", "update"], [106, 2, 1, "", "update_dynamics"], [106, 2, 1, "", "update_feedthrough"], [106, 2, 1, "", "update_input"], [106, 2, 1, "", "update_output_constants"], [106, 2, 1, "", "update_output_matrix"], [106, 2, 1, "", "update_state"], [106, 2, 1, "", "update_state_constants"], [106, 2, 1, "", "validate_class"], [106, 2, 1, "", "warning"]], "engforge.eng.fluid_material.IdealSteam": [[107, 3, 1, "", "Ut_ref"], [107, 3, 1, "", "Xt_ref"], [107, 3, 1, "", "Yt_ref"], [107, 2, 1, "", "add_fields"], [107, 3, 1, "", "anything_changed"], [107, 3, 1, "", "as_dict"], [107, 2, 1, "", "check_ref_slot_type"], [107, 3, 1, "", "classname"], [107, 2, 1, "", "cls_compile"], [107, 2, 1, "", "collect_all_attributes"], [107, 2, 1, "", "collect_comp_refs"], [107, 2, 1, "", "collect_dynamic_refs"], [107, 2, 1, "", "collect_inst_attributes"], [107, 2, 1, "", "collect_post_update_refs"], [107, 2, 1, "", "collect_solver_refs"], [107, 2, 1, "", "collect_update_refs"], [107, 2, 1, "", "comp_references"], [107, 2, 1, "", "compile_classes"], [107, 2, 1, "", "copy_config_at_state"], [107, 2, 1, "", "create_dynamic_matricies"], [107, 2, 1, "", "create_feedthrough_matrix"], [107, 2, 1, "", "create_input_matrix"], [107, 2, 1, "", "create_output_constants"], [107, 2, 1, "", "create_output_matrix"], [107, 2, 1, "", "create_state_constants"], [107, 2, 1, "", "create_state_matrix"], [107, 2, 1, "", "critical"], [107, 3, 1, "", "dXtdt_ref"], [107, 3, 1, "", "data_dict"], [107, 2, 1, "", "debug"], [107, 2, 1, "", "determine_nearest_stationary_state"], [107, 2, 1, "", "difference"], [107, 2, 1, "", "error"], [107, 3, 1, "", "filename"], [107, 2, 1, "", "filter"], [107, 2, 1, "", "get_system_input_refs"], [107, 2, 1, "", "go_through_configurations"], [107, 3, 1, "", "identity"], [107, 2, 1, "", "info"], [107, 3, 1, "", "input_as_dict"], [107, 2, 1, "", "input_fields"], [107, 2, 1, "", "installSTDLogger"], [107, 2, 1, "", "internal_components"], [107, 2, 1, "", "internal_configurations"], [107, 2, 1, "", "internal_references"], [107, 2, 1, "", "internal_systems"], [107, 2, 1, "", "internal_tabulations"], [107, 3, 1, "", "last_context"], [107, 2, 1, "", "linear_output"], [107, 2, 1, "", "linear_step"], [107, 2, 1, "", "locate"], [107, 2, 1, "", "locate_ref"], [107, 2, 1, "", "message_with_identiy"], [107, 2, 1, "", "msg"], [107, 2, 1, "", "nonlinear_output"], [107, 2, 1, "", "nonlinear_step"], [107, 2, 1, "", "parent_configurations_cls"], [107, 2, 1, "", "parse_run_kwargs"], [107, 2, 1, "", "parse_simulation_input"], [107, 2, 1, "", "plot_attributes"], [107, 3, 1, "", "plotable_variables"], [107, 2, 1, "", "post_update"], [107, 2, 1, "", "pre_compile"], [107, 2, 1, "", "rate"], [107, 2, 1, "", "rate_linear"], [107, 2, 1, "", "rate_nonlinear"], [107, 2, 1, "", "ref_dXdt"], [107, 2, 1, "", "resetLog"], [107, 2, 1, "", "resetSystemLogs"], [107, 2, 1, "", "set_time"], [107, 2, 1, "", "setattrs"], [107, 2, 1, "", "signals_attributes"], [107, 3, 1, "", "skip_plot_vars"], [107, 2, 1, "", "slot_refs"], [107, 2, 1, "", "slots_attributes"], [107, 2, 1, "", "smart_split_dataframe"], [107, 2, 1, "", "solvers_attributes"], [107, 2, 1, "", "subclasses"], [107, 2, 1, "", "subcls_compile"], [107, 3, 1, "", "system_id"], [107, 2, 1, "", "system_properties_classdef"], [107, 2, 1, "", "system_references"], [107, 2, 1, "", "trace_attributes"], [107, 2, 1, "", "transients_attributes"], [107, 2, 1, "", "update"], [107, 2, 1, "", "update_dynamics"], [107, 2, 1, "", "update_feedthrough"], [107, 2, 1, "", "update_input"], [107, 2, 1, "", "update_output_constants"], [107, 2, 1, "", "update_output_matrix"], [107, 2, 1, "", "update_state"], [107, 2, 1, "", "update_state_constants"], [107, 2, 1, "", "validate_class"], [107, 2, 1, "", "warning"]], "engforge.eng.fluid_material.Oxygen": [[108, 3, 1, "", "Ut_ref"], [108, 3, 1, "", "Xt_ref"], [108, 3, 1, "", "Yt_ref"], [108, 2, 1, "", "__call__"], [108, 2, 1, "", "add_fields"], [108, 3, 1, "", "anything_changed"], [108, 3, 1, "", "as_dict"], [108, 2, 1, "", "check_ref_slot_type"], [108, 3, 1, "", "classname"], [108, 2, 1, "", "cls_compile"], [108, 2, 1, "", "collect_all_attributes"], [108, 2, 1, "", "collect_comp_refs"], [108, 2, 1, "", "collect_dynamic_refs"], [108, 2, 1, "", "collect_inst_attributes"], [108, 2, 1, "", "collect_post_update_refs"], [108, 2, 1, "", "collect_solver_refs"], [108, 2, 1, "", "collect_update_refs"], [108, 2, 1, "", "comp_references"], [108, 2, 1, "", "compile_classes"], [108, 2, 1, "", "copy_config_at_state"], [108, 2, 1, "", "create_dynamic_matricies"], [108, 2, 1, "", "create_feedthrough_matrix"], [108, 2, 1, "", "create_input_matrix"], [108, 2, 1, "", "create_output_constants"], [108, 2, 1, "", "create_output_matrix"], [108, 2, 1, "", "create_state_constants"], [108, 2, 1, "", "create_state_matrix"], [108, 2, 1, "", "critical"], [108, 3, 1, "", "dXtdt_ref"], [108, 3, 1, "", "data_dict"], [108, 2, 1, "", "debug"], [108, 2, 1, "", "determine_nearest_stationary_state"], [108, 2, 1, "", "difference"], [108, 2, 1, "", "error"], [108, 3, 1, "", "filename"], [108, 2, 1, "", "filter"], [108, 2, 1, "", "get_system_input_refs"], [108, 2, 1, "", "go_through_configurations"], [108, 3, 1, "", "identity"], [108, 2, 1, "", "info"], [108, 3, 1, "", "input_as_dict"], [108, 2, 1, "", "input_fields"], [108, 2, 1, "", "installSTDLogger"], [108, 2, 1, "", "internal_components"], [108, 2, 1, "", "internal_configurations"], [108, 2, 1, "", "internal_references"], [108, 2, 1, "", "internal_systems"], [108, 2, 1, "", "internal_tabulations"], [108, 3, 1, "", "last_context"], [108, 2, 1, "", "linear_output"], [108, 2, 1, "", "linear_step"], [108, 2, 1, "", "locate"], [108, 2, 1, "", "locate_ref"], [108, 2, 1, "", "message_with_identiy"], [108, 2, 1, "", "msg"], [108, 2, 1, "", "nonlinear_output"], [108, 2, 1, "", "nonlinear_step"], [108, 2, 1, "", "parent_configurations_cls"], [108, 2, 1, "", "parse_run_kwargs"], [108, 2, 1, "", "parse_simulation_input"], [108, 2, 1, "", "plot_attributes"], [108, 3, 1, "", "plotable_variables"], [108, 2, 1, "", "post_update"], [108, 2, 1, "", "pre_compile"], [108, 2, 1, "", "rate"], [108, 2, 1, "", "rate_linear"], [108, 2, 1, "", "rate_nonlinear"], [108, 2, 1, "", "ref_dXdt"], [108, 2, 1, "", "resetLog"], [108, 2, 1, "", "resetSystemLogs"], [108, 2, 1, "", "set_time"], [108, 2, 1, "", "setattrs"], [108, 2, 1, "", "signals_attributes"], [108, 3, 1, "", "skip_plot_vars"], [108, 2, 1, "", "slot_refs"], [108, 2, 1, "", "slots_attributes"], [108, 2, 1, "", "smart_split_dataframe"], [108, 2, 1, "", "solvers_attributes"], [108, 2, 1, "", "subclasses"], [108, 2, 1, "", "subcls_compile"], [108, 3, 1, "", "system_id"], [108, 2, 1, "", "system_properties_classdef"], [108, 2, 1, "", "system_references"], [108, 2, 1, "", "trace_attributes"], [108, 2, 1, "", "transients_attributes"], [108, 2, 1, "", "update"], [108, 2, 1, "", "update_dynamics"], [108, 2, 1, "", "update_feedthrough"], [108, 2, 1, "", "update_input"], [108, 2, 1, "", "update_output_constants"], [108, 2, 1, "", "update_output_matrix"], [108, 2, 1, "", "update_state"], [108, 2, 1, "", "update_state_constants"], [108, 2, 1, "", "validate_class"], [108, 2, 1, "", "warning"]], "engforge.eng.fluid_material.SeaWater": [[109, 3, 1, "", "Ut_ref"], [109, 3, 1, "", "Xt_ref"], [109, 3, 1, "", "Yt_ref"], [109, 2, 1, "", "__call__"], [109, 2, 1, "", "add_fields"], [109, 3, 1, "", "anything_changed"], [109, 3, 1, "", "as_dict"], [109, 2, 1, "", "check_ref_slot_type"], [109, 3, 1, "", "classname"], [109, 2, 1, "", "cls_compile"], [109, 2, 1, "", "collect_all_attributes"], [109, 2, 1, "", "collect_comp_refs"], [109, 2, 1, "", "collect_dynamic_refs"], [109, 2, 1, "", "collect_inst_attributes"], [109, 2, 1, "", "collect_post_update_refs"], [109, 2, 1, "", "collect_solver_refs"], [109, 2, 1, "", "collect_update_refs"], [109, 2, 1, "", "comp_references"], [109, 2, 1, "", "compile_classes"], [109, 2, 1, "", "copy_config_at_state"], [109, 2, 1, "", "create_dynamic_matricies"], [109, 2, 1, "", "create_feedthrough_matrix"], [109, 2, 1, "", "create_input_matrix"], [109, 2, 1, "", "create_output_constants"], [109, 2, 1, "", "create_output_matrix"], [109, 2, 1, "", "create_state_constants"], [109, 2, 1, "", "create_state_matrix"], [109, 2, 1, "", "critical"], [109, 3, 1, "", "dXtdt_ref"], [109, 3, 1, "", "data_dict"], [109, 2, 1, "", "debug"], [109, 2, 1, "", "determine_nearest_stationary_state"], [109, 2, 1, "", "difference"], [109, 2, 1, "", "error"], [109, 3, 1, "", "filename"], [109, 2, 1, "", "filter"], [109, 2, 1, "", "get_system_input_refs"], [109, 2, 1, "", "go_through_configurations"], [109, 3, 1, "", "identity"], [109, 2, 1, "", "info"], [109, 3, 1, "", "input_as_dict"], [109, 2, 1, "", "input_fields"], [109, 2, 1, "", "installSTDLogger"], [109, 2, 1, "", "internal_components"], [109, 2, 1, "", "internal_configurations"], [109, 2, 1, "", "internal_references"], [109, 2, 1, "", "internal_systems"], [109, 2, 1, "", "internal_tabulations"], [109, 3, 1, "", "last_context"], [109, 2, 1, "", "linear_output"], [109, 2, 1, "", "linear_step"], [109, 2, 1, "", "locate"], [109, 2, 1, "", "locate_ref"], [109, 2, 1, "", "message_with_identiy"], [109, 2, 1, "", "msg"], [109, 2, 1, "", "nonlinear_output"], [109, 2, 1, "", "nonlinear_step"], [109, 2, 1, "", "parent_configurations_cls"], [109, 2, 1, "", "parse_run_kwargs"], [109, 2, 1, "", "parse_simulation_input"], [109, 2, 1, "", "plot_attributes"], [109, 3, 1, "", "plotable_variables"], [109, 2, 1, "", "post_update"], [109, 2, 1, "", "pre_compile"], [109, 2, 1, "", "rate"], [109, 2, 1, "", "rate_linear"], [109, 2, 1, "", "rate_nonlinear"], [109, 2, 1, "", "ref_dXdt"], [109, 2, 1, "", "resetLog"], [109, 2, 1, "", "resetSystemLogs"], [109, 2, 1, "", "set_time"], [109, 2, 1, "", "setattrs"], [109, 2, 1, "", "signals_attributes"], [109, 3, 1, "", "skip_plot_vars"], [109, 2, 1, "", "slot_refs"], [109, 2, 1, "", "slots_attributes"], [109, 2, 1, "", "smart_split_dataframe"], [109, 2, 1, "", "solvers_attributes"], [109, 2, 1, "", "subclasses"], [109, 2, 1, "", "subcls_compile"], [109, 3, 1, "", "system_id"], [109, 2, 1, "", "system_properties_classdef"], [109, 2, 1, "", "system_references"], [109, 2, 1, "", "trace_attributes"], [109, 2, 1, "", "transients_attributes"], [109, 2, 1, "", "update"], [109, 2, 1, "", "update_dynamics"], [109, 2, 1, "", "update_feedthrough"], [109, 2, 1, "", "update_input"], [109, 2, 1, "", "update_output_constants"], [109, 2, 1, "", "update_output_matrix"], [109, 2, 1, "", "update_state"], [109, 2, 1, "", "update_state_constants"], [109, 2, 1, "", "validate_class"], [109, 2, 1, "", "warning"]], "engforge.eng.fluid_material.Steam": [[110, 3, 1, "", "Ut_ref"], [110, 3, 1, "", "Xt_ref"], [110, 3, 1, "", "Yt_ref"], [110, 2, 1, "", "__call__"], [110, 2, 1, "", "add_fields"], [110, 3, 1, "", "anything_changed"], [110, 3, 1, "", "as_dict"], [110, 2, 1, "", "check_ref_slot_type"], [110, 3, 1, "", "classname"], [110, 2, 1, "", "cls_compile"], [110, 2, 1, "", "collect_all_attributes"], [110, 2, 1, "", "collect_comp_refs"], [110, 2, 1, "", "collect_dynamic_refs"], [110, 2, 1, "", "collect_inst_attributes"], [110, 2, 1, "", "collect_post_update_refs"], [110, 2, 1, "", "collect_solver_refs"], [110, 2, 1, "", "collect_update_refs"], [110, 2, 1, "", "comp_references"], [110, 2, 1, "", "compile_classes"], [110, 2, 1, "", "copy_config_at_state"], [110, 2, 1, "", "create_dynamic_matricies"], [110, 2, 1, "", "create_feedthrough_matrix"], [110, 2, 1, "", "create_input_matrix"], [110, 2, 1, "", "create_output_constants"], [110, 2, 1, "", "create_output_matrix"], [110, 2, 1, "", "create_state_constants"], [110, 2, 1, "", "create_state_matrix"], [110, 2, 1, "", "critical"], [110, 3, 1, "", "dXtdt_ref"], [110, 3, 1, "", "data_dict"], [110, 2, 1, "", "debug"], [110, 2, 1, "", "determine_nearest_stationary_state"], [110, 2, 1, "", "difference"], [110, 2, 1, "", "error"], [110, 3, 1, "", "filename"], [110, 2, 1, "", "filter"], [110, 2, 1, "", "get_system_input_refs"], [110, 2, 1, "", "go_through_configurations"], [110, 3, 1, "", "identity"], [110, 2, 1, "", "info"], [110, 3, 1, "", "input_as_dict"], [110, 2, 1, "", "input_fields"], [110, 2, 1, "", "installSTDLogger"], [110, 2, 1, "", "internal_components"], [110, 2, 1, "", "internal_configurations"], [110, 2, 1, "", "internal_references"], [110, 2, 1, "", "internal_systems"], [110, 2, 1, "", "internal_tabulations"], [110, 3, 1, "", "last_context"], [110, 2, 1, "", "linear_output"], [110, 2, 1, "", "linear_step"], [110, 2, 1, "", "locate"], [110, 2, 1, "", "locate_ref"], [110, 2, 1, "", "message_with_identiy"], [110, 2, 1, "", "msg"], [110, 2, 1, "", "nonlinear_output"], [110, 2, 1, "", "nonlinear_step"], [110, 2, 1, "", "parent_configurations_cls"], [110, 2, 1, "", "parse_run_kwargs"], [110, 2, 1, "", "parse_simulation_input"], [110, 2, 1, "", "plot_attributes"], [110, 3, 1, "", "plotable_variables"], [110, 2, 1, "", "post_update"], [110, 2, 1, "", "pre_compile"], [110, 2, 1, "", "rate"], [110, 2, 1, "", "rate_linear"], [110, 2, 1, "", "rate_nonlinear"], [110, 2, 1, "", "ref_dXdt"], [110, 2, 1, "", "resetLog"], [110, 2, 1, "", "resetSystemLogs"], [110, 2, 1, "", "set_time"], [110, 2, 1, "", "setattrs"], [110, 2, 1, "", "signals_attributes"], [110, 3, 1, "", "skip_plot_vars"], [110, 2, 1, "", "slot_refs"], [110, 2, 1, "", "slots_attributes"], [110, 2, 1, "", "smart_split_dataframe"], [110, 2, 1, "", "solvers_attributes"], [110, 2, 1, "", "subclasses"], [110, 2, 1, "", "subcls_compile"], [110, 3, 1, "", "system_id"], [110, 2, 1, "", "system_properties_classdef"], [110, 2, 1, "", "system_references"], [110, 2, 1, "", "trace_attributes"], [110, 2, 1, "", "transients_attributes"], [110, 2, 1, "", "update"], [110, 2, 1, "", "update_dynamics"], [110, 2, 1, "", "update_feedthrough"], [110, 2, 1, "", "update_input"], [110, 2, 1, "", "update_output_constants"], [110, 2, 1, "", "update_output_matrix"], [110, 2, 1, "", "update_state"], [110, 2, 1, "", "update_state_constants"], [110, 2, 1, "", "validate_class"], [110, 2, 1, "", "warning"]], "engforge.eng.fluid_material.Water": [[111, 3, 1, "", "Ut_ref"], [111, 3, 1, "", "Xt_ref"], [111, 3, 1, "", "Yt_ref"], [111, 2, 1, "", "__call__"], [111, 2, 1, "", "add_fields"], [111, 3, 1, "", "anything_changed"], [111, 3, 1, "", "as_dict"], [111, 2, 1, "", "check_ref_slot_type"], [111, 3, 1, "", "classname"], [111, 2, 1, "", "cls_compile"], [111, 2, 1, "", "collect_all_attributes"], [111, 2, 1, "", "collect_comp_refs"], [111, 2, 1, "", "collect_dynamic_refs"], [111, 2, 1, "", "collect_inst_attributes"], [111, 2, 1, "", "collect_post_update_refs"], [111, 2, 1, "", "collect_solver_refs"], [111, 2, 1, "", "collect_update_refs"], [111, 2, 1, "", "comp_references"], [111, 2, 1, "", "compile_classes"], [111, 2, 1, "", "copy_config_at_state"], [111, 2, 1, "", "create_dynamic_matricies"], [111, 2, 1, "", "create_feedthrough_matrix"], [111, 2, 1, "", "create_input_matrix"], [111, 2, 1, "", "create_output_constants"], [111, 2, 1, "", "create_output_matrix"], [111, 2, 1, "", "create_state_constants"], [111, 2, 1, "", "create_state_matrix"], [111, 2, 1, "", "critical"], [111, 3, 1, "", "dXtdt_ref"], [111, 3, 1, "", "data_dict"], [111, 2, 1, "", "debug"], [111, 2, 1, "", "determine_nearest_stationary_state"], [111, 2, 1, "", "difference"], [111, 2, 1, "", "error"], [111, 3, 1, "", "filename"], [111, 2, 1, "", "filter"], [111, 2, 1, "", "get_system_input_refs"], [111, 2, 1, "", "go_through_configurations"], [111, 3, 1, "", "identity"], [111, 2, 1, "", "info"], [111, 3, 1, "", "input_as_dict"], [111, 2, 1, "", "input_fields"], [111, 2, 1, "", "installSTDLogger"], [111, 2, 1, "", "internal_components"], [111, 2, 1, "", "internal_configurations"], [111, 2, 1, "", "internal_references"], [111, 2, 1, "", "internal_systems"], [111, 2, 1, "", "internal_tabulations"], [111, 3, 1, "", "last_context"], [111, 2, 1, "", "linear_output"], [111, 2, 1, "", "linear_step"], [111, 2, 1, "", "locate"], [111, 2, 1, "", "locate_ref"], [111, 2, 1, "", "message_with_identiy"], [111, 2, 1, "", "msg"], [111, 2, 1, "", "nonlinear_output"], [111, 2, 1, "", "nonlinear_step"], [111, 2, 1, "", "parent_configurations_cls"], [111, 2, 1, "", "parse_run_kwargs"], [111, 2, 1, "", "parse_simulation_input"], [111, 2, 1, "", "plot_attributes"], [111, 3, 1, "", "plotable_variables"], [111, 2, 1, "", "post_update"], [111, 2, 1, "", "pre_compile"], [111, 2, 1, "", "rate"], [111, 2, 1, "", "rate_linear"], [111, 2, 1, "", "rate_nonlinear"], [111, 2, 1, "", "ref_dXdt"], [111, 2, 1, "", "resetLog"], [111, 2, 1, "", "resetSystemLogs"], [111, 2, 1, "", "set_time"], [111, 2, 1, "", "setattrs"], [111, 2, 1, "", "signals_attributes"], [111, 3, 1, "", "skip_plot_vars"], [111, 2, 1, "", "slot_refs"], [111, 2, 1, "", "slots_attributes"], [111, 2, 1, "", "smart_split_dataframe"], [111, 2, 1, "", "solvers_attributes"], [111, 2, 1, "", "subclasses"], [111, 2, 1, "", "subcls_compile"], [111, 3, 1, "", "system_id"], [111, 2, 1, "", "system_properties_classdef"], [111, 2, 1, "", "system_references"], [111, 2, 1, "", "trace_attributes"], [111, 2, 1, "", "transients_attributes"], [111, 2, 1, "", "update"], [111, 2, 1, "", "update_dynamics"], [111, 2, 1, "", "update_feedthrough"], [111, 2, 1, "", "update_input"], [111, 2, 1, "", "update_output_constants"], [111, 2, 1, "", "update_output_matrix"], [111, 2, 1, "", "update_state"], [111, 2, 1, "", "update_state_constants"], [111, 2, 1, "", "validate_class"], [111, 2, 1, "", "warning"]], "engforge.eng.geometry": [[113, 1, 1, "", "Circle"], [114, 1, 1, "", "GeometryLog"], [115, 1, 1, "", "HollowCircle"], [116, 1, 1, "", "ParametricSpline"], [117, 1, 1, "", "Profile2D"], [118, 1, 1, "", "Rectangle"], [119, 1, 1, "", "ShapelySection"], [120, 1, 1, "", "Triangle"], [121, 4, 1, "", "calculate_stress"], [122, 4, 1, "", "conver_np"], [123, 4, 1, "", "get_mesh_size"]], "engforge.eng.geometry.Circle": [[113, 3, 1, "", "Ao"], [113, 2, 1, "", "add_fields"], [113, 2, 1, "", "add_prediction_record"], [113, 3, 1, "", "as_dict"], [113, 2, 1, "", "check_and_retrain"], [113, 2, 1, "", "check_out_of_domain"], [113, 2, 1, "", "check_ref_slot_type"], [113, 3, 1, "", "classname"], [113, 2, 1, "", "cls_compile"], [113, 2, 1, "", "collect_all_attributes"], [113, 2, 1, "", "collect_inst_attributes"], [113, 2, 1, "", "compile_classes"], [113, 2, 1, "", "copy_config_at_state"], [113, 2, 1, "", "critical"], [113, 2, 1, "", "debug"], [113, 2, 1, "", "difference"], [113, 2, 1, "", "error"], [113, 3, 1, "", "filename"], [113, 2, 1, "", "filter"], [113, 2, 1, "", "go_through_configurations"], [113, 3, 1, "", "identity"], [113, 2, 1, "", "info"], [113, 3, 1, "", "input_as_dict"], [113, 2, 1, "", "input_fields"], [113, 2, 1, "", "installSTDLogger"], [113, 2, 1, "", "internal_configurations"], [113, 2, 1, "", "message_with_identiy"], [113, 2, 1, "", "msg"], [113, 2, 1, "", "observe_and_predict"], [113, 2, 1, "", "parent_configurations_cls"], [113, 2, 1, "", "plot_attributes"], [113, 2, 1, "", "pre_compile"], [113, 2, 1, "", "resetLog"], [113, 2, 1, "", "resetSystemLogs"], [113, 2, 1, "", "score_data"], [113, 2, 1, "", "setattrs"], [113, 2, 1, "", "signals_attributes"], [113, 2, 1, "", "slot_refs"], [113, 2, 1, "", "slots_attributes"], [113, 2, 1, "", "solvers_attributes"], [113, 2, 1, "", "subclasses"], [113, 2, 1, "", "subcls_compile"], [113, 2, 1, "", "trace_attributes"], [113, 2, 1, "", "train_compare"], [113, 2, 1, "", "training_callback"], [113, 2, 1, "", "transients_attributes"], [113, 2, 1, "", "validate_class"], [113, 2, 1, "", "warning"]], "engforge.eng.geometry.GeometryLog": [[114, 2, 1, "", "add_fields"], [114, 2, 1, "", "critical"], [114, 2, 1, "", "debug"], [114, 2, 1, "", "error"], [114, 2, 1, "", "filter"], [114, 2, 1, "", "info"], [114, 2, 1, "", "installSTDLogger"], [114, 2, 1, "", "message_with_identiy"], [114, 2, 1, "", "msg"], [114, 2, 1, "", "resetLog"], [114, 2, 1, "", "resetSystemLogs"], [114, 2, 1, "", "warning"]], "engforge.eng.geometry.HollowCircle": [[115, 3, 1, "", "Ao"], [115, 2, 1, "", "add_fields"], [115, 2, 1, "", "add_prediction_record"], [115, 3, 1, "", "as_dict"], [115, 2, 1, "", "check_and_retrain"], [115, 2, 1, "", "check_out_of_domain"], [115, 2, 1, "", "check_ref_slot_type"], [115, 3, 1, "", "classname"], [115, 2, 1, "", "cls_compile"], [115, 2, 1, "", "collect_all_attributes"], [115, 2, 1, "", "collect_inst_attributes"], [115, 2, 1, "", "compile_classes"], [115, 2, 1, "", "copy_config_at_state"], [115, 2, 1, "", "critical"], [115, 2, 1, "", "debug"], [115, 2, 1, "", "difference"], [115, 2, 1, "", "error"], [115, 3, 1, "", "filename"], [115, 2, 1, "", "filter"], [115, 2, 1, "", "go_through_configurations"], [115, 3, 1, "", "identity"], [115, 2, 1, "", "info"], [115, 3, 1, "", "input_as_dict"], [115, 2, 1, "", "input_fields"], [115, 2, 1, "", "installSTDLogger"], [115, 2, 1, "", "internal_configurations"], [115, 2, 1, "", "message_with_identiy"], [115, 2, 1, "", "msg"], [115, 2, 1, "", "observe_and_predict"], [115, 2, 1, "", "parent_configurations_cls"], [115, 2, 1, "", "plot_attributes"], [115, 2, 1, "", "pre_compile"], [115, 2, 1, "", "resetLog"], [115, 2, 1, "", "resetSystemLogs"], [115, 2, 1, "", "score_data"], [115, 2, 1, "", "setattrs"], [115, 2, 1, "", "signals_attributes"], [115, 2, 1, "", "slot_refs"], [115, 2, 1, "", "slots_attributes"], [115, 2, 1, "", "solvers_attributes"], [115, 2, 1, "", "subclasses"], [115, 2, 1, "", "subcls_compile"], [115, 2, 1, "", "trace_attributes"], [115, 2, 1, "", "train_compare"], [115, 2, 1, "", "training_callback"], [115, 2, 1, "", "transients_attributes"], [115, 2, 1, "", "validate_class"], [115, 2, 1, "", "warning"]], "engforge.eng.geometry.Profile2D": [[117, 3, 1, "", "Ao"], [117, 2, 1, "", "add_fields"], [117, 2, 1, "", "add_prediction_record"], [117, 3, 1, "", "as_dict"], [117, 2, 1, "", "check_and_retrain"], [117, 2, 1, "", "check_out_of_domain"], [117, 2, 1, "", "check_ref_slot_type"], [117, 3, 1, "", "classname"], [117, 2, 1, "", "cls_compile"], [117, 2, 1, "", "collect_all_attributes"], [117, 2, 1, "", "collect_inst_attributes"], [117, 2, 1, "", "compile_classes"], [117, 2, 1, "", "copy_config_at_state"], [117, 2, 1, "", "critical"], [117, 2, 1, "", "debug"], [117, 2, 1, "", "difference"], [117, 2, 1, "", "error"], [117, 3, 1, "", "filename"], [117, 2, 1, "", "filter"], [117, 2, 1, "", "go_through_configurations"], [117, 3, 1, "", "identity"], [117, 2, 1, "", "info"], [117, 3, 1, "", "input_as_dict"], [117, 2, 1, "", "input_fields"], [117, 2, 1, "", "installSTDLogger"], [117, 2, 1, "", "internal_configurations"], [117, 2, 1, "", "message_with_identiy"], [117, 2, 1, "", "msg"], [117, 2, 1, "", "observe_and_predict"], [117, 2, 1, "", "parent_configurations_cls"], [117, 2, 1, "", "plot_attributes"], [117, 2, 1, "", "pre_compile"], [117, 2, 1, "", "resetLog"], [117, 2, 1, "", "resetSystemLogs"], [117, 2, 1, "", "score_data"], [117, 2, 1, "", "setattrs"], [117, 2, 1, "", "signals_attributes"], [117, 2, 1, "", "slot_refs"], [117, 2, 1, "", "slots_attributes"], [117, 2, 1, "", "solvers_attributes"], [117, 2, 1, "", "subclasses"], [117, 2, 1, "", "subcls_compile"], [117, 2, 1, "", "trace_attributes"], [117, 2, 1, "", "train_compare"], [117, 2, 1, "", "training_callback"], [117, 2, 1, "", "transients_attributes"], [117, 2, 1, "", "validate_class"], [117, 2, 1, "", "warning"]], "engforge.eng.geometry.Rectangle": [[118, 3, 1, "", "Ao"], [118, 2, 1, "", "add_fields"], [118, 2, 1, "", "add_prediction_record"], [118, 3, 1, "", "as_dict"], [118, 2, 1, "", "check_and_retrain"], [118, 2, 1, "", "check_out_of_domain"], [118, 2, 1, "", "check_ref_slot_type"], [118, 3, 1, "", "classname"], [118, 2, 1, "", "cls_compile"], [118, 2, 1, "", "collect_all_attributes"], [118, 2, 1, "", "collect_inst_attributes"], [118, 2, 1, "", "compile_classes"], [118, 2, 1, "", "copy_config_at_state"], [118, 2, 1, "", "critical"], [118, 2, 1, "", "debug"], [118, 2, 1, "", "difference"], [118, 2, 1, "", "error"], [118, 3, 1, "", "filename"], [118, 2, 1, "", "filter"], [118, 2, 1, "", "go_through_configurations"], [118, 3, 1, "", "identity"], [118, 2, 1, "", "info"], [118, 3, 1, "", "input_as_dict"], [118, 2, 1, "", "input_fields"], [118, 2, 1, "", "installSTDLogger"], [118, 2, 1, "", "internal_configurations"], [118, 2, 1, "", "message_with_identiy"], [118, 2, 1, "", "msg"], [118, 2, 1, "", "observe_and_predict"], [118, 2, 1, "", "parent_configurations_cls"], [118, 2, 1, "", "plot_attributes"], [118, 2, 1, "", "pre_compile"], [118, 2, 1, "", "resetLog"], [118, 2, 1, "", "resetSystemLogs"], [118, 2, 1, "", "score_data"], [118, 2, 1, "", "setattrs"], [118, 2, 1, "", "signals_attributes"], [118, 2, 1, "", "slot_refs"], [118, 2, 1, "", "slots_attributes"], [118, 2, 1, "", "solvers_attributes"], [118, 2, 1, "", "subclasses"], [118, 2, 1, "", "subcls_compile"], [118, 2, 1, "", "trace_attributes"], [118, 2, 1, "", "train_compare"], [118, 2, 1, "", "training_callback"], [118, 2, 1, "", "transients_attributes"], [118, 2, 1, "", "validate_class"], [118, 2, 1, "", "warning"]], "engforge.eng.geometry.ShapelySection": [[119, 3, 1, "", "Ao"], [119, 2, 1, "", "add_fields"], [119, 2, 1, "", "add_prediction_record"], [119, 3, 1, "", "as_dict"], [119, 2, 1, "", "basis_expand"], [119, 2, 1, "", "check_and_retrain"], [119, 2, 1, "", "check_out_of_domain"], [119, 2, 1, "", "check_ref_slot_type"], [119, 2, 1, "", "check_symmetric"], [119, 3, 1, "", "classname"], [119, 2, 1, "", "cls_compile"], [119, 2, 1, "", "collect_all_attributes"], [119, 2, 1, "", "collect_inst_attributes"], [119, 2, 1, "", "compile_classes"], [119, 2, 1, "", "copy_config_at_state"], [119, 2, 1, "", "critical"], [119, 2, 1, "", "debug"], [119, 2, 1, "", "determine_failure_stress"], [119, 2, 1, "", "difference"], [119, 2, 1, "", "error"], [119, 2, 1, "", "estimate_failure"], [119, 2, 1, "", "estimate_stress"], [119, 2, 1, "", "fail_learning"], [119, 3, 1, "", "filename"], [119, 2, 1, "", "filter"], [119, 2, 1, "", "go_through_configurations"], [119, 2, 1, "", "hash_id"], [119, 3, 1, "", "identity"], [119, 2, 1, "", "info"], [119, 3, 1, "", "input_as_dict"], [119, 2, 1, "", "input_fields"], [119, 2, 1, "", "installSTDLogger"], [119, 2, 1, "", "internal_configurations"], [119, 2, 1, "", "mesh_section"], [119, 2, 1, "", "message_with_identiy"], [119, 2, 1, "", "msg"], [119, 2, 1, "", "observe_and_predict"], [119, 2, 1, "", "parent_configurations_cls"], [119, 2, 1, "", "plot_attributes"], [119, 2, 1, "", "pre_compile"], [119, 2, 1, "", "record_stress"], [119, 2, 1, "", "resetLog"], [119, 2, 1, "", "resetSystemLogs"], [119, 2, 1, "", "score_data"], [119, 2, 1, "", "setattrs"], [119, 2, 1, "", "signals_attributes"], [119, 2, 1, "", "slot_refs"], [119, 2, 1, "", "slots_attributes"], [119, 2, 1, "", "solvers_attributes"], [119, 2, 1, "", "subclasses"], [119, 2, 1, "", "subcls_compile"], [119, 2, 1, "", "trace_attributes"], [119, 2, 1, "", "train_compare"], [119, 2, 1, "", "train_until_valid"], [119, 2, 1, "", "training_callback"], [119, 2, 1, "", "transients_attributes"], [119, 2, 1, "", "validate_class"], [119, 2, 1, "", "warning"]], "engforge.eng.geometry.Triangle": [[120, 3, 1, "", "Ao"], [120, 2, 1, "", "add_fields"], [120, 2, 1, "", "add_prediction_record"], [120, 3, 1, "", "as_dict"], [120, 2, 1, "", "check_and_retrain"], [120, 2, 1, "", "check_out_of_domain"], [120, 2, 1, "", "check_ref_slot_type"], [120, 3, 1, "", "classname"], [120, 2, 1, "", "cls_compile"], [120, 2, 1, "", "collect_all_attributes"], [120, 2, 1, "", "collect_inst_attributes"], [120, 2, 1, "", "compile_classes"], [120, 2, 1, "", "copy_config_at_state"], [120, 2, 1, "", "critical"], [120, 2, 1, "", "debug"], [120, 2, 1, "", "difference"], [120, 2, 1, "", "error"], [120, 3, 1, "", "filename"], [120, 2, 1, "", "filter"], [120, 2, 1, "", "go_through_configurations"], [120, 3, 1, "", "identity"], [120, 2, 1, "", "info"], [120, 3, 1, "", "input_as_dict"], [120, 2, 1, "", "input_fields"], [120, 2, 1, "", "installSTDLogger"], [120, 2, 1, "", "internal_configurations"], [120, 2, 1, "", "message_with_identiy"], [120, 2, 1, "", "msg"], [120, 2, 1, "", "observe_and_predict"], [120, 2, 1, "", "parent_configurations_cls"], [120, 2, 1, "", "plot_attributes"], [120, 2, 1, "", "pre_compile"], [120, 2, 1, "", "resetLog"], [120, 2, 1, "", "resetSystemLogs"], [120, 2, 1, "", "score_data"], [120, 2, 1, "", "setattrs"], [120, 2, 1, "", "signals_attributes"], [120, 2, 1, "", "slot_refs"], [120, 2, 1, "", "slots_attributes"], [120, 2, 1, "", "solvers_attributes"], [120, 2, 1, "", "subclasses"], [120, 2, 1, "", "subcls_compile"], [120, 2, 1, "", "trace_attributes"], [120, 2, 1, "", "train_compare"], [120, 2, 1, "", "training_callback"], [120, 2, 1, "", "transients_attributes"], [120, 2, 1, "", "validate_class"], [120, 2, 1, "", "warning"]], "engforge.eng.pipes": [[125, 1, 1, "", "FlowInput"], [126, 1, 1, "", "FlowNode"], [127, 1, 1, "", "Pipe"], [128, 1, 1, "", "PipeFitting"], [129, 1, 1, "", "PipeFlow"], [130, 1, 1, "", "PipeLog"], [131, 1, 1, "", "PipeNode"], [132, 1, 1, "", "PipeSystem"], [133, 1, 1, "", "Pump"]], "engforge.eng.pipes.FlowInput": [[125, 3, 1, "", "Ut_ref"], [125, 3, 1, "", "Xt_ref"], [125, 3, 1, "", "Yt_ref"], [125, 2, 1, "", "add_fields"], [125, 3, 1, "", "anything_changed"], [125, 3, 1, "", "as_dict"], [125, 2, 1, "", "check_ref_slot_type"], [125, 3, 1, "", "classname"], [125, 2, 1, "", "cls_compile"], [125, 2, 1, "", "collect_all_attributes"], [125, 2, 1, "", "collect_comp_refs"], [125, 2, 1, "", "collect_dynamic_refs"], [125, 2, 1, "", "collect_inst_attributes"], [125, 2, 1, "", "collect_post_update_refs"], [125, 2, 1, "", "collect_solver_refs"], [125, 2, 1, "", "collect_update_refs"], [125, 2, 1, "", "comp_references"], [125, 2, 1, "", "compile_classes"], [125, 2, 1, "", "copy_config_at_state"], [125, 2, 1, "", "create_dynamic_matricies"], [125, 2, 1, "", "create_feedthrough_matrix"], [125, 2, 1, "", "create_input_matrix"], [125, 2, 1, "", "create_output_constants"], [125, 2, 1, "", "create_output_matrix"], [125, 2, 1, "", "create_state_constants"], [125, 2, 1, "", "create_state_matrix"], [125, 2, 1, "", "critical"], [125, 3, 1, "", "dXtdt_ref"], [125, 3, 1, "", "data_dict"], [125, 2, 1, "", "debug"], [125, 2, 1, "", "determine_nearest_stationary_state"], [125, 2, 1, "", "difference"], [125, 2, 1, "", "error"], [125, 3, 1, "", "filename"], [125, 2, 1, "", "filter"], [125, 2, 1, "", "get_system_input_refs"], [125, 2, 1, "", "go_through_configurations"], [125, 3, 1, "", "identity"], [125, 2, 1, "", "info"], [125, 3, 1, "", "input_as_dict"], [125, 2, 1, "", "input_fields"], [125, 2, 1, "", "installSTDLogger"], [125, 2, 1, "", "internal_components"], [125, 2, 1, "", "internal_configurations"], [125, 2, 1, "", "internal_references"], [125, 2, 1, "", "internal_systems"], [125, 2, 1, "", "internal_tabulations"], [125, 3, 1, "", "last_context"], [125, 2, 1, "", "linear_output"], [125, 2, 1, "", "linear_step"], [125, 2, 1, "", "locate"], [125, 2, 1, "", "locate_ref"], [125, 2, 1, "", "message_with_identiy"], [125, 2, 1, "", "msg"], [125, 2, 1, "", "nonlinear_output"], [125, 2, 1, "", "nonlinear_step"], [125, 2, 1, "", "parent_configurations_cls"], [125, 2, 1, "", "parse_run_kwargs"], [125, 2, 1, "", "parse_simulation_input"], [125, 2, 1, "", "plot_attributes"], [125, 3, 1, "", "plotable_variables"], [125, 2, 1, "", "post_update"], [125, 2, 1, "", "pre_compile"], [125, 2, 1, "", "rate"], [125, 2, 1, "", "rate_linear"], [125, 2, 1, "", "rate_nonlinear"], [125, 2, 1, "", "ref_dXdt"], [125, 2, 1, "", "resetLog"], [125, 2, 1, "", "resetSystemLogs"], [125, 2, 1, "", "set_time"], [125, 2, 1, "", "setattrs"], [125, 2, 1, "", "signals_attributes"], [125, 3, 1, "", "skip_plot_vars"], [125, 2, 1, "", "slot_refs"], [125, 2, 1, "", "slots_attributes"], [125, 2, 1, "", "smart_split_dataframe"], [125, 2, 1, "", "solvers_attributes"], [125, 2, 1, "", "subclasses"], [125, 2, 1, "", "subcls_compile"], [125, 3, 1, "", "system_id"], [125, 2, 1, "", "system_properties_classdef"], [125, 2, 1, "", "system_references"], [125, 2, 1, "", "trace_attributes"], [125, 2, 1, "", "transients_attributes"], [125, 2, 1, "", "update"], [125, 2, 1, "", "update_dynamics"], [125, 2, 1, "", "update_feedthrough"], [125, 2, 1, "", "update_input"], [125, 2, 1, "", "update_output_constants"], [125, 2, 1, "", "update_output_matrix"], [125, 2, 1, "", "update_state"], [125, 2, 1, "", "update_state_constants"], [125, 2, 1, "", "validate_class"], [125, 2, 1, "", "warning"]], "engforge.eng.pipes.FlowNode": [[126, 3, 1, "", "Ut_ref"], [126, 3, 1, "", "Xt_ref"], [126, 3, 1, "", "Yt_ref"], [126, 2, 1, "", "add_fields"], [126, 3, 1, "", "anything_changed"], [126, 3, 1, "", "as_dict"], [126, 2, 1, "", "check_ref_slot_type"], [126, 3, 1, "", "classname"], [126, 2, 1, "", "cls_compile"], [126, 2, 1, "", "collect_all_attributes"], [126, 2, 1, "", "collect_comp_refs"], [126, 2, 1, "", "collect_dynamic_refs"], [126, 2, 1, "", "collect_inst_attributes"], [126, 2, 1, "", "collect_post_update_refs"], [126, 2, 1, "", "collect_solver_refs"], [126, 2, 1, "", "collect_update_refs"], [126, 2, 1, "", "comp_references"], [126, 2, 1, "", "compile_classes"], [126, 2, 1, "", "copy_config_at_state"], [126, 2, 1, "", "create_dynamic_matricies"], [126, 2, 1, "", "create_feedthrough_matrix"], [126, 2, 1, "", "create_input_matrix"], [126, 2, 1, "", "create_output_constants"], [126, 2, 1, "", "create_output_matrix"], [126, 2, 1, "", "create_state_constants"], [126, 2, 1, "", "create_state_matrix"], [126, 2, 1, "", "critical"], [126, 3, 1, "", "dXtdt_ref"], [126, 3, 1, "", "data_dict"], [126, 2, 1, "", "debug"], [126, 2, 1, "", "determine_nearest_stationary_state"], [126, 2, 1, "", "difference"], [126, 2, 1, "", "error"], [126, 3, 1, "", "filename"], [126, 2, 1, "", "filter"], [126, 2, 1, "", "get_system_input_refs"], [126, 2, 1, "", "go_through_configurations"], [126, 3, 1, "", "identity"], [126, 2, 1, "", "info"], [126, 3, 1, "", "input_as_dict"], [126, 2, 1, "", "input_fields"], [126, 2, 1, "", "installSTDLogger"], [126, 2, 1, "", "internal_components"], [126, 2, 1, "", "internal_configurations"], [126, 2, 1, "", "internal_references"], [126, 2, 1, "", "internal_systems"], [126, 2, 1, "", "internal_tabulations"], [126, 3, 1, "", "last_context"], [126, 2, 1, "", "linear_output"], [126, 2, 1, "", "linear_step"], [126, 2, 1, "", "locate"], [126, 2, 1, "", "locate_ref"], [126, 2, 1, "", "message_with_identiy"], [126, 2, 1, "", "msg"], [126, 2, 1, "", "nonlinear_output"], [126, 2, 1, "", "nonlinear_step"], [126, 2, 1, "", "parent_configurations_cls"], [126, 2, 1, "", "parse_run_kwargs"], [126, 2, 1, "", "parse_simulation_input"], [126, 2, 1, "", "plot_attributes"], [126, 3, 1, "", "plotable_variables"], [126, 2, 1, "", "post_update"], [126, 2, 1, "", "pre_compile"], [126, 2, 1, "", "rate"], [126, 2, 1, "", "rate_linear"], [126, 2, 1, "", "rate_nonlinear"], [126, 2, 1, "", "ref_dXdt"], [126, 2, 1, "", "resetLog"], [126, 2, 1, "", "resetSystemLogs"], [126, 2, 1, "", "set_time"], [126, 2, 1, "", "setattrs"], [126, 2, 1, "", "signals_attributes"], [126, 3, 1, "", "skip_plot_vars"], [126, 2, 1, "", "slot_refs"], [126, 2, 1, "", "slots_attributes"], [126, 2, 1, "", "smart_split_dataframe"], [126, 2, 1, "", "solvers_attributes"], [126, 2, 1, "", "subclasses"], [126, 2, 1, "", "subcls_compile"], [126, 3, 1, "", "system_id"], [126, 2, 1, "", "system_properties_classdef"], [126, 2, 1, "", "system_references"], [126, 2, 1, "", "trace_attributes"], [126, 2, 1, "", "transients_attributes"], [126, 2, 1, "", "update"], [126, 2, 1, "", "update_dynamics"], [126, 2, 1, "", "update_feedthrough"], [126, 2, 1, "", "update_input"], [126, 2, 1, "", "update_output_constants"], [126, 2, 1, "", "update_output_matrix"], [126, 2, 1, "", "update_state"], [126, 2, 1, "", "update_state_constants"], [126, 2, 1, "", "validate_class"], [126, 2, 1, "", "warning"]], "engforge.eng.pipes.Pipe": [[127, 3, 1, "", "Fvec"], [127, 3, 1, "", "Ut_ref"], [127, 3, 1, "", "Xt_ref"], [127, 3, 1, "", "Yt_ref"], [127, 2, 1, "", "add_fields"], [127, 3, 1, "", "anything_changed"], [127, 3, 1, "", "as_dict"], [127, 2, 1, "", "check_ref_slot_type"], [127, 3, 1, "", "classname"], [127, 2, 1, "", "cls_compile"], [127, 2, 1, "", "collect_all_attributes"], [127, 2, 1, "", "collect_comp_refs"], [127, 2, 1, "", "collect_dynamic_refs"], [127, 2, 1, "", "collect_inst_attributes"], [127, 2, 1, "", "collect_post_update_refs"], [127, 2, 1, "", "collect_solver_refs"], [127, 2, 1, "", "collect_update_refs"], [127, 2, 1, "", "comp_references"], [127, 2, 1, "", "compile_classes"], [127, 2, 1, "", "copy_config_at_state"], [127, 2, 1, "", "create_dynamic_matricies"], [127, 2, 1, "", "create_feedthrough_matrix"], [127, 2, 1, "", "create_input_matrix"], [127, 2, 1, "", "create_output_constants"], [127, 2, 1, "", "create_output_matrix"], [127, 2, 1, "", "create_state_constants"], [127, 2, 1, "", "create_state_matrix"], [127, 2, 1, "", "critical"], [127, 3, 1, "", "dXtdt_ref"], [127, 3, 1, "", "data_dict"], [127, 2, 1, "", "debug"], [127, 2, 1, "", "determine_nearest_stationary_state"], [127, 2, 1, "", "difference"], [127, 2, 1, "", "error"], [127, 3, 1, "", "filename"], [127, 2, 1, "", "filter"], [127, 2, 1, "", "get_system_input_refs"], [127, 2, 1, "", "go_through_configurations"], [127, 3, 1, "", "identity"], [127, 2, 1, "", "info"], [127, 3, 1, "", "input_as_dict"], [127, 2, 1, "", "input_fields"], [127, 2, 1, "", "installSTDLogger"], [127, 2, 1, "", "internal_components"], [127, 2, 1, "", "internal_configurations"], [127, 2, 1, "", "internal_references"], [127, 2, 1, "", "internal_systems"], [127, 2, 1, "", "internal_tabulations"], [127, 3, 1, "", "last_context"], [127, 2, 1, "", "linear_output"], [127, 2, 1, "", "linear_step"], [127, 2, 1, "", "locate"], [127, 2, 1, "", "locate_ref"], [127, 2, 1, "", "message_with_identiy"], [127, 2, 1, "", "msg"], [127, 2, 1, "", "nonlinear_output"], [127, 2, 1, "", "nonlinear_step"], [127, 2, 1, "", "parent_configurations_cls"], [127, 2, 1, "", "parse_run_kwargs"], [127, 2, 1, "", "parse_simulation_input"], [127, 2, 1, "", "plot_attributes"], [127, 3, 1, "", "plotable_variables"], [127, 2, 1, "", "post_update"], [127, 2, 1, "", "pre_compile"], [127, 2, 1, "", "rate"], [127, 2, 1, "", "rate_linear"], [127, 2, 1, "", "rate_nonlinear"], [127, 2, 1, "", "ref_dXdt"], [127, 2, 1, "", "resetLog"], [127, 2, 1, "", "resetSystemLogs"], [127, 2, 1, "", "set_time"], [127, 2, 1, "", "setattrs"], [127, 2, 1, "", "signals_attributes"], [127, 3, 1, "", "skip_plot_vars"], [127, 2, 1, "", "slot_refs"], [127, 2, 1, "", "slots_attributes"], [127, 2, 1, "", "smart_split_dataframe"], [127, 2, 1, "", "solvers_attributes"], [127, 2, 1, "", "subclasses"], [127, 2, 1, "", "subcls_compile"], [127, 3, 1, "", "system_id"], [127, 2, 1, "", "system_properties_classdef"], [127, 2, 1, "", "system_references"], [127, 2, 1, "", "trace_attributes"], [127, 2, 1, "", "transients_attributes"], [127, 2, 1, "", "update"], [127, 2, 1, "", "update_dynamics"], [127, 2, 1, "", "update_feedthrough"], [127, 2, 1, "", "update_input"], [127, 2, 1, "", "update_output_constants"], [127, 2, 1, "", "update_output_matrix"], [127, 2, 1, "", "update_state"], [127, 2, 1, "", "update_state_constants"], [127, 2, 1, "", "validate_class"], [127, 2, 1, "", "warning"]], "engforge.eng.pipes.PipeFitting": [[128, 3, 1, "", "Fvec"], [128, 3, 1, "", "Ut_ref"], [128, 3, 1, "", "Xt_ref"], [128, 3, 1, "", "Yt_ref"], [128, 2, 1, "", "add_fields"], [128, 3, 1, "", "anything_changed"], [128, 3, 1, "", "as_dict"], [128, 2, 1, "", "check_ref_slot_type"], [128, 3, 1, "", "classname"], [128, 2, 1, "", "cls_compile"], [128, 2, 1, "", "collect_all_attributes"], [128, 2, 1, "", "collect_comp_refs"], [128, 2, 1, "", "collect_dynamic_refs"], [128, 2, 1, "", "collect_inst_attributes"], [128, 2, 1, "", "collect_post_update_refs"], [128, 2, 1, "", "collect_solver_refs"], [128, 2, 1, "", "collect_update_refs"], [128, 2, 1, "", "comp_references"], [128, 2, 1, "", "compile_classes"], [128, 2, 1, "", "copy_config_at_state"], [128, 2, 1, "", "create_dynamic_matricies"], [128, 2, 1, "", "create_feedthrough_matrix"], [128, 2, 1, "", "create_input_matrix"], [128, 2, 1, "", "create_output_constants"], [128, 2, 1, "", "create_output_matrix"], [128, 2, 1, "", "create_state_constants"], [128, 2, 1, "", "create_state_matrix"], [128, 2, 1, "", "critical"], [128, 3, 1, "", "dXtdt_ref"], [128, 3, 1, "", "data_dict"], [128, 2, 1, "", "debug"], [128, 2, 1, "", "determine_nearest_stationary_state"], [128, 2, 1, "", "difference"], [128, 2, 1, "", "error"], [128, 3, 1, "", "filename"], [128, 2, 1, "", "filter"], [128, 2, 1, "", "get_system_input_refs"], [128, 2, 1, "", "go_through_configurations"], [128, 3, 1, "", "identity"], [128, 2, 1, "", "info"], [128, 3, 1, "", "input_as_dict"], [128, 2, 1, "", "input_fields"], [128, 2, 1, "", "installSTDLogger"], [128, 2, 1, "", "internal_components"], [128, 2, 1, "", "internal_configurations"], [128, 2, 1, "", "internal_references"], [128, 2, 1, "", "internal_systems"], [128, 2, 1, "", "internal_tabulations"], [128, 3, 1, "", "last_context"], [128, 2, 1, "", "linear_output"], [128, 2, 1, "", "linear_step"], [128, 2, 1, "", "locate"], [128, 2, 1, "", "locate_ref"], [128, 2, 1, "", "message_with_identiy"], [128, 2, 1, "", "msg"], [128, 2, 1, "", "nonlinear_output"], [128, 2, 1, "", "nonlinear_step"], [128, 2, 1, "", "parent_configurations_cls"], [128, 2, 1, "", "parse_run_kwargs"], [128, 2, 1, "", "parse_simulation_input"], [128, 2, 1, "", "plot_attributes"], [128, 3, 1, "", "plotable_variables"], [128, 2, 1, "", "post_update"], [128, 2, 1, "", "pre_compile"], [128, 2, 1, "", "rate"], [128, 2, 1, "", "rate_linear"], [128, 2, 1, "", "rate_nonlinear"], [128, 2, 1, "", "ref_dXdt"], [128, 2, 1, "", "resetLog"], [128, 2, 1, "", "resetSystemLogs"], [128, 2, 1, "", "set_time"], [128, 2, 1, "", "setattrs"], [128, 2, 1, "", "signals_attributes"], [128, 3, 1, "", "skip_plot_vars"], [128, 2, 1, "", "slot_refs"], [128, 2, 1, "", "slots_attributes"], [128, 2, 1, "", "smart_split_dataframe"], [128, 2, 1, "", "solvers_attributes"], [128, 2, 1, "", "subclasses"], [128, 2, 1, "", "subcls_compile"], [128, 3, 1, "", "system_id"], [128, 2, 1, "", "system_properties_classdef"], [128, 2, 1, "", "system_references"], [128, 2, 1, "", "trace_attributes"], [128, 2, 1, "", "transients_attributes"], [128, 2, 1, "", "update"], [128, 2, 1, "", "update_dynamics"], [128, 2, 1, "", "update_feedthrough"], [128, 2, 1, "", "update_input"], [128, 2, 1, "", "update_output_constants"], [128, 2, 1, "", "update_output_matrix"], [128, 2, 1, "", "update_state"], [128, 2, 1, "", "update_state_constants"], [128, 2, 1, "", "validate_class"], [128, 2, 1, "", "warning"]], "engforge.eng.pipes.PipeFlow": [[129, 3, 1, "", "Fvec"], [129, 3, 1, "", "Ut_ref"], [129, 3, 1, "", "Xt_ref"], [129, 3, 1, "", "Yt_ref"], [129, 2, 1, "", "add_fields"], [129, 3, 1, "", "anything_changed"], [129, 3, 1, "", "as_dict"], [129, 2, 1, "", "check_ref_slot_type"], [129, 3, 1, "", "classname"], [129, 2, 1, "", "cls_compile"], [129, 2, 1, "", "collect_all_attributes"], [129, 2, 1, "", "collect_comp_refs"], [129, 2, 1, "", "collect_dynamic_refs"], [129, 2, 1, "", "collect_inst_attributes"], [129, 2, 1, "", "collect_post_update_refs"], [129, 2, 1, "", "collect_solver_refs"], [129, 2, 1, "", "collect_update_refs"], [129, 2, 1, "", "comp_references"], [129, 2, 1, "", "compile_classes"], [129, 2, 1, "", "copy_config_at_state"], [129, 2, 1, "", "create_dynamic_matricies"], [129, 2, 1, "", "create_feedthrough_matrix"], [129, 2, 1, "", "create_input_matrix"], [129, 2, 1, "", "create_output_constants"], [129, 2, 1, "", "create_output_matrix"], [129, 2, 1, "", "create_state_constants"], [129, 2, 1, "", "create_state_matrix"], [129, 2, 1, "", "critical"], [129, 3, 1, "", "dP_f"], [129, 3, 1, "", "dP_p"], [129, 3, 1, "", "dXtdt_ref"], [129, 3, 1, "", "data_dict"], [129, 2, 1, "", "debug"], [129, 2, 1, "", "determine_nearest_stationary_state"], [129, 2, 1, "", "difference"], [129, 2, 1, "", "error"], [129, 3, 1, "", "filename"], [129, 2, 1, "", "filter"], [129, 2, 1, "", "get_system_input_refs"], [129, 2, 1, "", "go_through_configurations"], [129, 3, 1, "", "identity"], [129, 2, 1, "", "info"], [129, 3, 1, "", "input_as_dict"], [129, 2, 1, "", "input_fields"], [129, 2, 1, "", "installSTDLogger"], [129, 2, 1, "", "internal_components"], [129, 2, 1, "", "internal_configurations"], [129, 2, 1, "", "internal_references"], [129, 2, 1, "", "internal_systems"], [129, 2, 1, "", "internal_tabulations"], [129, 3, 1, "", "last_context"], [129, 2, 1, "", "linear_output"], [129, 2, 1, "", "linear_step"], [129, 2, 1, "", "locate"], [129, 2, 1, "", "locate_ref"], [129, 2, 1, "", "message_with_identiy"], [129, 2, 1, "", "msg"], [129, 2, 1, "", "nonlinear_output"], [129, 2, 1, "", "nonlinear_step"], [129, 2, 1, "", "parent_configurations_cls"], [129, 2, 1, "", "parse_run_kwargs"], [129, 2, 1, "", "parse_simulation_input"], [129, 2, 1, "", "plot_attributes"], [129, 3, 1, "", "plotable_variables"], [129, 2, 1, "", "post_update"], [129, 2, 1, "", "pre_compile"], [129, 2, 1, "", "rate"], [129, 2, 1, "", "rate_linear"], [129, 2, 1, "", "rate_nonlinear"], [129, 2, 1, "", "ref_dXdt"], [129, 2, 1, "", "resetLog"], [129, 2, 1, "", "resetSystemLogs"], [129, 2, 1, "", "set_time"], [129, 2, 1, "", "setattrs"], [129, 2, 1, "", "signals_attributes"], [129, 3, 1, "", "skip_plot_vars"], [129, 2, 1, "", "slot_refs"], [129, 2, 1, "", "slots_attributes"], [129, 2, 1, "", "smart_split_dataframe"], [129, 2, 1, "", "solvers_attributes"], [129, 2, 1, "", "subclasses"], [129, 2, 1, "", "subcls_compile"], [129, 3, 1, "", "system_id"], [129, 2, 1, "", "system_properties_classdef"], [129, 2, 1, "", "system_references"], [129, 2, 1, "", "trace_attributes"], [129, 2, 1, "", "transients_attributes"], [129, 2, 1, "", "update"], [129, 2, 1, "", "update_dynamics"], [129, 2, 1, "", "update_feedthrough"], [129, 2, 1, "", "update_input"], [129, 2, 1, "", "update_output_constants"], [129, 2, 1, "", "update_output_matrix"], [129, 2, 1, "", "update_state"], [129, 2, 1, "", "update_state_constants"], [129, 2, 1, "", "validate_class"], [129, 2, 1, "", "warning"]], "engforge.eng.pipes.PipeLog": [[130, 2, 1, "", "add_fields"], [130, 2, 1, "", "critical"], [130, 2, 1, "", "debug"], [130, 2, 1, "", "error"], [130, 2, 1, "", "filter"], [130, 2, 1, "", "info"], [130, 2, 1, "", "installSTDLogger"], [130, 2, 1, "", "message_with_identiy"], [130, 2, 1, "", "msg"], [130, 2, 1, "", "resetLog"], [130, 2, 1, "", "resetSystemLogs"], [130, 2, 1, "", "warning"]], "engforge.eng.pipes.PipeNode": [[131, 3, 1, "", "Ut_ref"], [131, 3, 1, "", "Xt_ref"], [131, 3, 1, "", "Yt_ref"], [131, 2, 1, "", "add_fields"], [131, 3, 1, "", "anything_changed"], [131, 3, 1, "", "as_dict"], [131, 2, 1, "", "check_ref_slot_type"], [131, 3, 1, "", "classname"], [131, 2, 1, "", "cls_compile"], [131, 2, 1, "", "collect_all_attributes"], [131, 2, 1, "", "collect_comp_refs"], [131, 2, 1, "", "collect_dynamic_refs"], [131, 2, 1, "", "collect_inst_attributes"], [131, 2, 1, "", "collect_post_update_refs"], [131, 2, 1, "", "collect_solver_refs"], [131, 2, 1, "", "collect_update_refs"], [131, 2, 1, "", "comp_references"], [131, 2, 1, "", "compile_classes"], [131, 2, 1, "", "copy_config_at_state"], [131, 2, 1, "", "create_dynamic_matricies"], [131, 2, 1, "", "create_feedthrough_matrix"], [131, 2, 1, "", "create_input_matrix"], [131, 2, 1, "", "create_output_constants"], [131, 2, 1, "", "create_output_matrix"], [131, 2, 1, "", "create_state_constants"], [131, 2, 1, "", "create_state_matrix"], [131, 2, 1, "", "critical"], [131, 3, 1, "", "dXtdt_ref"], [131, 3, 1, "", "data_dict"], [131, 2, 1, "", "debug"], [131, 2, 1, "", "determine_nearest_stationary_state"], [131, 2, 1, "", "difference"], [131, 2, 1, "", "error"], [131, 3, 1, "", "filename"], [131, 2, 1, "", "filter"], [131, 2, 1, "", "get_system_input_refs"], [131, 2, 1, "", "go_through_configurations"], [131, 3, 1, "", "identity"], [131, 2, 1, "", "info"], [131, 3, 1, "", "input_as_dict"], [131, 2, 1, "", "input_fields"], [131, 2, 1, "", "installSTDLogger"], [131, 2, 1, "", "internal_components"], [131, 2, 1, "", "internal_configurations"], [131, 2, 1, "", "internal_references"], [131, 2, 1, "", "internal_systems"], [131, 2, 1, "", "internal_tabulations"], [131, 3, 1, "", "last_context"], [131, 2, 1, "", "linear_output"], [131, 2, 1, "", "linear_step"], [131, 2, 1, "", "locate"], [131, 2, 1, "", "locate_ref"], [131, 2, 1, "", "message_with_identiy"], [131, 2, 1, "", "msg"], [131, 2, 1, "", "nonlinear_output"], [131, 2, 1, "", "nonlinear_step"], [131, 2, 1, "", "parent_configurations_cls"], [131, 2, 1, "", "parse_run_kwargs"], [131, 2, 1, "", "parse_simulation_input"], [131, 2, 1, "", "plot_attributes"], [131, 3, 1, "", "plotable_variables"], [131, 2, 1, "", "post_update"], [131, 2, 1, "", "pre_compile"], [131, 2, 1, "", "rate"], [131, 2, 1, "", "rate_linear"], [131, 2, 1, "", "rate_nonlinear"], [131, 2, 1, "", "ref_dXdt"], [131, 2, 1, "", "resetLog"], [131, 2, 1, "", "resetSystemLogs"], [131, 2, 1, "", "set_time"], [131, 2, 1, "", "setattrs"], [131, 2, 1, "", "signals_attributes"], [131, 3, 1, "", "skip_plot_vars"], [131, 2, 1, "", "slot_refs"], [131, 2, 1, "", "slots_attributes"], [131, 2, 1, "", "smart_split_dataframe"], [131, 2, 1, "", "solvers_attributes"], [131, 2, 1, "", "subclasses"], [131, 2, 1, "", "subcls_compile"], [131, 3, 1, "", "system_id"], [131, 2, 1, "", "system_properties_classdef"], [131, 2, 1, "", "system_references"], [131, 2, 1, "", "trace_attributes"], [131, 2, 1, "", "transients_attributes"], [131, 2, 1, "", "update"], [131, 2, 1, "", "update_dynamics"], [131, 2, 1, "", "update_feedthrough"], [131, 2, 1, "", "update_input"], [131, 2, 1, "", "update_output_constants"], [131, 2, 1, "", "update_output_matrix"], [131, 2, 1, "", "update_state"], [131, 2, 1, "", "update_state_constants"], [131, 2, 1, "", "validate_class"], [131, 2, 1, "", "warning"]], "engforge.eng.pipes.PipeSystem": [[132, 3, 1, "", "Ut_ref"], [132, 3, 1, "", "Xt_ref"], [132, 3, 1, "", "Yt_ref"], [132, 2, 1, "", "add_fields"], [132, 2, 1, "", "add_to_graph"], [132, 3, 1, "", "anything_changed"], [132, 3, 1, "", "as_dict"], [132, 2, 1, "", "check_ref_slot_type"], [132, 3, 1, "", "classname"], [132, 2, 1, "", "clone"], [132, 2, 1, "", "cls_compile"], [132, 2, 1, "", "collect_all_attributes"], [132, 2, 1, "", "collect_comp_refs"], [132, 2, 1, "", "collect_dynamic_refs"], [132, 2, 1, "", "collect_inst_attributes"], [132, 2, 1, "", "collect_post_update_refs"], [132, 2, 1, "", "collect_solver_refs"], [132, 2, 1, "", "collect_update_refs"], [132, 2, 1, "", "comp_references"], [132, 2, 1, "", "compile_classes"], [132, 2, 1, "", "copy_config_at_state"], [132, 2, 1, "", "create_dynamic_matricies"], [132, 2, 1, "", "create_feedthrough_matrix"], [132, 2, 1, "", "create_graph_from_pipe_or_node"], [132, 2, 1, "", "create_input_matrix"], [132, 2, 1, "", "create_output_constants"], [132, 2, 1, "", "create_output_matrix"], [132, 2, 1, "", "create_state_constants"], [132, 2, 1, "", "create_state_matrix"], [132, 2, 1, "", "critical"], [132, 3, 1, "", "dXtdt_ref"], [132, 2, 1, "", "debug"], [132, 2, 1, "", "determine_nearest_stationary_state"], [132, 2, 1, "", "difference"], [132, 2, 1, "", "error"], [132, 2, 1, "", "eval"], [132, 2, 1, "", "execute"], [132, 3, 1, "", "filename"], [132, 2, 1, "", "filter"], [132, 2, 1, "", "get_system_input_refs"], [132, 2, 1, "", "go_through_configurations"], [132, 3, 1, "", "identity"], [132, 2, 1, "", "info"], [132, 3, 1, "", "input_as_dict"], [132, 2, 1, "", "input_fields"], [132, 2, 1, "", "installSTDLogger"], [132, 2, 1, "", "internal_components"], [132, 2, 1, "", "internal_configurations"], [132, 2, 1, "", "internal_references"], [132, 2, 1, "", "internal_systems"], [132, 2, 1, "", "internal_tabulations"], [132, 3, 1, "", "last_context"], [132, 2, 1, "", "linear_output"], [132, 2, 1, "", "linear_step"], [132, 2, 1, "", "locate"], [132, 2, 1, "", "locate_ref"], [132, 2, 1, "", "make_plots"], [132, 2, 1, "", "mark_all_comps_changed"], [132, 2, 1, "", "message_with_identiy"], [132, 2, 1, "", "msg"], [132, 2, 1, "", "nonlinear_output"], [132, 2, 1, "", "nonlinear_step"], [132, 2, 1, "", "parent_configurations_cls"], [132, 2, 1, "", "parse_run_kwargs"], [132, 2, 1, "", "parse_simulation_input"], [132, 2, 1, "", "plot_attributes"], [132, 3, 1, "", "plotable_variables"], [132, 2, 1, "", "post_run_callback"], [132, 2, 1, "", "post_update"], [132, 2, 1, "", "pre_compile"], [132, 2, 1, "", "pre_run_callback"], [132, 2, 1, "", "rate"], [132, 2, 1, "", "rate_linear"], [132, 2, 1, "", "rate_nonlinear"], [132, 2, 1, "", "ref_dXdt"], [132, 2, 1, "", "resetLog"], [132, 2, 1, "", "resetSystemLogs"], [132, 2, 1, "", "run"], [132, 2, 1, "", "run_internal_systems"], [132, 2, 1, "", "set_time"], [132, 2, 1, "", "setattrs"], [132, 2, 1, "", "setup_global_dynamics"], [132, 2, 1, "", "signals_attributes"], [132, 2, 1, "", "sim_matrix"], [132, 2, 1, "", "simulate"], [132, 3, 1, "", "skip_plot_vars"], [132, 2, 1, "", "slot_refs"], [132, 2, 1, "", "slots_attributes"], [132, 2, 1, "", "smart_split_dataframe"], [132, 2, 1, "", "solver"], [132, 2, 1, "", "solver_vars"], [132, 2, 1, "", "solvers_attributes"], [132, 2, 1, "", "subclasses"], [132, 2, 1, "", "subcls_compile"], [132, 3, 1, "", "system_id"], [132, 2, 1, "", "system_properties_classdef"], [132, 2, 1, "", "system_references"], [132, 2, 1, "", "trace_attributes"], [132, 2, 1, "", "transients_attributes"], [132, 2, 1, "", "update"], [132, 2, 1, "", "update_dynamics"], [132, 2, 1, "", "update_feedthrough"], [132, 2, 1, "", "update_input"], [132, 2, 1, "", "update_output_constants"], [132, 2, 1, "", "update_output_matrix"], [132, 2, 1, "", "update_state"], [132, 2, 1, "", "update_state_constants"], [132, 2, 1, "", "validate_class"], [132, 2, 1, "", "warning"]], "engforge.eng.pipes.Pump": [[133, 3, 1, "", "Ut_ref"], [133, 3, 1, "", "Xt_ref"], [133, 3, 1, "", "Yt_ref"], [133, 2, 1, "", "add_fields"], [133, 3, 1, "", "anything_changed"], [133, 3, 1, "", "as_dict"], [133, 2, 1, "", "check_ref_slot_type"], [133, 3, 1, "", "classname"], [133, 2, 1, "", "cls_compile"], [133, 2, 1, "", "collect_all_attributes"], [133, 2, 1, "", "collect_comp_refs"], [133, 2, 1, "", "collect_dynamic_refs"], [133, 2, 1, "", "collect_inst_attributes"], [133, 2, 1, "", "collect_post_update_refs"], [133, 2, 1, "", "collect_solver_refs"], [133, 2, 1, "", "collect_update_refs"], [133, 2, 1, "", "comp_references"], [133, 2, 1, "", "compile_classes"], [133, 2, 1, "", "copy_config_at_state"], [133, 2, 1, "", "create_dynamic_matricies"], [133, 2, 1, "", "create_feedthrough_matrix"], [133, 2, 1, "", "create_input_matrix"], [133, 2, 1, "", "create_output_constants"], [133, 2, 1, "", "create_output_matrix"], [133, 2, 1, "", "create_state_constants"], [133, 2, 1, "", "create_state_matrix"], [133, 2, 1, "", "critical"], [133, 2, 1, "", "dPressure"], [133, 3, 1, "", "dXtdt_ref"], [133, 3, 1, "", "data_dict"], [133, 2, 1, "", "debug"], [133, 3, 1, "", "design_flow_curve"], [133, 2, 1, "", "determine_nearest_stationary_state"], [133, 2, 1, "", "difference"], [133, 2, 1, "", "error"], [133, 3, 1, "", "filename"], [133, 2, 1, "", "filter"], [133, 2, 1, "", "get_system_input_refs"], [133, 2, 1, "", "go_through_configurations"], [133, 3, 1, "", "identity"], [133, 2, 1, "", "info"], [133, 3, 1, "", "input_as_dict"], [133, 2, 1, "", "input_fields"], [133, 2, 1, "", "installSTDLogger"], [133, 2, 1, "", "internal_components"], [133, 2, 1, "", "internal_configurations"], [133, 2, 1, "", "internal_references"], [133, 2, 1, "", "internal_systems"], [133, 2, 1, "", "internal_tabulations"], [133, 3, 1, "", "last_context"], [133, 2, 1, "", "linear_output"], [133, 2, 1, "", "linear_step"], [133, 2, 1, "", "locate"], [133, 2, 1, "", "locate_ref"], [133, 2, 1, "", "message_with_identiy"], [133, 2, 1, "", "msg"], [133, 2, 1, "", "nonlinear_output"], [133, 2, 1, "", "nonlinear_step"], [133, 2, 1, "", "parent_configurations_cls"], [133, 2, 1, "", "parse_run_kwargs"], [133, 2, 1, "", "parse_simulation_input"], [133, 2, 1, "", "plot_attributes"], [133, 3, 1, "", "plotable_variables"], [133, 2, 1, "", "post_update"], [133, 2, 1, "", "power"], [133, 2, 1, "", "pre_compile"], [133, 2, 1, "", "rate"], [133, 2, 1, "", "rate_linear"], [133, 2, 1, "", "rate_nonlinear"], [133, 2, 1, "", "ref_dXdt"], [133, 2, 1, "", "resetLog"], [133, 2, 1, "", "resetSystemLogs"], [133, 2, 1, "", "set_time"], [133, 2, 1, "", "setattrs"], [133, 2, 1, "", "signals_attributes"], [133, 3, 1, "", "skip_plot_vars"], [133, 2, 1, "", "slot_refs"], [133, 2, 1, "", "slots_attributes"], [133, 2, 1, "", "smart_split_dataframe"], [133, 2, 1, "", "solvers_attributes"], [133, 2, 1, "", "subclasses"], [133, 2, 1, "", "subcls_compile"], [133, 3, 1, "", "system_id"], [133, 2, 1, "", "system_properties_classdef"], [133, 2, 1, "", "system_references"], [133, 2, 1, "", "trace_attributes"], [133, 2, 1, "", "transients_attributes"], [133, 2, 1, "", "update"], [133, 2, 1, "", "update_dynamics"], [133, 2, 1, "", "update_feedthrough"], [133, 2, 1, "", "update_input"], [133, 2, 1, "", "update_output_constants"], [133, 2, 1, "", "update_output_matrix"], [133, 2, 1, "", "update_state"], [133, 2, 1, "", "update_state_constants"], [133, 2, 1, "", "validate_class"], [133, 2, 1, "", "warning"]], "engforge.eng.prediction": [[135, 1, 1, "", "PredictionMixin"]], "engforge.eng.prediction.PredictionMixin": [[135, 2, 1, "", "add_prediction_record"], [135, 2, 1, "", "check_and_retrain"], [135, 2, 1, "", "check_out_of_domain"], [135, 2, 1, "", "observe_and_predict"], [135, 2, 1, "", "score_data"], [135, 2, 1, "", "train_compare"], [135, 2, 1, "", "training_callback"]], "engforge.eng.solid_materials": [[137, 1, 1, "", "ANSI_4130"], [138, 1, 1, "", "ANSI_4340"], [139, 1, 1, "", "Aluminum"], [140, 1, 1, "", "CarbonFiber"], [141, 1, 1, "", "Concrete"], [142, 1, 1, "", "DrySoil"], [143, 1, 1, "", "Rock"], [144, 1, 1, "", "Rubber"], [145, 1, 1, "", "SS_316"], [146, 1, 1, "", "SolidMaterial"], [147, 1, 1, "", "WetSoil"], [148, 4, 1, "", "ih"], [149, 4, 1, "", "random_color"]], "engforge.eng.solid_materials.ANSI_4130": [[137, 2, 1, "", "add_fields"], [137, 3, 1, "", "as_dict"], [137, 2, 1, "", "check_ref_slot_type"], [137, 3, 1, "", "classname"], [137, 2, 1, "", "cls_compile"], [137, 2, 1, "", "collect_all_attributes"], [137, 2, 1, "", "collect_inst_attributes"], [137, 2, 1, "", "compile_classes"], [137, 2, 1, "", "copy_config_at_state"], [137, 2, 1, "", "critical"], [137, 2, 1, "", "debug"], [137, 2, 1, "", "difference"], [137, 2, 1, "", "error"], [137, 3, 1, "", "filename"], [137, 2, 1, "", "filter"], [137, 2, 1, "", "go_through_configurations"], [137, 3, 1, "", "identity"], [137, 2, 1, "", "info"], [137, 3, 1, "", "input_as_dict"], [137, 2, 1, "", "input_fields"], [137, 2, 1, "", "installSTDLogger"], [137, 2, 1, "", "internal_configurations"], [137, 2, 1, "", "message_with_identiy"], [137, 2, 1, "", "msg"], [137, 2, 1, "", "parent_configurations_cls"], [137, 2, 1, "", "plot_attributes"], [137, 2, 1, "", "pre_compile"], [137, 2, 1, "", "resetLog"], [137, 2, 1, "", "resetSystemLogs"], [137, 2, 1, "", "setattrs"], [137, 3, 1, "", "shear_modulus"], [137, 2, 1, "", "signals_attributes"], [137, 2, 1, "", "slot_refs"], [137, 2, 1, "", "slots_attributes"], [137, 2, 1, "", "solvers_attributes"], [137, 2, 1, "", "subclasses"], [137, 2, 1, "", "subcls_compile"], [137, 2, 1, "", "trace_attributes"], [137, 2, 1, "", "transients_attributes"], [137, 2, 1, "", "validate_class"], [137, 2, 1, "", "von_mises_stress_max"], [137, 2, 1, "", "warning"]], "engforge.eng.solid_materials.ANSI_4340": [[138, 2, 1, "", "add_fields"], [138, 3, 1, "", "as_dict"], [138, 2, 1, "", "check_ref_slot_type"], [138, 3, 1, "", "classname"], [138, 2, 1, "", "cls_compile"], [138, 2, 1, "", "collect_all_attributes"], [138, 2, 1, "", "collect_inst_attributes"], [138, 2, 1, "", "compile_classes"], [138, 2, 1, "", "copy_config_at_state"], [138, 2, 1, "", "critical"], [138, 2, 1, "", "debug"], [138, 2, 1, "", "difference"], [138, 2, 1, "", "error"], [138, 3, 1, "", "filename"], [138, 2, 1, "", "filter"], [138, 2, 1, "", "go_through_configurations"], [138, 3, 1, "", "identity"], [138, 2, 1, "", "info"], [138, 3, 1, "", "input_as_dict"], [138, 2, 1, "", "input_fields"], [138, 2, 1, "", "installSTDLogger"], [138, 2, 1, "", "internal_configurations"], [138, 2, 1, "", "message_with_identiy"], [138, 2, 1, "", "msg"], [138, 2, 1, "", "parent_configurations_cls"], [138, 2, 1, "", "plot_attributes"], [138, 2, 1, "", "pre_compile"], [138, 2, 1, "", "resetLog"], [138, 2, 1, "", "resetSystemLogs"], [138, 2, 1, "", "setattrs"], [138, 3, 1, "", "shear_modulus"], [138, 2, 1, "", "signals_attributes"], [138, 2, 1, "", "slot_refs"], [138, 2, 1, "", "slots_attributes"], [138, 2, 1, "", "solvers_attributes"], [138, 2, 1, "", "subclasses"], [138, 2, 1, "", "subcls_compile"], [138, 2, 1, "", "trace_attributes"], [138, 2, 1, "", "transients_attributes"], [138, 2, 1, "", "validate_class"], [138, 2, 1, "", "von_mises_stress_max"], [138, 2, 1, "", "warning"]], "engforge.eng.solid_materials.Aluminum": [[139, 2, 1, "", "add_fields"], [139, 3, 1, "", "as_dict"], [139, 2, 1, "", "check_ref_slot_type"], [139, 3, 1, "", "classname"], [139, 2, 1, "", "cls_compile"], [139, 2, 1, "", "collect_all_attributes"], [139, 2, 1, "", "collect_inst_attributes"], [139, 2, 1, "", "compile_classes"], [139, 2, 1, "", "copy_config_at_state"], [139, 2, 1, "", "critical"], [139, 2, 1, "", "debug"], [139, 2, 1, "", "difference"], [139, 2, 1, "", "error"], [139, 3, 1, "", "filename"], [139, 2, 1, "", "filter"], [139, 2, 1, "", "go_through_configurations"], [139, 3, 1, "", "identity"], [139, 2, 1, "", "info"], [139, 3, 1, "", "input_as_dict"], [139, 2, 1, "", "input_fields"], [139, 2, 1, "", "installSTDLogger"], [139, 2, 1, "", "internal_configurations"], [139, 2, 1, "", "message_with_identiy"], [139, 2, 1, "", "msg"], [139, 2, 1, "", "parent_configurations_cls"], [139, 2, 1, "", "plot_attributes"], [139, 2, 1, "", "pre_compile"], [139, 2, 1, "", "resetLog"], [139, 2, 1, "", "resetSystemLogs"], [139, 2, 1, "", "setattrs"], [139, 3, 1, "", "shear_modulus"], [139, 2, 1, "", "signals_attributes"], [139, 2, 1, "", "slot_refs"], [139, 2, 1, "", "slots_attributes"], [139, 2, 1, "", "solvers_attributes"], [139, 2, 1, "", "subclasses"], [139, 2, 1, "", "subcls_compile"], [139, 2, 1, "", "trace_attributes"], [139, 2, 1, "", "transients_attributes"], [139, 2, 1, "", "validate_class"], [139, 2, 1, "", "von_mises_stress_max"], [139, 2, 1, "", "warning"]], "engforge.eng.solid_materials.CarbonFiber": [[140, 2, 1, "", "add_fields"], [140, 3, 1, "", "as_dict"], [140, 2, 1, "", "check_ref_slot_type"], [140, 3, 1, "", "classname"], [140, 2, 1, "", "cls_compile"], [140, 2, 1, "", "collect_all_attributes"], [140, 2, 1, "", "collect_inst_attributes"], [140, 2, 1, "", "compile_classes"], [140, 2, 1, "", "copy_config_at_state"], [140, 2, 1, "", "critical"], [140, 2, 1, "", "debug"], [140, 2, 1, "", "difference"], [140, 2, 1, "", "error"], [140, 3, 1, "", "filename"], [140, 2, 1, "", "filter"], [140, 2, 1, "", "go_through_configurations"], [140, 3, 1, "", "identity"], [140, 2, 1, "", "info"], [140, 3, 1, "", "input_as_dict"], [140, 2, 1, "", "input_fields"], [140, 2, 1, "", "installSTDLogger"], [140, 2, 1, "", "internal_configurations"], [140, 2, 1, "", "message_with_identiy"], [140, 2, 1, "", "msg"], [140, 2, 1, "", "parent_configurations_cls"], [140, 2, 1, "", "plot_attributes"], [140, 2, 1, "", "pre_compile"], [140, 2, 1, "", "resetLog"], [140, 2, 1, "", "resetSystemLogs"], [140, 2, 1, "", "setattrs"], [140, 3, 1, "", "shear_modulus"], [140, 2, 1, "", "signals_attributes"], [140, 2, 1, "", "slot_refs"], [140, 2, 1, "", "slots_attributes"], [140, 2, 1, "", "solvers_attributes"], [140, 2, 1, "", "subclasses"], [140, 2, 1, "", "subcls_compile"], [140, 2, 1, "", "trace_attributes"], [140, 2, 1, "", "transients_attributes"], [140, 2, 1, "", "validate_class"], [140, 2, 1, "", "von_mises_stress_max"], [140, 2, 1, "", "warning"]], "engforge.eng.solid_materials.Concrete": [[141, 2, 1, "", "add_fields"], [141, 3, 1, "", "as_dict"], [141, 2, 1, "", "check_ref_slot_type"], [141, 3, 1, "", "classname"], [141, 2, 1, "", "cls_compile"], [141, 2, 1, "", "collect_all_attributes"], [141, 2, 1, "", "collect_inst_attributes"], [141, 2, 1, "", "compile_classes"], [141, 2, 1, "", "copy_config_at_state"], [141, 2, 1, "", "critical"], [141, 2, 1, "", "debug"], [141, 2, 1, "", "difference"], [141, 2, 1, "", "error"], [141, 3, 1, "", "filename"], [141, 2, 1, "", "filter"], [141, 2, 1, "", "go_through_configurations"], [141, 3, 1, "", "identity"], [141, 2, 1, "", "info"], [141, 3, 1, "", "input_as_dict"], [141, 2, 1, "", "input_fields"], [141, 2, 1, "", "installSTDLogger"], [141, 2, 1, "", "internal_configurations"], [141, 2, 1, "", "message_with_identiy"], [141, 2, 1, "", "msg"], [141, 2, 1, "", "parent_configurations_cls"], [141, 2, 1, "", "plot_attributes"], [141, 2, 1, "", "pre_compile"], [141, 2, 1, "", "resetLog"], [141, 2, 1, "", "resetSystemLogs"], [141, 2, 1, "", "setattrs"], [141, 3, 1, "", "shear_modulus"], [141, 2, 1, "", "signals_attributes"], [141, 2, 1, "", "slot_refs"], [141, 2, 1, "", "slots_attributes"], [141, 2, 1, "", "solvers_attributes"], [141, 2, 1, "", "subclasses"], [141, 2, 1, "", "subcls_compile"], [141, 2, 1, "", "trace_attributes"], [141, 2, 1, "", "transients_attributes"], [141, 2, 1, "", "validate_class"], [141, 2, 1, "", "von_mises_stress_max"], [141, 2, 1, "", "warning"]], "engforge.eng.solid_materials.DrySoil": [[142, 2, 1, "", "add_fields"], [142, 3, 1, "", "as_dict"], [142, 2, 1, "", "check_ref_slot_type"], [142, 3, 1, "", "classname"], [142, 2, 1, "", "cls_compile"], [142, 2, 1, "", "collect_all_attributes"], [142, 2, 1, "", "collect_inst_attributes"], [142, 2, 1, "", "compile_classes"], [142, 2, 1, "", "copy_config_at_state"], [142, 2, 1, "", "critical"], [142, 2, 1, "", "debug"], [142, 2, 1, "", "difference"], [142, 2, 1, "", "error"], [142, 3, 1, "", "filename"], [142, 2, 1, "", "filter"], [142, 2, 1, "", "go_through_configurations"], [142, 3, 1, "", "identity"], [142, 2, 1, "", "info"], [142, 3, 1, "", "input_as_dict"], [142, 2, 1, "", "input_fields"], [142, 2, 1, "", "installSTDLogger"], [142, 2, 1, "", "internal_configurations"], [142, 2, 1, "", "message_with_identiy"], [142, 2, 1, "", "msg"], [142, 2, 1, "", "parent_configurations_cls"], [142, 2, 1, "", "plot_attributes"], [142, 2, 1, "", "pre_compile"], [142, 2, 1, "", "resetLog"], [142, 2, 1, "", "resetSystemLogs"], [142, 2, 1, "", "setattrs"], [142, 3, 1, "", "shear_modulus"], [142, 2, 1, "", "signals_attributes"], [142, 2, 1, "", "slot_refs"], [142, 2, 1, "", "slots_attributes"], [142, 2, 1, "", "solvers_attributes"], [142, 2, 1, "", "subclasses"], [142, 2, 1, "", "subcls_compile"], [142, 2, 1, "", "trace_attributes"], [142, 2, 1, "", "transients_attributes"], [142, 2, 1, "", "validate_class"], [142, 2, 1, "", "von_mises_stress_max"], [142, 2, 1, "", "warning"]], "engforge.eng.solid_materials.Rock": [[143, 2, 1, "", "add_fields"], [143, 3, 1, "", "as_dict"], [143, 2, 1, "", "check_ref_slot_type"], [143, 3, 1, "", "classname"], [143, 2, 1, "", "cls_compile"], [143, 2, 1, "", "collect_all_attributes"], [143, 2, 1, "", "collect_inst_attributes"], [143, 2, 1, "", "compile_classes"], [143, 2, 1, "", "copy_config_at_state"], [143, 2, 1, "", "critical"], [143, 2, 1, "", "debug"], [143, 2, 1, "", "difference"], [143, 2, 1, "", "error"], [143, 3, 1, "", "filename"], [143, 2, 1, "", "filter"], [143, 2, 1, "", "go_through_configurations"], [143, 3, 1, "", "identity"], [143, 2, 1, "", "info"], [143, 3, 1, "", "input_as_dict"], [143, 2, 1, "", "input_fields"], [143, 2, 1, "", "installSTDLogger"], [143, 2, 1, "", "internal_configurations"], [143, 2, 1, "", "message_with_identiy"], [143, 2, 1, "", "msg"], [143, 2, 1, "", "parent_configurations_cls"], [143, 2, 1, "", "plot_attributes"], [143, 2, 1, "", "pre_compile"], [143, 2, 1, "", "resetLog"], [143, 2, 1, "", "resetSystemLogs"], [143, 2, 1, "", "setattrs"], [143, 3, 1, "", "shear_modulus"], [143, 2, 1, "", "signals_attributes"], [143, 2, 1, "", "slot_refs"], [143, 2, 1, "", "slots_attributes"], [143, 2, 1, "", "solvers_attributes"], [143, 2, 1, "", "subclasses"], [143, 2, 1, "", "subcls_compile"], [143, 2, 1, "", "trace_attributes"], [143, 2, 1, "", "transients_attributes"], [143, 2, 1, "", "validate_class"], [143, 2, 1, "", "von_mises_stress_max"], [143, 2, 1, "", "warning"]], "engforge.eng.solid_materials.Rubber": [[144, 2, 1, "", "add_fields"], [144, 3, 1, "", "as_dict"], [144, 2, 1, "", "check_ref_slot_type"], [144, 3, 1, "", "classname"], [144, 2, 1, "", "cls_compile"], [144, 2, 1, "", "collect_all_attributes"], [144, 2, 1, "", "collect_inst_attributes"], [144, 2, 1, "", "compile_classes"], [144, 2, 1, "", "copy_config_at_state"], [144, 2, 1, "", "critical"], [144, 2, 1, "", "debug"], [144, 2, 1, "", "difference"], [144, 2, 1, "", "error"], [144, 3, 1, "", "filename"], [144, 2, 1, "", "filter"], [144, 2, 1, "", "go_through_configurations"], [144, 3, 1, "", "identity"], [144, 2, 1, "", "info"], [144, 3, 1, "", "input_as_dict"], [144, 2, 1, "", "input_fields"], [144, 2, 1, "", "installSTDLogger"], [144, 2, 1, "", "internal_configurations"], [144, 2, 1, "", "message_with_identiy"], [144, 2, 1, "", "msg"], [144, 2, 1, "", "parent_configurations_cls"], [144, 2, 1, "", "plot_attributes"], [144, 2, 1, "", "pre_compile"], [144, 2, 1, "", "resetLog"], [144, 2, 1, "", "resetSystemLogs"], [144, 2, 1, "", "setattrs"], [144, 3, 1, "", "shear_modulus"], [144, 2, 1, "", "signals_attributes"], [144, 2, 1, "", "slot_refs"], [144, 2, 1, "", "slots_attributes"], [144, 2, 1, "", "solvers_attributes"], [144, 2, 1, "", "subclasses"], [144, 2, 1, "", "subcls_compile"], [144, 2, 1, "", "trace_attributes"], [144, 2, 1, "", "transients_attributes"], [144, 2, 1, "", "validate_class"], [144, 2, 1, "", "von_mises_stress_max"], [144, 2, 1, "", "warning"]], "engforge.eng.solid_materials.SS_316": [[145, 2, 1, "", "add_fields"], [145, 3, 1, "", "as_dict"], [145, 2, 1, "", "check_ref_slot_type"], [145, 3, 1, "", "classname"], [145, 2, 1, "", "cls_compile"], [145, 2, 1, "", "collect_all_attributes"], [145, 2, 1, "", "collect_inst_attributes"], [145, 2, 1, "", "compile_classes"], [145, 2, 1, "", "copy_config_at_state"], [145, 2, 1, "", "critical"], [145, 2, 1, "", "debug"], [145, 2, 1, "", "difference"], [145, 2, 1, "", "error"], [145, 3, 1, "", "filename"], [145, 2, 1, "", "filter"], [145, 2, 1, "", "go_through_configurations"], [145, 3, 1, "", "identity"], [145, 2, 1, "", "info"], [145, 3, 1, "", "input_as_dict"], [145, 2, 1, "", "input_fields"], [145, 2, 1, "", "installSTDLogger"], [145, 2, 1, "", "internal_configurations"], [145, 2, 1, "", "message_with_identiy"], [145, 2, 1, "", "msg"], [145, 2, 1, "", "parent_configurations_cls"], [145, 2, 1, "", "plot_attributes"], [145, 2, 1, "", "pre_compile"], [145, 2, 1, "", "resetLog"], [145, 2, 1, "", "resetSystemLogs"], [145, 2, 1, "", "setattrs"], [145, 3, 1, "", "shear_modulus"], [145, 2, 1, "", "signals_attributes"], [145, 2, 1, "", "slot_refs"], [145, 2, 1, "", "slots_attributes"], [145, 2, 1, "", "solvers_attributes"], [145, 2, 1, "", "subclasses"], [145, 2, 1, "", "subcls_compile"], [145, 2, 1, "", "trace_attributes"], [145, 2, 1, "", "transients_attributes"], [145, 2, 1, "", "validate_class"], [145, 2, 1, "", "von_mises_stress_max"], [145, 2, 1, "", "warning"]], "engforge.eng.solid_materials.SolidMaterial": [[146, 2, 1, "", "add_fields"], [146, 3, 1, "", "as_dict"], [146, 2, 1, "", "check_ref_slot_type"], [146, 3, 1, "", "classname"], [146, 2, 1, "", "cls_compile"], [146, 2, 1, "", "collect_all_attributes"], [146, 2, 1, "", "collect_inst_attributes"], [146, 2, 1, "", "compile_classes"], [146, 2, 1, "", "copy_config_at_state"], [146, 2, 1, "", "critical"], [146, 2, 1, "", "debug"], [146, 2, 1, "", "difference"], [146, 2, 1, "", "error"], [146, 3, 1, "", "filename"], [146, 2, 1, "", "filter"], [146, 2, 1, "", "go_through_configurations"], [146, 3, 1, "", "identity"], [146, 2, 1, "", "info"], [146, 3, 1, "", "input_as_dict"], [146, 2, 1, "", "input_fields"], [146, 2, 1, "", "installSTDLogger"], [146, 2, 1, "", "internal_configurations"], [146, 2, 1, "", "message_with_identiy"], [146, 2, 1, "", "msg"], [146, 2, 1, "", "parent_configurations_cls"], [146, 2, 1, "", "plot_attributes"], [146, 2, 1, "", "pre_compile"], [146, 2, 1, "", "resetLog"], [146, 2, 1, "", "resetSystemLogs"], [146, 2, 1, "", "setattrs"], [146, 3, 1, "", "shear_modulus"], [146, 2, 1, "", "signals_attributes"], [146, 2, 1, "", "slot_refs"], [146, 2, 1, "", "slots_attributes"], [146, 2, 1, "", "solvers_attributes"], [146, 2, 1, "", "subclasses"], [146, 2, 1, "", "subcls_compile"], [146, 2, 1, "", "trace_attributes"], [146, 2, 1, "", "transients_attributes"], [146, 2, 1, "", "validate_class"], [146, 2, 1, "", "von_mises_stress_max"], [146, 2, 1, "", "warning"]], "engforge.eng.solid_materials.WetSoil": [[147, 2, 1, "", "add_fields"], [147, 3, 1, "", "as_dict"], [147, 2, 1, "", "check_ref_slot_type"], [147, 3, 1, "", "classname"], [147, 2, 1, "", "cls_compile"], [147, 2, 1, "", "collect_all_attributes"], [147, 2, 1, "", "collect_inst_attributes"], [147, 2, 1, "", "compile_classes"], [147, 2, 1, "", "copy_config_at_state"], [147, 2, 1, "", "critical"], [147, 2, 1, "", "debug"], [147, 2, 1, "", "difference"], [147, 2, 1, "", "error"], [147, 3, 1, "", "filename"], [147, 2, 1, "", "filter"], [147, 2, 1, "", "go_through_configurations"], [147, 3, 1, "", "identity"], [147, 2, 1, "", "info"], [147, 3, 1, "", "input_as_dict"], [147, 2, 1, "", "input_fields"], [147, 2, 1, "", "installSTDLogger"], [147, 2, 1, "", "internal_configurations"], [147, 2, 1, "", "message_with_identiy"], [147, 2, 1, "", "msg"], [147, 2, 1, "", "parent_configurations_cls"], [147, 2, 1, "", "plot_attributes"], [147, 2, 1, "", "pre_compile"], [147, 2, 1, "", "resetLog"], [147, 2, 1, "", "resetSystemLogs"], [147, 2, 1, "", "setattrs"], [147, 3, 1, "", "shear_modulus"], [147, 2, 1, "", "signals_attributes"], [147, 2, 1, "", "slot_refs"], [147, 2, 1, "", "slots_attributes"], [147, 2, 1, "", "solvers_attributes"], [147, 2, 1, "", "subclasses"], [147, 2, 1, "", "subcls_compile"], [147, 2, 1, "", "trace_attributes"], [147, 2, 1, "", "transients_attributes"], [147, 2, 1, "", "validate_class"], [147, 2, 1, "", "von_mises_stress_max"], [147, 2, 1, "", "warning"]], "engforge.eng.structure_beams": [[151, 1, 1, "", "Beam"], [152, 4, 1, "", "rotation_matrix_from_vectors"]], "engforge.eng.structure_beams.Beam": [[151, 3, 1, "", "Ao"], [151, 3, 1, "", "CG_RELATIVE_INERTIA"], [151, 3, 1, "", "Fg"], [151, 3, 1, "", "GLOBAL_INERTIA"], [151, 3, 1, "", "INERTIA"], [151, 3, 1, "", "LOCAL_INERTIA"], [151, 3, 1, "", "Ut_ref"], [151, 3, 1, "", "Xt_ref"], [151, 3, 1, "", "Yt_ref"], [151, 2, 1, "", "add_fields"], [151, 3, 1, "", "anything_changed"], [151, 2, 1, "", "apply_distributed_load"], [151, 2, 1, "", "apply_local_distributed_load"], [151, 2, 1, "", "apply_local_pt_load"], [151, 2, 1, "", "apply_pt_load"], [151, 3, 1, "", "as_dict"], [151, 2, 1, "", "calculate_item_cost"], [151, 2, 1, "", "calculate_stress"], [151, 2, 1, "", "check_ref_slot_type"], [151, 2, 1, "", "class_cost_properties"], [151, 3, 1, "", "classname"], [151, 2, 1, "", "cls_compile"], [151, 2, 1, "", "collect_all_attributes"], [151, 2, 1, "", "collect_comp_refs"], [151, 2, 1, "", "collect_dynamic_refs"], [151, 2, 1, "", "collect_inst_attributes"], [151, 2, 1, "", "collect_post_update_refs"], [151, 2, 1, "", "collect_solver_refs"], [151, 2, 1, "", "collect_update_refs"], [151, 2, 1, "", "comp_references"], [151, 2, 1, "", "compile_classes"], [151, 2, 1, "", "copy_config_at_state"], [151, 3, 1, "", "cost_categories"], [151, 3, 1, "", "cost_properties"], [151, 2, 1, "", "costs_at_term"], [151, 2, 1, "", "create_dynamic_matricies"], [151, 2, 1, "", "create_feedthrough_matrix"], [151, 2, 1, "", "create_input_matrix"], [151, 2, 1, "", "create_output_constants"], [151, 2, 1, "", "create_output_matrix"], [151, 2, 1, "", "create_state_constants"], [151, 2, 1, "", "create_state_matrix"], [151, 2, 1, "", "critical"], [151, 2, 1, "", "custom_cost"], [151, 3, 1, "", "dXtdt_ref"], [151, 3, 1, "", "data_dict"], [151, 2, 1, "", "debug"], [151, 2, 1, "", "default_cost"], [151, 2, 1, "", "determine_nearest_stationary_state"], [151, 2, 1, "", "difference"], [151, 2, 1, "", "error"], [151, 2, 1, "", "estimate_stress"], [151, 3, 1, "", "filename"], [151, 2, 1, "", "filter"], [151, 2, 1, "", "get_forces_at"], [151, 2, 1, "", "get_stress_at"], [151, 2, 1, "", "get_system_input_refs"], [151, 2, 1, "", "go_through_configurations"], [151, 3, 1, "", "identity"], [151, 2, 1, "", "info"], [151, 3, 1, "", "input_as_dict"], [151, 2, 1, "", "input_fields"], [151, 2, 1, "", "installSTDLogger"], [151, 2, 1, "", "internal_components"], [151, 2, 1, "", "internal_configurations"], [151, 2, 1, "", "internal_references"], [151, 2, 1, "", "internal_systems"], [151, 2, 1, "", "internal_tabulations"], [151, 3, 1, "", "last_context"], [151, 2, 1, "", "linear_output"], [151, 2, 1, "", "linear_step"], [151, 2, 1, "", "locate"], [151, 2, 1, "", "locate_ref"], [151, 2, 1, "", "max_von_mises"], [151, 2, 1, "", "max_von_mises_by_case"], [151, 2, 1, "", "message_with_identiy"], [151, 2, 1, "", "msg"], [151, 2, 1, "", "nonlinear_output"], [151, 2, 1, "", "nonlinear_step"], [151, 2, 1, "", "parent_configurations_cls"], [151, 2, 1, "", "parse_run_kwargs"], [151, 2, 1, "", "parse_simulation_input"], [151, 2, 1, "", "plot_attributes"], [151, 3, 1, "", "plotable_variables"], [151, 2, 1, "", "post_update"], [151, 2, 1, "", "pre_compile"], [151, 2, 1, "", "rate"], [151, 2, 1, "", "rate_linear"], [151, 2, 1, "", "rate_nonlinear"], [151, 2, 1, "", "ref_dXdt"], [151, 2, 1, "", "resetLog"], [151, 2, 1, "", "resetSystemLogs"], [151, 2, 1, "", "set_default_costs"], [151, 2, 1, "", "set_time"], [151, 2, 1, "", "setattrs"], [151, 2, 1, "", "signals_attributes"], [151, 3, 1, "", "skip_plot_vars"], [151, 2, 1, "", "slot_refs"], [151, 2, 1, "", "slots_attributes"], [151, 2, 1, "", "smart_split_dataframe"], [151, 2, 1, "", "solvers_attributes"], [151, 2, 1, "", "sub_costs"], [151, 2, 1, "", "subclasses"], [151, 2, 1, "", "subcls_compile"], [151, 2, 1, "", "sum_costs"], [151, 3, 1, "", "system_id"], [151, 2, 1, "", "system_properties_classdef"], [151, 2, 1, "", "system_references"], [151, 2, 1, "", "trace_attributes"], [151, 2, 1, "", "transients_attributes"], [151, 2, 1, "", "update"], [151, 2, 1, "", "update_dflt_costs"], [151, 2, 1, "", "update_dynamics"], [151, 2, 1, "", "update_feedthrough"], [151, 2, 1, "", "update_input"], [151, 2, 1, "", "update_output_constants"], [151, 2, 1, "", "update_output_matrix"], [151, 2, 1, "", "update_state"], [151, 2, 1, "", "update_state_constants"], [151, 2, 1, "", "validate_class"], [151, 2, 1, "", "warning"]], "engforge.eng.thermodynamics": [[154, 1, 1, "", "SimpleCompressor"], [155, 1, 1, "", "SimpleHeatExchanger"], [156, 1, 1, "", "SimplePump"], [157, 1, 1, "", "SimpleTurbine"], [158, 4, 1, "", "dp_he_core"], [159, 4, 1, "", "dp_he_entrance"], [160, 4, 1, "", "dp_he_exit"], [161, 4, 1, "", "dp_he_gas_losses"], [162, 4, 1, "", "fanning_friction_factor"]], "engforge.eng.thermodynamics.SimpleCompressor": [[154, 3, 1, "", "Ut_ref"], [154, 3, 1, "", "Xt_ref"], [154, 3, 1, "", "Yt_ref"], [154, 2, 1, "", "add_fields"], [154, 3, 1, "", "anything_changed"], [154, 3, 1, "", "as_dict"], [154, 2, 1, "", "check_ref_slot_type"], [154, 3, 1, "", "classname"], [154, 2, 1, "", "cls_compile"], [154, 2, 1, "", "collect_all_attributes"], [154, 2, 1, "", "collect_comp_refs"], [154, 2, 1, "", "collect_dynamic_refs"], [154, 2, 1, "", "collect_inst_attributes"], [154, 2, 1, "", "collect_post_update_refs"], [154, 2, 1, "", "collect_solver_refs"], [154, 2, 1, "", "collect_update_refs"], [154, 2, 1, "", "comp_references"], [154, 2, 1, "", "compile_classes"], [154, 2, 1, "", "copy_config_at_state"], [154, 2, 1, "", "create_dynamic_matricies"], [154, 2, 1, "", "create_feedthrough_matrix"], [154, 2, 1, "", "create_input_matrix"], [154, 2, 1, "", "create_output_constants"], [154, 2, 1, "", "create_output_matrix"], [154, 2, 1, "", "create_state_constants"], [154, 2, 1, "", "create_state_matrix"], [154, 2, 1, "", "critical"], [154, 3, 1, "", "dXtdt_ref"], [154, 3, 1, "", "data_dict"], [154, 2, 1, "", "debug"], [154, 2, 1, "", "determine_nearest_stationary_state"], [154, 2, 1, "", "difference"], [154, 2, 1, "", "error"], [154, 3, 1, "", "filename"], [154, 2, 1, "", "filter"], [154, 2, 1, "", "get_system_input_refs"], [154, 2, 1, "", "go_through_configurations"], [154, 3, 1, "", "identity"], [154, 2, 1, "", "info"], [154, 3, 1, "", "input_as_dict"], [154, 2, 1, "", "input_fields"], [154, 2, 1, "", "installSTDLogger"], [154, 2, 1, "", "internal_components"], [154, 2, 1, "", "internal_configurations"], [154, 2, 1, "", "internal_references"], [154, 2, 1, "", "internal_systems"], [154, 2, 1, "", "internal_tabulations"], [154, 3, 1, "", "last_context"], [154, 2, 1, "", "linear_output"], [154, 2, 1, "", "linear_step"], [154, 2, 1, "", "locate"], [154, 2, 1, "", "locate_ref"], [154, 2, 1, "", "message_with_identiy"], [154, 2, 1, "", "msg"], [154, 2, 1, "", "nonlinear_output"], [154, 2, 1, "", "nonlinear_step"], [154, 2, 1, "", "parent_configurations_cls"], [154, 2, 1, "", "parse_run_kwargs"], [154, 2, 1, "", "parse_simulation_input"], [154, 2, 1, "", "plot_attributes"], [154, 3, 1, "", "plotable_variables"], [154, 2, 1, "", "post_update"], [154, 2, 1, "", "pre_compile"], [154, 2, 1, "", "rate"], [154, 2, 1, "", "rate_linear"], [154, 2, 1, "", "rate_nonlinear"], [154, 2, 1, "", "ref_dXdt"], [154, 2, 1, "", "resetLog"], [154, 2, 1, "", "resetSystemLogs"], [154, 2, 1, "", "set_time"], [154, 2, 1, "", "setattrs"], [154, 2, 1, "", "signals_attributes"], [154, 3, 1, "", "skip_plot_vars"], [154, 2, 1, "", "slot_refs"], [154, 2, 1, "", "slots_attributes"], [154, 2, 1, "", "smart_split_dataframe"], [154, 2, 1, "", "solvers_attributes"], [154, 2, 1, "", "subclasses"], [154, 2, 1, "", "subcls_compile"], [154, 3, 1, "", "system_id"], [154, 2, 1, "", "system_properties_classdef"], [154, 2, 1, "", "system_references"], [154, 2, 1, "", "trace_attributes"], [154, 2, 1, "", "transients_attributes"], [154, 2, 1, "", "update"], [154, 2, 1, "", "update_dynamics"], [154, 2, 1, "", "update_feedthrough"], [154, 2, 1, "", "update_input"], [154, 2, 1, "", "update_output_constants"], [154, 2, 1, "", "update_output_matrix"], [154, 2, 1, "", "update_state"], [154, 2, 1, "", "update_state_constants"], [154, 2, 1, "", "validate_class"], [154, 2, 1, "", "warning"]], "engforge.eng.thermodynamics.SimpleHeatExchanger": [[155, 3, 1, "", "Ut_ref"], [155, 3, 1, "", "Xt_ref"], [155, 3, 1, "", "Yt_ref"], [155, 2, 1, "", "add_fields"], [155, 3, 1, "", "anything_changed"], [155, 3, 1, "", "as_dict"], [155, 2, 1, "", "check_ref_slot_type"], [155, 3, 1, "", "classname"], [155, 2, 1, "", "cls_compile"], [155, 2, 1, "", "collect_all_attributes"], [155, 2, 1, "", "collect_comp_refs"], [155, 2, 1, "", "collect_dynamic_refs"], [155, 2, 1, "", "collect_inst_attributes"], [155, 2, 1, "", "collect_post_update_refs"], [155, 2, 1, "", "collect_solver_refs"], [155, 2, 1, "", "collect_update_refs"], [155, 2, 1, "", "comp_references"], [155, 2, 1, "", "compile_classes"], [155, 2, 1, "", "copy_config_at_state"], [155, 2, 1, "", "create_dynamic_matricies"], [155, 2, 1, "", "create_feedthrough_matrix"], [155, 2, 1, "", "create_input_matrix"], [155, 2, 1, "", "create_output_constants"], [155, 2, 1, "", "create_output_matrix"], [155, 2, 1, "", "create_state_constants"], [155, 2, 1, "", "create_state_matrix"], [155, 2, 1, "", "critical"], [155, 3, 1, "", "dXtdt_ref"], [155, 3, 1, "", "data_dict"], [155, 2, 1, "", "debug"], [155, 2, 1, "", "determine_nearest_stationary_state"], [155, 2, 1, "", "difference"], [155, 2, 1, "", "error"], [155, 3, 1, "", "filename"], [155, 2, 1, "", "filter"], [155, 2, 1, "", "get_system_input_refs"], [155, 2, 1, "", "go_through_configurations"], [155, 3, 1, "", "identity"], [155, 2, 1, "", "info"], [155, 3, 1, "", "input_as_dict"], [155, 2, 1, "", "input_fields"], [155, 2, 1, "", "installSTDLogger"], [155, 2, 1, "", "internal_components"], [155, 2, 1, "", "internal_configurations"], [155, 2, 1, "", "internal_references"], [155, 2, 1, "", "internal_systems"], [155, 2, 1, "", "internal_tabulations"], [155, 3, 1, "", "last_context"], [155, 2, 1, "", "linear_output"], [155, 2, 1, "", "linear_step"], [155, 2, 1, "", "locate"], [155, 2, 1, "", "locate_ref"], [155, 2, 1, "", "message_with_identiy"], [155, 2, 1, "", "msg"], [155, 2, 1, "", "nonlinear_output"], [155, 2, 1, "", "nonlinear_step"], [155, 2, 1, "", "parent_configurations_cls"], [155, 2, 1, "", "parse_run_kwargs"], [155, 2, 1, "", "parse_simulation_input"], [155, 2, 1, "", "plot_attributes"], [155, 3, 1, "", "plotable_variables"], [155, 2, 1, "", "post_update"], [155, 2, 1, "", "pre_compile"], [155, 2, 1, "", "rate"], [155, 2, 1, "", "rate_linear"], [155, 2, 1, "", "rate_nonlinear"], [155, 2, 1, "", "ref_dXdt"], [155, 2, 1, "", "resetLog"], [155, 2, 1, "", "resetSystemLogs"], [155, 2, 1, "", "set_time"], [155, 2, 1, "", "setattrs"], [155, 2, 1, "", "signals_attributes"], [155, 3, 1, "", "skip_plot_vars"], [155, 2, 1, "", "slot_refs"], [155, 2, 1, "", "slots_attributes"], [155, 2, 1, "", "smart_split_dataframe"], [155, 2, 1, "", "solvers_attributes"], [155, 2, 1, "", "subclasses"], [155, 2, 1, "", "subcls_compile"], [155, 3, 1, "", "system_id"], [155, 2, 1, "", "system_properties_classdef"], [155, 2, 1, "", "system_references"], [155, 2, 1, "", "trace_attributes"], [155, 2, 1, "", "transients_attributes"], [155, 2, 1, "", "update"], [155, 2, 1, "", "update_dynamics"], [155, 2, 1, "", "update_feedthrough"], [155, 2, 1, "", "update_input"], [155, 2, 1, "", "update_output_constants"], [155, 2, 1, "", "update_output_matrix"], [155, 2, 1, "", "update_state"], [155, 2, 1, "", "update_state_constants"], [155, 2, 1, "", "validate_class"], [155, 2, 1, "", "warning"]], "engforge.eng.thermodynamics.SimplePump": [[156, 3, 1, "", "Ut_ref"], [156, 3, 1, "", "Xt_ref"], [156, 3, 1, "", "Yt_ref"], [156, 2, 1, "", "add_fields"], [156, 3, 1, "", "anything_changed"], [156, 3, 1, "", "as_dict"], [156, 2, 1, "", "check_ref_slot_type"], [156, 3, 1, "", "classname"], [156, 2, 1, "", "cls_compile"], [156, 2, 1, "", "collect_all_attributes"], [156, 2, 1, "", "collect_comp_refs"], [156, 2, 1, "", "collect_dynamic_refs"], [156, 2, 1, "", "collect_inst_attributes"], [156, 2, 1, "", "collect_post_update_refs"], [156, 2, 1, "", "collect_solver_refs"], [156, 2, 1, "", "collect_update_refs"], [156, 2, 1, "", "comp_references"], [156, 2, 1, "", "compile_classes"], [156, 2, 1, "", "copy_config_at_state"], [156, 2, 1, "", "create_dynamic_matricies"], [156, 2, 1, "", "create_feedthrough_matrix"], [156, 2, 1, "", "create_input_matrix"], [156, 2, 1, "", "create_output_constants"], [156, 2, 1, "", "create_output_matrix"], [156, 2, 1, "", "create_state_constants"], [156, 2, 1, "", "create_state_matrix"], [156, 2, 1, "", "critical"], [156, 3, 1, "", "dXtdt_ref"], [156, 3, 1, "", "data_dict"], [156, 2, 1, "", "debug"], [156, 2, 1, "", "determine_nearest_stationary_state"], [156, 2, 1, "", "difference"], [156, 2, 1, "", "error"], [156, 3, 1, "", "filename"], [156, 2, 1, "", "filter"], [156, 2, 1, "", "get_system_input_refs"], [156, 2, 1, "", "go_through_configurations"], [156, 3, 1, "", "identity"], [156, 2, 1, "", "info"], [156, 3, 1, "", "input_as_dict"], [156, 2, 1, "", "input_fields"], [156, 2, 1, "", "installSTDLogger"], [156, 2, 1, "", "internal_components"], [156, 2, 1, "", "internal_configurations"], [156, 2, 1, "", "internal_references"], [156, 2, 1, "", "internal_systems"], [156, 2, 1, "", "internal_tabulations"], [156, 3, 1, "", "last_context"], [156, 2, 1, "", "linear_output"], [156, 2, 1, "", "linear_step"], [156, 2, 1, "", "locate"], [156, 2, 1, "", "locate_ref"], [156, 2, 1, "", "message_with_identiy"], [156, 2, 1, "", "msg"], [156, 2, 1, "", "nonlinear_output"], [156, 2, 1, "", "nonlinear_step"], [156, 2, 1, "", "parent_configurations_cls"], [156, 2, 1, "", "parse_run_kwargs"], [156, 2, 1, "", "parse_simulation_input"], [156, 2, 1, "", "plot_attributes"], [156, 3, 1, "", "plotable_variables"], [156, 2, 1, "", "post_update"], [156, 2, 1, "", "pre_compile"], [156, 2, 1, "", "rate"], [156, 2, 1, "", "rate_linear"], [156, 2, 1, "", "rate_nonlinear"], [156, 2, 1, "", "ref_dXdt"], [156, 2, 1, "", "resetLog"], [156, 2, 1, "", "resetSystemLogs"], [156, 2, 1, "", "set_time"], [156, 2, 1, "", "setattrs"], [156, 2, 1, "", "signals_attributes"], [156, 3, 1, "", "skip_plot_vars"], [156, 2, 1, "", "slot_refs"], [156, 2, 1, "", "slots_attributes"], [156, 2, 1, "", "smart_split_dataframe"], [156, 2, 1, "", "solvers_attributes"], [156, 2, 1, "", "subclasses"], [156, 2, 1, "", "subcls_compile"], [156, 3, 1, "", "system_id"], [156, 2, 1, "", "system_properties_classdef"], [156, 2, 1, "", "system_references"], [156, 2, 1, "", "trace_attributes"], [156, 2, 1, "", "transients_attributes"], [156, 2, 1, "", "update"], [156, 2, 1, "", "update_dynamics"], [156, 2, 1, "", "update_feedthrough"], [156, 2, 1, "", "update_input"], [156, 2, 1, "", "update_output_constants"], [156, 2, 1, "", "update_output_matrix"], [156, 2, 1, "", "update_state"], [156, 2, 1, "", "update_state_constants"], [156, 2, 1, "", "validate_class"], [156, 2, 1, "", "warning"]], "engforge.eng.thermodynamics.SimpleTurbine": [[157, 3, 1, "", "Ut_ref"], [157, 3, 1, "", "Xt_ref"], [157, 3, 1, "", "Yt_ref"], [157, 2, 1, "", "add_fields"], [157, 3, 1, "", "anything_changed"], [157, 3, 1, "", "as_dict"], [157, 2, 1, "", "check_ref_slot_type"], [157, 3, 1, "", "classname"], [157, 2, 1, "", "cls_compile"], [157, 2, 1, "", "collect_all_attributes"], [157, 2, 1, "", "collect_comp_refs"], [157, 2, 1, "", "collect_dynamic_refs"], [157, 2, 1, "", "collect_inst_attributes"], [157, 2, 1, "", "collect_post_update_refs"], [157, 2, 1, "", "collect_solver_refs"], [157, 2, 1, "", "collect_update_refs"], [157, 2, 1, "", "comp_references"], [157, 2, 1, "", "compile_classes"], [157, 2, 1, "", "copy_config_at_state"], [157, 2, 1, "", "create_dynamic_matricies"], [157, 2, 1, "", "create_feedthrough_matrix"], [157, 2, 1, "", "create_input_matrix"], [157, 2, 1, "", "create_output_constants"], [157, 2, 1, "", "create_output_matrix"], [157, 2, 1, "", "create_state_constants"], [157, 2, 1, "", "create_state_matrix"], [157, 2, 1, "", "critical"], [157, 3, 1, "", "dXtdt_ref"], [157, 3, 1, "", "data_dict"], [157, 2, 1, "", "debug"], [157, 2, 1, "", "determine_nearest_stationary_state"], [157, 2, 1, "", "difference"], [157, 2, 1, "", "error"], [157, 3, 1, "", "filename"], [157, 2, 1, "", "filter"], [157, 2, 1, "", "get_system_input_refs"], [157, 2, 1, "", "go_through_configurations"], [157, 3, 1, "", "identity"], [157, 2, 1, "", "info"], [157, 3, 1, "", "input_as_dict"], [157, 2, 1, "", "input_fields"], [157, 2, 1, "", "installSTDLogger"], [157, 2, 1, "", "internal_components"], [157, 2, 1, "", "internal_configurations"], [157, 2, 1, "", "internal_references"], [157, 2, 1, "", "internal_systems"], [157, 2, 1, "", "internal_tabulations"], [157, 3, 1, "", "last_context"], [157, 2, 1, "", "linear_output"], [157, 2, 1, "", "linear_step"], [157, 2, 1, "", "locate"], [157, 2, 1, "", "locate_ref"], [157, 2, 1, "", "message_with_identiy"], [157, 2, 1, "", "msg"], [157, 2, 1, "", "nonlinear_output"], [157, 2, 1, "", "nonlinear_step"], [157, 2, 1, "", "parent_configurations_cls"], [157, 2, 1, "", "parse_run_kwargs"], [157, 2, 1, "", "parse_simulation_input"], [157, 2, 1, "", "plot_attributes"], [157, 3, 1, "", "plotable_variables"], [157, 2, 1, "", "post_update"], [157, 2, 1, "", "pre_compile"], [157, 2, 1, "", "rate"], [157, 2, 1, "", "rate_linear"], [157, 2, 1, "", "rate_nonlinear"], [157, 2, 1, "", "ref_dXdt"], [157, 2, 1, "", "resetLog"], [157, 2, 1, "", "resetSystemLogs"], [157, 2, 1, "", "set_time"], [157, 2, 1, "", "setattrs"], [157, 2, 1, "", "signals_attributes"], [157, 3, 1, "", "skip_plot_vars"], [157, 2, 1, "", "slot_refs"], [157, 2, 1, "", "slots_attributes"], [157, 2, 1, "", "smart_split_dataframe"], [157, 2, 1, "", "solvers_attributes"], [157, 2, 1, "", "subclasses"], [157, 2, 1, "", "subcls_compile"], [157, 3, 1, "", "system_id"], [157, 2, 1, "", "system_properties_classdef"], [157, 2, 1, "", "system_references"], [157, 2, 1, "", "trace_attributes"], [157, 2, 1, "", "transients_attributes"], [157, 2, 1, "", "update"], [157, 2, 1, "", "update_dynamics"], [157, 2, 1, "", "update_feedthrough"], [157, 2, 1, "", "update_input"], [157, 2, 1, "", "update_output_constants"], [157, 2, 1, "", "update_output_matrix"], [157, 2, 1, "", "update_state"], [157, 2, 1, "", "update_state_constants"], [157, 2, 1, "", "validate_class"], [157, 2, 1, "", "warning"]], "engforge.engforge_attributes": [[164, 1, 1, "", "AttributedBaseMixin"], [165, 1, 1, "", "EngAttr"], [166, 4, 1, "", "get_attributes_of"]], "engforge.engforge_attributes.AttributedBaseMixin": [[164, 2, 1, "", "add_fields"], [164, 3, 1, "", "as_dict"], [164, 2, 1, "", "check_ref_slot_type"], [164, 2, 1, "", "collect_all_attributes"], [164, 2, 1, "", "collect_inst_attributes"], [164, 2, 1, "", "critical"], [164, 2, 1, "", "debug"], [164, 2, 1, "", "difference"], [164, 2, 1, "", "error"], [164, 2, 1, "", "filter"], [164, 2, 1, "", "info"], [164, 3, 1, "", "input_as_dict"], [164, 2, 1, "", "input_fields"], [164, 2, 1, "", "installSTDLogger"], [164, 2, 1, "", "message_with_identiy"], [164, 2, 1, "", "msg"], [164, 2, 1, "", "plot_attributes"], [164, 2, 1, "", "resetLog"], [164, 2, 1, "", "resetSystemLogs"], [164, 2, 1, "", "setattrs"], [164, 2, 1, "", "signals_attributes"], [164, 2, 1, "", "slot_refs"], [164, 2, 1, "", "slots_attributes"], [164, 2, 1, "", "solvers_attributes"], [164, 2, 1, "", "trace_attributes"], [164, 2, 1, "", "transients_attributes"], [164, 2, 1, "", "warning"]], "engforge.engforge_attributes.EngAttr": [[165, 2, 1, "", "add_fields"], [165, 2, 1, "", "critical"], [165, 2, 1, "", "debug"], [165, 2, 1, "", "error"], [165, 2, 1, "", "filter"], [165, 2, 1, "", "info"], [165, 2, 1, "", "installSTDLogger"], [165, 2, 1, "", "message_with_identiy"], [165, 2, 1, "", "msg"], [165, 2, 1, "", "resetLog"], [165, 2, 1, "", "resetSystemLogs"], [165, 2, 1, "", "warning"]], "engforge.env_var": [[168, 1, 1, "", "EnvVariable"], [169, 4, 1, "", "parse_bool"]], "engforge.env_var.EnvVariable": [[168, 2, 1, "", "add_fields"], [168, 2, 1, "", "critical"], [168, 2, 1, "", "debug"], [168, 2, 1, "", "error"], [168, 2, 1, "", "filter"], [168, 2, 1, "", "info"], [168, 2, 1, "", "installSTDLogger"], [168, 2, 1, "", "message_with_identiy"], [168, 2, 1, "", "msg"], [168, 2, 1, "", "print_env_vars"], [168, 2, 1, "", "remove"], [168, 2, 1, "", "resetLog"], [168, 2, 1, "", "resetSystemLogs"], [168, 2, 1, "", "warning"]], "engforge.locations": [[171, 4, 1, "", "client_path"]], "engforge.logging": [[173, 1, 1, "", "Log"], [174, 1, 1, "", "LoggingMixin"], [175, 4, 1, "", "change_all_log_levels"]], "engforge.logging.Log": [[173, 2, 1, "", "add_fields"], [173, 2, 1, "", "critical"], [173, 2, 1, "", "debug"], [173, 2, 1, "", "error"], [173, 2, 1, "", "filter"], [173, 2, 1, "", "info"], [173, 2, 1, "", "installSTDLogger"], [173, 2, 1, "", "message_with_identiy"], [173, 2, 1, "", "msg"], [173, 2, 1, "", "resetLog"], [173, 2, 1, "", "resetSystemLogs"], [173, 2, 1, "", "warning"]], "engforge.logging.LoggingMixin": [[174, 2, 1, "", "add_fields"], [174, 2, 1, "", "critical"], [174, 2, 1, "", "debug"], [174, 2, 1, "", "error"], [174, 2, 1, "", "filter"], [174, 2, 1, "", "info"], [174, 2, 1, "", "installSTDLogger"], [174, 2, 1, "", "message_with_identiy"], [174, 2, 1, "", "msg"], [174, 2, 1, "", "resetLog"], [174, 2, 1, "", "resetSystemLogs"], [174, 2, 1, "", "warning"]], "engforge.patterns": [[177, 1, 1, "", "InputSingletonMeta"], [178, 1, 1, "", "Singleton"], [179, 1, 1, "", "SingletonMeta"], [180, 4, 1, "", "chunks"], [181, 4, 1, "", "flat2gen"], [182, 4, 1, "", "flatten"], [183, 1, 1, "", "inst_vectorize"], [184, 4, 1, "", "singleton_meta_object"]], "engforge.patterns.InputSingletonMeta": [[177, 2, 1, "", "__call__"], [177, 2, 1, "", "mro"]], "engforge.patterns.Singleton": [[178, 2, 1, "", "__call__"], [178, 2, 1, "", "instance"]], "engforge.patterns.SingletonMeta": [[179, 2, 1, "", "__call__"], [179, 2, 1, "", "mro"]], "engforge.patterns.inst_vectorize": [[183, 2, 1, "", "__call__"]], "engforge.problem_context": [[186, 6, 1, "", "IllegalArgument"], [187, 1, 1, "", "ProbLog"], [188, 1, 1, "", "Problem"], [189, 1, 1, "", "ProblemExec"], [190, 6, 1, "", "ProblemExit"], [191, 6, 1, "", "ProblemExitAtLevel"]], "engforge.problem_context.ProbLog": [[187, 2, 1, "", "add_fields"], [187, 2, 1, "", "critical"], [187, 2, 1, "", "debug"], [187, 2, 1, "", "error"], [187, 2, 1, "", "filter"], [187, 2, 1, "", "info"], [187, 2, 1, "", "installSTDLogger"], [187, 2, 1, "", "message_with_identiy"], [187, 2, 1, "", "msg"], [187, 2, 1, "", "resetLog"], [187, 2, 1, "", "resetSystemLogs"], [187, 2, 1, "", "warning"]], "engforge.problem_context.Problem": [[188, 3, 1, "", "all_components"], [188, 3, 1, "", "all_comps"], [188, 3, 1, "", "all_problem_vars"], [188, 3, 1, "", "all_variables"], [188, 2, 1, "", "apply_post_signals"], [188, 2, 1, "", "apply_pre_signals"], [188, 5, 1, "", "class_cache"], [188, 3, 1, "", "dataframe"], [188, 2, 1, "", "debug_levels"], [188, 2, 1, "", "discard_contexts"], [188, 3, 1, "", "dynamic_solve"], [188, 2, 1, "", "error_action"], [188, 2, 1, "", "establish_system"], [188, 2, 1, "", "exit_action"], [188, 2, 1, "", "filter_vars"], [188, 3, 1, "", "final_objectives"], [188, 2, 1, "", "get_extra_kws"], [188, 2, 1, "", "get_parent_key"], [188, 2, 1, "", "get_ref_values"], [188, 2, 1, "", "get_sesh"], [188, 2, 1, "", "integral_rate"], [188, 3, 1, "", "integrator_rate_refs"], [188, 3, 1, "", "integrator_var_refs"], [188, 3, 1, "", "is_active"], [188, 3, 1, "", "kwargs"], [188, 3, 1, "", "output_state"], [188, 2, 1, "", "parse_default"], [188, 2, 1, "", "persist_contexts"], [188, 2, 1, "", "pos_obj"], [188, 2, 1, "", "post_execute"], [188, 2, 1, "", "post_update_system"], [188, 2, 1, "", "pre_execute"], [188, 3, 1, "", "problem_opt_vars"], [188, 3, 1, "", "record_state"], [188, 2, 1, "", "refresh_references"], [188, 2, 1, "", "reset_contexts"], [188, 2, 1, "", "reset_data"], [188, 2, 1, "", "save_data"], [188, 3, 1, "", "sesh"], [188, 2, 1, "", "set_checkpoint"], [188, 2, 1, "", "set_ref_values"], [188, 3, 1, "", "skip_plot_vars"], [188, 2, 1, "", "smart_split_dataframe"], [188, 2, 1, "", "solve_min"], [188, 3, 1, "", "solveable"], [188, 2, 1, "", "sys_solver_constraints"], [188, 2, 1, "", "sys_solver_objectives"], [188, 2, 1, "", "update_system"]], "engforge.problem_context.ProblemExec": [[189, 3, 1, "", "all_components"], [189, 3, 1, "", "all_comps"], [189, 3, 1, "", "all_problem_vars"], [189, 3, 1, "", "all_variables"], [189, 2, 1, "", "apply_post_signals"], [189, 2, 1, "", "apply_pre_signals"], [189, 5, 1, "", "class_cache"], [189, 3, 1, "", "dataframe"], [189, 2, 1, "", "debug_levels"], [189, 2, 1, "", "discard_contexts"], [189, 3, 1, "", "dynamic_solve"], [189, 2, 1, "", "error_action"], [189, 2, 1, "", "establish_system"], [189, 2, 1, "", "exit_action"], [189, 2, 1, "", "filter_vars"], [189, 3, 1, "", "final_objectives"], [189, 2, 1, "", "get_extra_kws"], [189, 2, 1, "", "get_parent_key"], [189, 2, 1, "", "get_ref_values"], [189, 2, 1, "", "get_sesh"], [189, 2, 1, "", "integral_rate"], [189, 3, 1, "", "integrator_rate_refs"], [189, 3, 1, "", "integrator_var_refs"], [189, 3, 1, "", "is_active"], [189, 3, 1, "", "kwargs"], [189, 3, 1, "", "output_state"], [189, 2, 1, "", "parse_default"], [189, 2, 1, "", "persist_contexts"], [189, 2, 1, "", "pos_obj"], [189, 2, 1, "", "post_execute"], [189, 2, 1, "", "post_update_system"], [189, 2, 1, "", "pre_execute"], [189, 3, 1, "", "problem_opt_vars"], [189, 3, 1, "", "record_state"], [189, 2, 1, "", "refresh_references"], [189, 2, 1, "", "reset_contexts"], [189, 2, 1, "", "reset_data"], [189, 2, 1, "", "save_data"], [189, 3, 1, "", "sesh"], [189, 2, 1, "", "set_checkpoint"], [189, 2, 1, "", "set_ref_values"], [189, 2, 1, "", "solve_min"], [189, 3, 1, "", "solveable"], [189, 2, 1, "", "sys_solver_constraints"], [189, 2, 1, "", "sys_solver_objectives"], [189, 2, 1, "", "update_system"]], "engforge.properties": [[193, 1, 1, "", "PropertyLog"], [194, 1, 1, "", "cache_prop"], [195, 5, 1, "", "cached_sys_prop"], [196, 5, 1, "", "cached_system_prop"], [197, 1, 1, "", "cached_system_property"], [198, 1, 1, "", "class_cache"], [199, 1, 1, "", "engforge_prop"], [200, 1, 1, "", "instance_cached"], [201, 1, 1, "", "solver_cached"], [202, 5, 1, "", "sys_prop"], [203, 5, 1, "", "system_prop"], [204, 1, 1, "", "system_property"]], "engforge.properties.PropertyLog": [[193, 2, 1, "", "add_fields"], [193, 2, 1, "", "critical"], [193, 2, 1, "", "debug"], [193, 2, 1, "", "error"], [193, 2, 1, "", "filter"], [193, 2, 1, "", "info"], [193, 2, 1, "", "installSTDLogger"], [193, 2, 1, "", "message_with_identiy"], [193, 2, 1, "", "msg"], [193, 2, 1, "", "resetLog"], [193, 2, 1, "", "resetSystemLogs"], [193, 2, 1, "", "warning"]], "engforge.properties.cache_prop": [[194, 2, 1, "", "__call__"], [194, 2, 1, "", "get_func_return"]], "engforge.properties.cached_system_property": [[197, 2, 1, "", "__call__"], [197, 2, 1, "", "get_func_return"]], "engforge.properties.class_cache": [[198, 2, 1, "", "__call__"], [198, 2, 1, "", "get_func_return"]], "engforge.properties.engforge_prop": [[199, 2, 1, "", "__call__"], [199, 2, 1, "", "get_func_return"]], "engforge.properties.instance_cached": [[200, 2, 1, "", "__call__"], [200, 2, 1, "", "get_func_return"]], "engforge.properties.solver_cached": [[201, 2, 1, "", "__call__"], [201, 2, 1, "", "get_func_return"]], "engforge.properties.system_property": [[204, 2, 1, "", "__call__"], [204, 2, 1, "", "get_func_return"]], "engforge.reporting": [[206, 1, 1, "", "CSVReporter"], [207, 1, 1, "", "DiskPlotReporter"], [208, 1, 1, "", "DiskReporterMixin"], [209, 1, 1, "", "ExcelReporter"], [210, 1, 1, "", "GdriveReporter"], [211, 1, 1, "", "GsheetsReporter"], [212, 1, 1, "", "PlotReporter"], [213, 1, 1, "", "Reporter"], [214, 1, 1, "", "TableReporter"], [215, 1, 1, "", "TemporalReporterMixin"], [216, 4, 1, "", "path_exist_validator"]], "engforge.reporting.CSVReporter": [[206, 2, 1, "", "add_fields"], [206, 2, 1, "", "check_config"], [206, 2, 1, "", "critical"], [206, 2, 1, "", "debug"], [206, 2, 1, "", "error"], [206, 2, 1, "", "filter"], [206, 2, 1, "", "info"], [206, 2, 1, "", "installSTDLogger"], [206, 2, 1, "", "message_with_identiy"], [206, 2, 1, "", "msg"], [206, 3, 1, "", "report_root"], [206, 2, 1, "", "resetLog"], [206, 2, 1, "", "resetSystemLogs"], [206, 2, 1, "", "subclasses"], [206, 2, 1, "", "warning"]], "engforge.reporting.DiskPlotReporter": [[207, 2, 1, "", "add_fields"], [207, 2, 1, "", "check_config"], [207, 2, 1, "", "critical"], [207, 2, 1, "", "debug"], [207, 2, 1, "", "error"], [207, 2, 1, "", "filter"], [207, 2, 1, "", "info"], [207, 2, 1, "", "installSTDLogger"], [207, 2, 1, "", "message_with_identiy"], [207, 2, 1, "", "msg"], [207, 3, 1, "", "report_root"], [207, 2, 1, "", "resetLog"], [207, 2, 1, "", "resetSystemLogs"], [207, 2, 1, "", "subclasses"], [207, 2, 1, "", "warning"]], "engforge.reporting.DiskReporterMixin": [[208, 2, 1, "", "add_fields"], [208, 2, 1, "", "check_config"], [208, 2, 1, "", "critical"], [208, 2, 1, "", "debug"], [208, 2, 1, "", "error"], [208, 2, 1, "", "filter"], [208, 2, 1, "", "info"], [208, 2, 1, "", "installSTDLogger"], [208, 2, 1, "", "message_with_identiy"], [208, 2, 1, "", "msg"], [208, 3, 1, "", "report_root"], [208, 2, 1, "", "resetLog"], [208, 2, 1, "", "resetSystemLogs"], [208, 2, 1, "", "subclasses"], [208, 2, 1, "", "warning"]], "engforge.reporting.ExcelReporter": [[209, 2, 1, "", "add_fields"], [209, 2, 1, "", "check_config"], [209, 2, 1, "", "critical"], [209, 2, 1, "", "debug"], [209, 2, 1, "", "error"], [209, 2, 1, "", "filter"], [209, 2, 1, "", "info"], [209, 2, 1, "", "installSTDLogger"], [209, 2, 1, "", "message_with_identiy"], [209, 2, 1, "", "msg"], [209, 3, 1, "", "report_root"], [209, 2, 1, "", "resetLog"], [209, 2, 1, "", "resetSystemLogs"], [209, 2, 1, "", "subclasses"], [209, 2, 1, "", "warning"]], "engforge.reporting.GdriveReporter": [[210, 2, 1, "", "add_fields"], [210, 2, 1, "", "check_config"], [210, 2, 1, "", "critical"], [210, 2, 1, "", "debug"], [210, 2, 1, "", "error"], [210, 2, 1, "", "filter"], [210, 2, 1, "", "info"], [210, 2, 1, "", "installSTDLogger"], [210, 2, 1, "", "message_with_identiy"], [210, 2, 1, "", "msg"], [210, 3, 1, "", "report_root"], [210, 2, 1, "", "resetLog"], [210, 2, 1, "", "resetSystemLogs"], [210, 2, 1, "", "subclasses"], [210, 2, 1, "", "warning"]], "engforge.reporting.GsheetsReporter": [[211, 2, 1, "", "add_fields"], [211, 2, 1, "", "check_config"], [211, 2, 1, "", "critical"], [211, 2, 1, "", "debug"], [211, 2, 1, "", "error"], [211, 2, 1, "", "filter"], [211, 2, 1, "", "info"], [211, 2, 1, "", "installSTDLogger"], [211, 2, 1, "", "message_with_identiy"], [211, 2, 1, "", "msg"], [211, 3, 1, "", "report_root"], [211, 2, 1, "", "resetLog"], [211, 2, 1, "", "resetSystemLogs"], [211, 2, 1, "", "subclasses"], [211, 2, 1, "", "warning"]], "engforge.reporting.PlotReporter": [[212, 2, 1, "", "add_fields"], [212, 2, 1, "", "check_config"], [212, 2, 1, "", "critical"], [212, 2, 1, "", "debug"], [212, 2, 1, "", "error"], [212, 2, 1, "", "filter"], [212, 2, 1, "", "info"], [212, 2, 1, "", "installSTDLogger"], [212, 2, 1, "", "message_with_identiy"], [212, 2, 1, "", "msg"], [212, 2, 1, "", "resetLog"], [212, 2, 1, "", "resetSystemLogs"], [212, 2, 1, "", "subclasses"], [212, 2, 1, "", "warning"]], "engforge.reporting.Reporter": [[213, 2, 1, "", "add_fields"], [213, 2, 1, "", "check_config"], [213, 2, 1, "", "critical"], [213, 2, 1, "", "debug"], [213, 2, 1, "", "error"], [213, 2, 1, "", "filter"], [213, 2, 1, "", "info"], [213, 2, 1, "", "installSTDLogger"], [213, 2, 1, "", "message_with_identiy"], [213, 2, 1, "", "msg"], [213, 2, 1, "", "resetLog"], [213, 2, 1, "", "resetSystemLogs"], [213, 2, 1, "", "subclasses"], [213, 2, 1, "", "warning"]], "engforge.reporting.TableReporter": [[214, 2, 1, "", "add_fields"], [214, 2, 1, "", "check_config"], [214, 2, 1, "", "critical"], [214, 2, 1, "", "debug"], [214, 2, 1, "", "error"], [214, 2, 1, "", "filter"], [214, 2, 1, "", "info"], [214, 2, 1, "", "installSTDLogger"], [214, 2, 1, "", "message_with_identiy"], [214, 2, 1, "", "msg"], [214, 2, 1, "", "resetLog"], [214, 2, 1, "", "resetSystemLogs"], [214, 2, 1, "", "subclasses"], [214, 2, 1, "", "warning"]], "engforge.reporting.TemporalReporterMixin": [[215, 2, 1, "", "add_fields"], [215, 2, 1, "", "check_config"], [215, 2, 1, "", "critical"], [215, 2, 1, "", "debug"], [215, 2, 1, "", "error"], [215, 2, 1, "", "filter"], [215, 2, 1, "", "info"], [215, 2, 1, "", "installSTDLogger"], [215, 2, 1, "", "message_with_identiy"], [215, 2, 1, "", "msg"], [215, 3, 1, "", "report_root"], [215, 2, 1, "", "resetLog"], [215, 2, 1, "", "resetSystemLogs"], [215, 2, 1, "", "subclasses"], [215, 2, 1, "", "warning"]], "engforge.solveable": [[218, 1, 1, "", "SolvableLog"], [219, 1, 1, "", "SolveableMixin"]], "engforge.solveable.SolvableLog": [[218, 2, 1, "", "add_fields"], [218, 2, 1, "", "critical"], [218, 2, 1, "", "debug"], [218, 2, 1, "", "error"], [218, 2, 1, "", "filter"], [218, 2, 1, "", "info"], [218, 2, 1, "", "installSTDLogger"], [218, 2, 1, "", "message_with_identiy"], [218, 2, 1, "", "msg"], [218, 2, 1, "", "resetLog"], [218, 2, 1, "", "resetSystemLogs"], [218, 2, 1, "", "warning"]], "engforge.solveable.SolveableMixin": [[219, 2, 1, "", "add_fields"], [219, 3, 1, "", "as_dict"], [219, 2, 1, "", "check_ref_slot_type"], [219, 2, 1, "", "collect_all_attributes"], [219, 2, 1, "", "collect_comp_refs"], [219, 2, 1, "", "collect_dynamic_refs"], [219, 2, 1, "", "collect_inst_attributes"], [219, 2, 1, "", "collect_post_update_refs"], [219, 2, 1, "", "collect_solver_refs"], [219, 2, 1, "", "collect_update_refs"], [219, 2, 1, "", "comp_references"], [219, 2, 1, "", "critical"], [219, 2, 1, "", "debug"], [219, 2, 1, "", "difference"], [219, 2, 1, "", "error"], [219, 2, 1, "", "filter"], [219, 2, 1, "", "get_system_input_refs"], [219, 2, 1, "", "info"], [219, 3, 1, "", "input_as_dict"], [219, 2, 1, "", "input_fields"], [219, 2, 1, "", "installSTDLogger"], [219, 2, 1, "", "internal_components"], [219, 2, 1, "", "internal_references"], [219, 2, 1, "", "internal_systems"], [219, 2, 1, "", "internal_tabulations"], [219, 2, 1, "", "locate"], [219, 2, 1, "", "locate_ref"], [219, 2, 1, "", "message_with_identiy"], [219, 2, 1, "", "msg"], [219, 2, 1, "", "parse_run_kwargs"], [219, 2, 1, "", "parse_simulation_input"], [219, 2, 1, "", "plot_attributes"], [219, 2, 1, "", "post_update"], [219, 2, 1, "", "resetLog"], [219, 2, 1, "", "resetSystemLogs"], [219, 2, 1, "", "setattrs"], [219, 2, 1, "", "signals_attributes"], [219, 2, 1, "", "slot_refs"], [219, 2, 1, "", "slots_attributes"], [219, 2, 1, "", "solvers_attributes"], [219, 2, 1, "", "system_references"], [219, 2, 1, "", "trace_attributes"], [219, 2, 1, "", "transients_attributes"], [219, 2, 1, "", "update"], [219, 2, 1, "", "warning"]], "engforge.solver": [[221, 1, 1, "", "SolverLog"], [222, 1, 1, "", "SolverMixin"]], "engforge.solver.SolverLog": [[221, 2, 1, "", "add_fields"], [221, 2, 1, "", "critical"], [221, 2, 1, "", "debug"], [221, 2, 1, "", "error"], [221, 2, 1, "", "filter"], [221, 2, 1, "", "info"], [221, 2, 1, "", "installSTDLogger"], [221, 2, 1, "", "message_with_identiy"], [221, 2, 1, "", "msg"], [221, 2, 1, "", "resetLog"], [221, 2, 1, "", "resetSystemLogs"], [221, 2, 1, "", "warning"]], "engforge.solver.SolverMixin": [[222, 2, 1, "", "add_fields"], [222, 3, 1, "", "as_dict"], [222, 2, 1, "", "check_ref_slot_type"], [222, 2, 1, "", "collect_all_attributes"], [222, 2, 1, "", "collect_comp_refs"], [222, 2, 1, "", "collect_dynamic_refs"], [222, 2, 1, "", "collect_inst_attributes"], [222, 2, 1, "", "collect_post_update_refs"], [222, 2, 1, "", "collect_solver_refs"], [222, 2, 1, "", "collect_update_refs"], [222, 2, 1, "", "comp_references"], [222, 2, 1, "", "critical"], [222, 2, 1, "", "debug"], [222, 2, 1, "", "difference"], [222, 2, 1, "", "error"], [222, 2, 1, "", "eval"], [222, 2, 1, "", "execute"], [222, 2, 1, "", "filter"], [222, 2, 1, "", "get_system_input_refs"], [222, 2, 1, "", "info"], [222, 3, 1, "", "input_as_dict"], [222, 2, 1, "", "input_fields"], [222, 2, 1, "", "installSTDLogger"], [222, 2, 1, "", "internal_components"], [222, 2, 1, "", "internal_references"], [222, 2, 1, "", "internal_systems"], [222, 2, 1, "", "internal_tabulations"], [222, 2, 1, "", "locate"], [222, 2, 1, "", "locate_ref"], [222, 2, 1, "", "message_with_identiy"], [222, 2, 1, "", "msg"], [222, 2, 1, "", "parse_run_kwargs"], [222, 2, 1, "", "parse_simulation_input"], [222, 2, 1, "", "plot_attributes"], [222, 2, 1, "", "post_run_callback"], [222, 2, 1, "", "post_update"], [222, 2, 1, "", "pre_run_callback"], [222, 2, 1, "", "resetLog"], [222, 2, 1, "", "resetSystemLogs"], [222, 2, 1, "", "run"], [222, 2, 1, "", "run_internal_systems"], [222, 2, 1, "", "setattrs"], [222, 2, 1, "", "signals_attributes"], [222, 2, 1, "", "slot_refs"], [222, 2, 1, "", "slots_attributes"], [222, 2, 1, "", "solver"], [222, 2, 1, "", "solver_vars"], [222, 2, 1, "", "solvers_attributes"], [222, 2, 1, "", "system_references"], [222, 2, 1, "", "trace_attributes"], [222, 2, 1, "", "transients_attributes"], [222, 2, 1, "", "update"], [222, 2, 1, "", "warning"]], "engforge.solver_utils": [[224, 1, 1, "", "SolverUtilLog"], [225, 4, 1, "", "arg_var_compare"], [226, 4, 1, "", "combo_filter"], [227, 4, 1, "", "create_constraint"], [228, 4, 1, "", "ext_str_list"], [229, 4, 1, "", "f_lin_min"], [230, 4, 1, "", "filt_active"], [231, 4, 1, "", "filter_combos"], [232, 4, 1, "", "filter_vals"], [233, 4, 1, "", "handle_normalize"], [234, 4, 1, "", "objectify"], [235, 4, 1, "", "ref_to_val_constraint"], [236, 4, 1, "", "refmin_solve"], [237, 4, 1, "", "secondary_obj"], [238, 4, 1, "", "str_list_f"]], "engforge.solver_utils.SolverUtilLog": [[224, 2, 1, "", "add_fields"], [224, 2, 1, "", "critical"], [224, 2, 1, "", "debug"], [224, 2, 1, "", "error"], [224, 2, 1, "", "filter"], [224, 2, 1, "", "info"], [224, 2, 1, "", "installSTDLogger"], [224, 2, 1, "", "message_with_identiy"], [224, 2, 1, "", "msg"], [224, 2, 1, "", "resetLog"], [224, 2, 1, "", "resetSystemLogs"], [224, 2, 1, "", "warning"]], "engforge.system": [[240, 1, 1, "", "System"], [241, 1, 1, "", "SystemsLog"]], "engforge.system.System": [[240, 3, 1, "", "Ut_ref"], [240, 3, 1, "", "Xt_ref"], [240, 3, 1, "", "Yt_ref"], [240, 2, 1, "", "add_fields"], [240, 3, 1, "", "anything_changed"], [240, 3, 1, "", "as_dict"], [240, 2, 1, "", "check_ref_slot_type"], [240, 3, 1, "", "classname"], [240, 2, 1, "", "clone"], [240, 2, 1, "", "cls_compile"], [240, 2, 1, "", "collect_all_attributes"], [240, 2, 1, "", "collect_comp_refs"], [240, 2, 1, "", "collect_dynamic_refs"], [240, 2, 1, "", "collect_inst_attributes"], [240, 2, 1, "", "collect_post_update_refs"], [240, 2, 1, "", "collect_solver_refs"], [240, 2, 1, "", "collect_update_refs"], [240, 2, 1, "", "comp_references"], [240, 2, 1, "", "compile_classes"], [240, 2, 1, "", "copy_config_at_state"], [240, 2, 1, "", "create_dynamic_matricies"], [240, 2, 1, "", "create_feedthrough_matrix"], [240, 2, 1, "", "create_input_matrix"], [240, 2, 1, "", "create_output_constants"], [240, 2, 1, "", "create_output_matrix"], [240, 2, 1, "", "create_state_constants"], [240, 2, 1, "", "create_state_matrix"], [240, 2, 1, "", "critical"], [240, 3, 1, "", "dXtdt_ref"], [240, 2, 1, "", "debug"], [240, 2, 1, "", "determine_nearest_stationary_state"], [240, 2, 1, "", "difference"], [240, 2, 1, "", "error"], [240, 2, 1, "", "eval"], [240, 2, 1, "", "execute"], [240, 3, 1, "", "filename"], [240, 2, 1, "", "filter"], [240, 2, 1, "", "get_system_input_refs"], [240, 2, 1, "", "go_through_configurations"], [240, 3, 1, "", "identity"], [240, 2, 1, "", "info"], [240, 3, 1, "", "input_as_dict"], [240, 2, 1, "", "input_fields"], [240, 2, 1, "", "installSTDLogger"], [240, 2, 1, "", "internal_components"], [240, 2, 1, "", "internal_configurations"], [240, 2, 1, "", "internal_references"], [240, 2, 1, "", "internal_systems"], [240, 2, 1, "", "internal_tabulations"], [240, 3, 1, "", "last_context"], [240, 2, 1, "", "linear_output"], [240, 2, 1, "", "linear_step"], [240, 2, 1, "", "locate"], [240, 2, 1, "", "locate_ref"], [240, 2, 1, "", "make_plots"], [240, 2, 1, "", "mark_all_comps_changed"], [240, 2, 1, "", "message_with_identiy"], [240, 2, 1, "", "msg"], [240, 2, 1, "", "nonlinear_output"], [240, 2, 1, "", "nonlinear_step"], [240, 2, 1, "", "parent_configurations_cls"], [240, 2, 1, "", "parse_run_kwargs"], [240, 2, 1, "", "parse_simulation_input"], [240, 2, 1, "", "plot_attributes"], [240, 3, 1, "", "plotable_variables"], [240, 2, 1, "", "post_run_callback"], [240, 2, 1, "", "post_update"], [240, 2, 1, "", "pre_compile"], [240, 2, 1, "", "pre_run_callback"], [240, 2, 1, "", "rate"], [240, 2, 1, "", "rate_linear"], [240, 2, 1, "", "rate_nonlinear"], [240, 2, 1, "", "ref_dXdt"], [240, 2, 1, "", "resetLog"], [240, 2, 1, "", "resetSystemLogs"], [240, 2, 1, "", "run"], [240, 2, 1, "", "run_internal_systems"], [240, 2, 1, "", "set_time"], [240, 2, 1, "", "setattrs"], [240, 2, 1, "", "setup_global_dynamics"], [240, 2, 1, "", "signals_attributes"], [240, 2, 1, "", "sim_matrix"], [240, 2, 1, "", "simulate"], [240, 3, 1, "", "skip_plot_vars"], [240, 2, 1, "", "slot_refs"], [240, 2, 1, "", "slots_attributes"], [240, 2, 1, "", "smart_split_dataframe"], [240, 2, 1, "", "solver"], [240, 2, 1, "", "solver_vars"], [240, 2, 1, "", "solvers_attributes"], [240, 2, 1, "", "subclasses"], [240, 2, 1, "", "subcls_compile"], [240, 3, 1, "", "system_id"], [240, 2, 1, "", "system_properties_classdef"], [240, 2, 1, "", "system_references"], [240, 2, 1, "", "trace_attributes"], [240, 2, 1, "", "transients_attributes"], [240, 2, 1, "", "update"], [240, 2, 1, "", "update_dynamics"], [240, 2, 1, "", "update_feedthrough"], [240, 2, 1, "", "update_input"], [240, 2, 1, "", "update_output_constants"], [240, 2, 1, "", "update_output_matrix"], [240, 2, 1, "", "update_state"], [240, 2, 1, "", "update_state_constants"], [240, 2, 1, "", "validate_class"], [240, 2, 1, "", "warning"]], "engforge.system.SystemsLog": [[241, 2, 1, "", "add_fields"], [241, 2, 1, "", "critical"], [241, 2, 1, "", "debug"], [241, 2, 1, "", "error"], [241, 2, 1, "", "filter"], [241, 2, 1, "", "info"], [241, 2, 1, "", "installSTDLogger"], [241, 2, 1, "", "message_with_identiy"], [241, 2, 1, "", "msg"], [241, 2, 1, "", "resetLog"], [241, 2, 1, "", "resetSystemLogs"], [241, 2, 1, "", "warning"]], "engforge.system_reference": [[243, 1, 1, "", "Ref"], [244, 1, 1, "", "RefLog"], [245, 4, 1, "", "eval_ref"], [246, 4, 1, "", "maybe_attr_inst"], [247, 4, 1, "", "maybe_ref"], [248, 4, 1, "", "refset_get"], [249, 4, 1, "", "refset_input"], [250, 4, 1, "", "scale_val"]], "engforge.system_reference.Ref": [[243, 2, 1, "", "copy"], [243, 2, 1, "", "refset_input"], [243, 2, 1, "", "setup_calls"]], "engforge.system_reference.RefLog": [[244, 2, 1, "", "add_fields"], [244, 2, 1, "", "critical"], [244, 2, 1, "", "debug"], [244, 2, 1, "", "error"], [244, 2, 1, "", "filter"], [244, 2, 1, "", "info"], [244, 2, 1, "", "installSTDLogger"], [244, 2, 1, "", "message_with_identiy"], [244, 2, 1, "", "msg"], [244, 2, 1, "", "resetLog"], [244, 2, 1, "", "resetSystemLogs"], [244, 2, 1, "", "warning"]], "engforge.tabulation": [[252, 1, 1, "", "TableLog"], [253, 1, 1, "", "TabulationMixin"]], "engforge.tabulation.TableLog": [[252, 2, 1, "", "add_fields"], [252, 2, 1, "", "critical"], [252, 2, 1, "", "debug"], [252, 2, 1, "", "error"], [252, 2, 1, "", "filter"], [252, 2, 1, "", "info"], [252, 2, 1, "", "installSTDLogger"], [252, 2, 1, "", "message_with_identiy"], [252, 2, 1, "", "msg"], [252, 2, 1, "", "resetLog"], [252, 2, 1, "", "resetSystemLogs"], [252, 2, 1, "", "warning"]], "engforge.tabulation.TabulationMixin": [[253, 2, 1, "", "add_fields"], [253, 3, 1, "", "anything_changed"], [253, 3, 1, "", "as_dict"], [253, 2, 1, "", "check_ref_slot_type"], [253, 2, 1, "", "collect_all_attributes"], [253, 2, 1, "", "collect_comp_refs"], [253, 2, 1, "", "collect_dynamic_refs"], [253, 2, 1, "", "collect_inst_attributes"], [253, 2, 1, "", "collect_post_update_refs"], [253, 2, 1, "", "collect_solver_refs"], [253, 2, 1, "", "collect_update_refs"], [253, 2, 1, "", "comp_references"], [253, 2, 1, "", "critical"], [253, 3, 1, "", "data_dict"], [253, 2, 1, "", "debug"], [253, 2, 1, "", "difference"], [253, 2, 1, "", "error"], [253, 2, 1, "", "filter"], [253, 2, 1, "", "get_system_input_refs"], [253, 2, 1, "", "info"], [253, 3, 1, "", "input_as_dict"], [253, 2, 1, "", "input_fields"], [253, 2, 1, "", "installSTDLogger"], [253, 2, 1, "", "internal_components"], [253, 2, 1, "", "internal_references"], [253, 2, 1, "", "internal_systems"], [253, 2, 1, "", "internal_tabulations"], [253, 3, 1, "", "last_context"], [253, 2, 1, "", "locate"], [253, 2, 1, "", "locate_ref"], [253, 2, 1, "", "message_with_identiy"], [253, 2, 1, "", "msg"], [253, 2, 1, "", "parse_run_kwargs"], [253, 2, 1, "", "parse_simulation_input"], [253, 2, 1, "", "plot_attributes"], [253, 3, 1, "", "plotable_variables"], [253, 2, 1, "", "post_update"], [253, 2, 1, "", "resetLog"], [253, 2, 1, "", "resetSystemLogs"], [253, 2, 1, "", "setattrs"], [253, 2, 1, "", "signals_attributes"], [253, 3, 1, "", "skip_plot_vars"], [253, 2, 1, "", "slot_refs"], [253, 2, 1, "", "slots_attributes"], [253, 2, 1, "", "smart_split_dataframe"], [253, 2, 1, "", "solvers_attributes"], [253, 3, 1, "", "system_id"], [253, 2, 1, "", "system_properties_classdef"], [253, 2, 1, "", "system_references"], [253, 2, 1, "", "trace_attributes"], [253, 2, 1, "", "transients_attributes"], [253, 2, 1, "", "update"], [253, 2, 1, "", "warning"]], "engforge.typing": [[255, 4, 1, "", "NUMERIC_NAN_VALIDATOR"], [256, 4, 1, "", "NUMERIC_VALIDATOR"], [257, 4, 1, "", "Options"], [258, 4, 1, "", "STR_VALIDATOR"]], "examples": [[260, 0, 0, "-", "air_filter"], [261, 0, 0, "-", "spring_mass"]], "test": [[263, 0, 0, "-", "test_airfilter"], [264, 0, 0, "-", "test_comp_iter"], [265, 0, 0, "-", "test_composition"], [266, 0, 0, "-", "test_costs"], [267, 0, 0, "-", "test_dynamics"], [268, 0, 0, "-", "test_dynamics_spaces"], [269, 0, 0, "-", "test_four_bar"], [270, 0, 0, "-", "test_modules"], [271, 0, 0, "-", "test_performance"], [272, 0, 0, "-", "test_pipes"], [273, 0, 0, "-", "test_problem_deepscoping"], [274, 0, 0, "-", "test_slider_crank"], [275, 0, 0, "-", "test_solver"], [276, 0, 0, "-", "test_tabulation"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "property", "Python property"], "4": ["py", "function", "Python function"], "5": ["py", "attribute", "Python attribute"], "6": ["py", "exception", "Python exception"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:property", "4": "py:function", "5": "py:attribute", "6": "py:exception"}, "terms": {"": [2, 7, 9, 10, 14, 22, 25, 29, 33, 41, 42, 43, 44, 48, 49, 67, 84, 85, 89, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 177, 179, 188, 189, 219, 222, 227, 239, 240, 242, 243, 253], "0": [2, 7, 9, 10, 14, 22, 25, 29, 33, 42, 43, 44, 48, 49, 52, 62, 84, 85, 89, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 121, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 188, 189, 220, 222, 240, 253, 279], "0001": 144, "01": [119, 151, 279], "025": 119, "03444": 147, "04": 144, "04478": 142, "05": [89, 119, 137, 138, 139, 140, 141, 142, 143, 145, 146, 147], "05044": 143, "07": [137, 138, 139, 145], "08": 146, "09544": 141, "1": [2, 41, 42, 43, 44, 48, 49, 52, 55, 65, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 124, 125, 126, 127, 128, 129, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 188, 189, 219, 220, 222, 240, 253, 279], "10": [137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 175, 185, 279], "100": [119, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 279], "1000": [89, 113, 115, 117, 118, 119, 120, 135, 146], "10000": [119, 140], "100000": [97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111], "1000000": [141, 142, 143, 146], "100000000": [144, 146], "10000000000000": 144, "101325": 156, "108": 144, "1100": [140, 144], "1103": 138, "1143": [137, 145], "1273": 146, "12e": 137, "13000000": 143, "138": 139, "140000000000": 140, "16": 145, "1600": [140, 142], "1632": 147, "1643": 145, "1700": 138, "1705": 137, "1723": [142, 147], "180": 119, "1823": [142, 147], "192000000000": 138, "193000000000": 145, "1d": [127, 128, 129], "1e": [119, 146], "2": [2, 41, 42, 43, 44, 48, 49, 55, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 124, 125, 126, 127, 128, 129, 131, 132, 133, 135, 137, 138, 139, 147, 151, 154, 155, 156, 157, 219, 220, 222, 240, 253, 279], "20": [7, 9, 10, 14, 22, 25, 29, 33, 119, 175, 279], "200": 20, "2000": [141, 143], "2000000": 146, "2005": 144, "205000000000": 137, "2080": 147, "21e": 139, "23": 138, "23e": 137, "240000000": [139, 145], "248000": 144, "25": [89, 119, 142], "250": [113, 115, 117, 118, 119, 120, 135, 140], "26": [141, 143, 145], "2600": 143, "2680": 139, "28": [137, 138], "287": [103, 104, 105, 106, 107], "288": [97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111], "290000000": 139, "2920000000": 141, "293": 156, "2d": 119, "2g": 124, "3": [7, 9, 10, 14, 22, 25, 29, 33, 41, 55, 119, 145, 146, 151, 220, 279], "30": 175, "3000": 143, "316": 145, "3273": 141, "33": [139, 140, 142, 144, 147], "37e": 138, "3d": 152, "3x3": 152, "4": [119, 139, 154, 157, 220], "40": 175, "4130": 137, "41e": 140, "42": 137, "423": 140, "4340": 138, "44": 138, "460000000": 137, "470000000": 138, "475": 138, "477": 137, "48e": 138, "4e": 145, "5": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253, 279], "50": [119, 175, 279], "500": 145, "500000": 144, "5432": 279, "550000000": 145, "560000000": 137, "573": [140, 144], "57900000": 141, "60": 175, "616": 139, "641e": [141, 142, 143, 147], "67000000000": 143, "686000000": 140, "6e": 145, "7": [137, 145], "70300000000": [139, 142, 147], "736": 141, "745000000": 138, "75": [119, 147, 154, 156], "773": 146, "7872": [137, 138], "8": [155, 157], "800": 142, "8000": 145, "81": 279, "873": 144, "880": 139, "9": [119, 139, 140, 279], "910000": 141, "919000000": 140, "92": 137, "940": 147, "95": 279, "99e": 139, "A": [2, 5, 7, 9, 10, 12, 14, 22, 23, 25, 26, 28, 29, 30, 32, 33, 35, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 83, 84, 85, 90, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 152, 154, 155, 156, 157, 164, 165, 167, 168, 173, 174, 178, 187, 188, 189, 193, 197, 198, 200, 201, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 220, 221, 222, 224, 234, 239, 240, 241, 243, 244, 252, 253, 279], "And": [188, 189], "As": 83, "At": [83, 279], "By": [89, 185, 279], "For": [126, 167, 279], "IN": 44, "If": [2, 7, 12, 20, 26, 28, 29, 32, 36, 42, 43, 44, 48, 49, 51, 61, 73, 84, 85, 89, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 114, 125, 126, 127, 128, 129, 130, 131, 132, 133, 151, 154, 155, 156, 157, 164, 165, 173, 174, 187, 188, 189, 193, 218, 219, 221, 222, 224, 227, 239, 240, 241, 243, 244, 249, 252, 253], "In": 253, "It": [7, 9, 10, 14, 22, 25, 29, 33, 132, 167, 192, 219, 222, 240], "Its": 279, "No": 279, "Of": 279, "On": [72, 178], "The": [20, 29, 83, 89, 93, 129, 132, 133, 151, 178, 185, 188, 189, 205, 222, 235, 239, 240, 243, 279], "There": 219, "These": [73, 112, 132, 185, 222, 240, 279], "To": [104, 167, 178, 279], "Will": 220, "With": 175, "_": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "__call__": [11, 15, 39, 64, 86, 93, 97, 98, 99, 100, 102, 108, 109, 110, 111, 177, 178, 179, 183, 194, 197, 198, 199, 200, 201, 204], "__file__": 279, "__init__": [72, 178, 197, 204], "__on_init__": 52, "_anything_chang": 58, "_check_kei": [188, 189], "_current_item": [42, 43, 44], "_geo": 119, "_overrid": 168, "_problem_id": 189, "_skip_plot_var": [2, 42, 43, 44, 48, 49, 62, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 240, 253], "_sys_ref": 185, "_type": 9, "_whatev": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "abid": [188, 189], "abil": [83, 164, 219, 222, 242, 243], "abl": [52, 89, 279], "about": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "abov": [132, 222, 240, 279], "abstract": 101, "accept": 25, "access": [2, 42, 43, 44, 48, 49, 52, 62, 73, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 167, 188, 219, 222, 240, 243, 253, 279], "accl": 279, "account": [89, 92, 93, 266], "accur": 279, "across": 219, "act": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253, 279], "action": [188, 189], "activ": [7, 42, 43, 44, 72, 132, 185, 188, 189, 222, 240, 279], "actual": [167, 184, 243], "ad": [7, 9, 10, 14, 22, 24, 25, 29, 33, 97, 98, 99, 100, 102, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 132, 135, 188, 189, 222, 239, 240], "add": [2, 7, 9, 10, 14, 22, 25, 27, 29, 33, 56, 98, 100, 113, 115, 117, 118, 119, 120, 132, 135, 151, 164, 167, 185, 188, 189, 192, 197, 220, 222, 240], "add_con": [188, 189], "add_constraint": 279, "add_data": [188, 189], "add_field": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "add_ign_typ": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "add_obj": [132, 185, 188, 189, 222, 240], "add_prediction_record": [113, 115, 117, 118, 119, 120, 135], "add_to_graph": 132, "add_var": [132, 185, 188, 189, 222, 240], "add_var_constraint": [7, 29, 279], "addabl": [132, 222, 240], "addit": [2, 9, 14, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 189, 192, 219, 222, 229, 240, 253], "addition": [2, 7, 27, 29, 42, 43, 44, 48, 49, 52, 84, 85, 89, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 220, 239, 240], "adhoc": [242, 243], "adjust": [151, 266, 279], "advis": 167, "af": 279, "affect": [85, 132, 240], "afin": 279, "afront": 124, "after": [20, 151, 188, 189, 220, 227, 251], "against": [119, 236, 267], "aim": [73, 151, 279], "air": 104, "airfilt": [263, 279], "airfilter_report": 279, "airfilteranalysi": 279, "airflow": 263, "alia": [6, 7, 9, 10, 14, 22, 25, 29, 33, 42, 43, 44, 48, 63, 66, 73, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 189, 195, 196, 202, 203, 240], "align": 152, "alist": [181, 182], "all": [2, 7, 9, 10, 12, 13, 14, 20, 22, 25, 26, 28, 29, 32, 33, 36, 42, 43, 44, 48, 49, 51, 52, 55, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 175, 178, 185, 187, 188, 189, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 220, 221, 222, 224, 240, 241, 244, 252, 253, 279], "all_comp": [188, 189], "all_compon": [188, 189], "all_problem_var": [188, 189], "all_vari": [188, 189], "allow": [2, 8, 11, 12, 15, 25, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 73, 83, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 121, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 173, 174, 185, 187, 193, 218, 219, 221, 222, 224, 240, 241, 243, 244, 252, 253, 279], "allow_set": [242, 243], "alongsid": [83, 84], "alreadi": [29, 89, 113, 115, 117, 118, 119, 120, 135, 178], "also": [2, 42, 43, 44, 48, 49, 89, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 119, 121, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 178, 184, 219, 236, 240, 243, 253], "alter": [132, 222, 240, 279], "alternate_path": 171, "although": 93, "alwai": [93, 185, 204], "ambigi": 46, "an": [2, 7, 9, 10, 12, 14, 20, 21, 22, 25, 26, 28, 29, 31, 32, 33, 36, 40, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 83, 84, 85, 90, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 167, 168, 173, 174, 185, 186, 187, 188, 189, 190, 191, 192, 193, 199, 200, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 220, 221, 222, 224, 229, 237, 239, 240, 241, 243, 244, 252, 253, 257, 279], "analys": 13, "analysi": [13, 21, 85, 124, 132, 240], "analysis_interv": 151, "ani": [2, 31, 42, 43, 44, 48, 49, 52, 55, 84, 85, 89, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 168, 177, 179, 185, 188, 189, 192, 219, 222, 239, 240, 253], "annot": [64, 93, 194, 197, 198, 199, 200, 201, 204], "annual": 89, "anonym": [229, 243], "anoth": 243, "anyth": [2, 42, 43, 44, 48, 49, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240, 253], "anything_chang": [2, 42, 43, 44, 48, 49, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240, 253], "anytim": 201, "anywher": 279, "ao": [113, 115, 117, 118, 119, 120, 151], "api": 220, "appear": 185, "append": [20, 44, 132, 222, 240], "appli": [7, 9, 10, 11, 14, 15, 22, 23, 25, 29, 33, 89, 91, 93, 132, 151, 152, 175, 178, 188, 189, 222, 240], "applic": [52, 168, 185, 229, 279], "apply_distributed_load": 151, "apply_local_distributed_load": 151, "apply_local_pt_load": 151, "apply_post_sign": [188, 189], "apply_pre_sign": [188, 189], "apply_pt_load": 151, "appropri": 58, "ar": [2, 12, 25, 26, 28, 32, 35, 36, 41, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 83, 84, 85, 89, 90, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 178, 185, 187, 188, 189, 192, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 220, 221, 222, 224, 227, 229, 236, 239, 240, 241, 242, 244, 252, 253, 257, 279], "arang": 279, "area": [113, 115, 117, 118, 119, 120, 151, 158, 159, 160], "arg": [2, 12, 26, 28, 32, 36, 39, 42, 43, 44, 48, 49, 51, 52, 61, 64, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 177, 178, 179, 183, 187, 188, 189, 193, 194, 198, 199, 200, 201, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 227, 229, 234, 235, 237, 240, 241, 243, 244, 245, 247, 248, 252, 253, 257], "argmin": [132, 222, 240], "argument": [2, 24, 42, 43, 44, 48, 49, 73, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 119, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 168, 178, 185, 188, 189, 219, 222, 227, 229, 239, 240, 243, 253], "around": 72, "arr": 87, "arrai": [39, 42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 183, 227, 236, 240], "artifact": 279, "as_dict": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "assign": [2, 42, 43, 44, 48, 49, 84, 85, 89, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 197, 204, 219, 222, 240, 253], "assum": [2, 42, 43, 44, 48, 49, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 222, 227, 240, 253], "astyp": [246, 247], "asurfac": 124, "attempt": [188, 189, 279], "attr": [2, 7, 9, 10, 14, 21, 22, 24, 25, 29, 31, 33, 42, 43, 44, 45, 48, 49, 52, 56, 59, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 116, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 192, 201, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 219, 222, 239, 240, 251, 253, 257, 279], "attr_bas": [7, 10, 22, 25, 29, 31], "attr_nam": 226, "attribu": [240, 279], "attribut": [2, 5, 7, 9, 10, 11, 12, 13, 14, 15, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 36, 42, 43, 44, 48, 49, 51, 52, 59, 61, 62, 64, 72, 73, 83, 84, 85, 86, 89, 90, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 116, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 185, 187, 188, 189, 193, 194, 197, 198, 199, 200, 201, 204, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 220, 221, 222, 224, 239, 240, 241, 243, 244, 252, 253, 279], "attributedbasemixin": [52, 219], "attributeinst": [5, 7, 11, 22, 23, 25, 30, 33], "automat": [89, 188, 189], "avail": [35, 151, 188, 189, 279], "averag": [113, 115, 117, 118, 119, 120, 135], "avoid": 243, "aw": 40, "ax": [14, 279], "ax2": 279, "axi": [119, 151], "b": [42, 43, 44, 48, 83, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 118, 120, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 177, 179, 240], "back": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "balanc": [29, 132, 222, 240, 279], "base": [2, 5, 7, 9, 10, 11, 12, 13, 14, 15, 22, 23, 25, 26, 28, 29, 30, 32, 33, 34, 36, 39, 42, 43, 44, 46, 48, 49, 51, 52, 61, 62, 64, 72, 73, 84, 85, 86, 89, 90, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 116, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 177, 178, 179, 183, 185, 187, 188, 189, 193, 194, 197, 198, 199, 200, 201, 204, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 239, 240, 241, 242, 243, 244, 252, 253, 279], "base_func": 237, "base_kw": 119, "basi": [119, 266], "basis_expand": 119, "becom": 257, "beem": 151, "been": [2, 42, 43, 44, 48, 49, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 189, 240, 253], "befor": [44, 64, 93, 175, 194, 197, 198, 199, 200, 201, 204, 240, 279], "began": 240, "begin": [132, 222, 240], "behavio": 24, "behavior": [21, 24, 27, 55, 132, 185, 220, 222, 239, 240, 279], "being": [2, 14, 132, 168, 178, 222, 240], "below": [119, 132, 222, 240, 279], "bend_radiu": 127, "best": 151, "between": [2, 21, 42, 43, 44, 48, 49, 62, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 124, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 235, 236, 239, 240, 242, 243, 253, 263], "betwewn": 49, "bia": [247, 250], "block": 185, "blue": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "boilerpl": 72, "bool": [2, 13, 25, 42, 43, 44, 48, 73, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 119, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 168, 175, 188, 189, 190, 191, 226, 240], "boolean": [2, 13, 42, 43, 44, 48, 49, 84, 85, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 135, 151, 154, 155, 156, 157, 219, 222, 240, 253], "both": [146, 188, 189, 220, 279], "both_match": [188, 189], "bound": [7, 29, 85, 113, 115, 117, 118, 119, 120, 135, 227], "boundari": 126, "broadcast": [39, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 175, 183], "build": 279, "bulk": 93, "bypass": 119, "c": [42, 43, 44, 48, 53, 83, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 124, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "c2": 124, "cach": [2, 39, 48, 49, 73, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 119, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 183, 188, 189, 197, 198, 200, 219, 222, 240, 243, 253, 279], "cache_class": 73, "cache_prop": [198, 200, 201], "cached_system_properti": 279, "calc_everi": 119, "calc_margin": 119, "calcul": [89, 92, 119, 151, 239, 279], "calculate_cost": 92, "calculate_item_cost": [91, 151], "calculate_product": [89, 92], "calculate_stress": 151, "calcult": [113, 115, 117, 118, 119, 120, 135], "call": [2, 13, 25, 41, 42, 43, 44, 48, 64, 72, 73, 84, 85, 86, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 167, 177, 178, 179, 184, 185, 189, 194, 197, 198, 199, 200, 201, 204, 222, 239, 240, 251, 279], "callabl": [2, 29, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 175, 219, 222, 240, 242, 243, 253], "callback": [2, 55, 58, 73, 113, 115, 117, 118, 120, 132, 135, 201, 222, 239, 240], "can": [2, 7, 13, 14, 25, 29, 42, 43, 44, 48, 49, 52, 84, 85, 89, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 124, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 168, 178, 184, 185, 188, 189, 197, 204, 219, 220, 222, 235, 239, 240, 242, 243, 246, 247, 253, 279], "candiat": 220, "canid": [7, 9, 10, 14, 22, 25, 29, 33, 245], "cannot": 178, "capabl": 279, "capex": 89, "capit": 14, "captur": [2, 42, 43, 44, 48, 49, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 133, 151, 154, 155, 156, 157, 253, 279], "carbon": 140, "care": 242, "carefulli": 243, "case": [2, 42, 43, 44, 48, 49, 59, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 235, 236, 240, 243, 253, 267, 279], "categor": 93, "categori": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 89, 90, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "catplot": 9, "cb": [2, 7, 9, 10, 14, 22, 25, 29, 33, 85, 132, 222, 240], "certain": [2, 42, 43, 44, 48, 49, 52, 73, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "cfd": [127, 128, 129], "cg_relative_inertia": 151, "chang": [2, 7, 9, 10, 14, 22, 25, 29, 33, 42, 43, 44, 48, 49, 52, 55, 58, 84, 85, 89, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 124, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 161, 164, 175, 185, 188, 189, 197, 201, 219, 222, 234, 236, 240, 242, 243, 249, 253, 279], "change_all_log_level": 279, "characterist": [133, 279], "check": [2, 7, 9, 10, 14, 22, 25, 29, 33, 40, 42, 43, 44, 48, 49, 52, 72, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 188, 189, 197, 219, 220, 222, 236, 240, 243, 249, 253], "check_and_retrain": [113, 115, 117, 118, 119, 120, 135], "check_atr_f": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "check_config": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 240], "check_dynam": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "check_funct": 175, "check_kw": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "check_out_of_domain": [113, 115, 117, 118, 119, 120, 135], "check_ref_slot_typ": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "check_symmetr": 119, "checkpoint": [188, 189], "children": [12, 26, 28, 32, 36, 51, 61, 73, 90, 92, 114, 130, 164, 165, 173, 174, 187, 193, 218, 219, 221, 222, 224, 241, 244, 252, 253], "chk": [243, 249], "choic": [9, 14, 257], "choos": 279, "chosen": [132, 222, 240], "circl": 115, "circular": 243, "cl": [9, 10, 14, 55, 59, 166, 184], "class": [1, 2, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 39, 41, 42, 43, 44, 46, 47, 48, 49, 50, 51, 52, 60, 61, 62, 64, 71, 72, 73, 83, 84, 85, 86, 89, 90, 91, 92, 93, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 150, 151, 153, 154, 155, 156, 157, 163, 164, 165, 167, 168, 172, 173, 174, 176, 177, 178, 179, 183, 184, 185, 187, 188, 189, 192, 193, 194, 197, 198, 199, 200, 201, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 217, 218, 219, 220, 221, 222, 223, 224, 239, 240, 241, 242, 243, 244, 251, 252, 253, 260, 261, 263, 264, 265, 266, 267, 268, 269, 270, 271, 272, 273, 274, 275, 276, 279], "class_attr": 34, "class_cach": [188, 189, 192], "class_cost_properti": [91, 151], "class_valid": [7, 9, 10, 14, 22, 25, 29, 33], "classmethod": [2, 7, 9, 10, 14, 22, 25, 29, 33, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 168, 188, 189, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 219, 222, 240, 253], "classnam": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "clean_air_delivery_r": 279, "clear": [42, 44], "clone": [132, 185, 240], "close": [20, 124], "cls_compil": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "cmp": [7, 9, 10, 14, 22, 25, 29, 33], "co": 279, "coars": 119, "cobla": 239, "code": [185, 279], "col": 9, "collect": [2, 7, 9, 10, 14, 22, 25, 29, 33, 41, 42, 43, 44, 48, 49, 52, 83, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "collect_all_attribut": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "collect_attr_inst": [7, 9, 10, 14, 22, 25, 29, 33], "collect_cl": [7, 9, 10, 14, 22, 25, 29, 33], "collect_comp_ref": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "collect_dynamic_ref": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "collect_inst_attribut": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "collect_post_update_ref": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "collect_solver_ref": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "collect_update_ref": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "color": [2, 9, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "column": [2, 9, 42, 43, 44, 48, 49, 56, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240, 253], "com": 279, "combin": [2, 11, 29, 42, 43, 44, 48, 49, 83, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 119, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 189, 240, 253, 279], "combo": [7, 29, 132, 151, 185, 188, 189, 222, 226, 240, 279], "combo_filt": [188, 189], "combos_in": 231, "come": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253, 281], "command": 279, "common": [13, 49, 52, 219], "commun": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "comp": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 243, 253], "comp_class": [7, 9, 10, 14, 22, 25, 29, 33], "comp_kei": [42, 43, 44], "comp_refer": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "compar": [113, 115, 117, 118, 119, 120, 135, 279], "comparison": [7, 29], "compil": [2, 30, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 185, 240], "compile_class": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "complet": [2, 48, 49, 84, 85, 91, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 135, 151, 154, 155, 156, 157, 219, 222, 240, 253], "complex": [27, 220, 239, 279], "compon": [2, 7, 9, 10, 14, 21, 22, 24, 25, 29, 33, 41, 42, 43, 44, 45, 52, 83, 84, 85, 89, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 204, 219, 222, 239, 240, 242, 243, 253], "component_or_system": 25, "component_typ": [42, 44], "componentdict": 41, "componentgraph": 41, "componentit": [42, 44, 279], "componentiter": 25, "componentlist": 41, "componentsubclass": 239, "componenttyp": 279, "compressor": [124, 154], "comput": 89, "con": [132, 222, 240], "con_arg": 227, "con_eq": 29, "con_ineq": 29, "concern": 185, "condit": [126, 220], "conf": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "config": [2, 7, 9, 10, 14, 22, 25, 29, 33, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "config_class": [7, 9, 10, 14, 22, 25, 29, 33], "configur": [2, 7, 22, 25, 31, 33, 42, 43, 44, 48, 49, 72, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 239, 240, 253, 279], "configure_for_system": [7, 9, 10, 14, 22, 25, 29, 33], "configure_inst": [7, 9, 10, 14, 22, 25, 29, 33], "confirm": [72, 279], "conflict": [83, 84], "conjunct": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "conserv": 151, "consid": [133, 188, 189, 237], "constant": [2, 42, 43, 44, 48, 49, 62, 69, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 124, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 240, 253], "constrain": 239, "constraint": [7, 27, 29, 132, 188, 189, 220, 222, 227, 235, 240, 279], "constraint_equ": [29, 279], "constraint_exist": [7, 29], "constraint_inequ": 29, "contain": [2, 42, 43, 44, 48, 49, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 189, 240, 253], "context": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 185, 186, 188, 189, 190, 191, 219, 220, 222, 240, 253], "continu": [127, 128, 129, 188, 189], "contract": [159, 160], "contribut": 151, "control": [42, 43, 44, 48, 83, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 185, 240, 243], "control_sign": 239, "control_with": 239, "contyp": [227, 235], "convein": 9, "converg": [132, 188, 189, 239, 240, 279], "convers": [25, 279], "convert": [2, 7, 9, 10, 12, 14, 22, 25, 26, 28, 29, 32, 33, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 167, 168, 173, 174, 187, 188, 189, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 234, 240, 241, 244, 246, 252, 253], "convieni": 56, "coolprop": [97, 98, 99, 100, 102, 108, 109, 110, 111], "coolpropmateri": [97, 100, 102, 108, 109, 110, 111], "coolpropmixtur": 98, "copi": [2, 7, 9, 10, 14, 22, 25, 29, 33, 42, 43, 44, 48, 49, 52, 83, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 188, 189, 219, 222, 240, 242, 243, 253], "copy_config_at_st": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "core": [52, 164, 192], "correct": [2, 24, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 184, 198, 219, 222, 240, 253], "correspond": [29, 42, 229], "cost": [151, 266, 279], "cost_categori": [91, 151], "cost_of_xyz": 89, "cost_per_item": [89, 91, 151], "cost_per_kg": [137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147], "cost_properti": [89, 91, 151], "costmethod": [91, 151], "costmodel": [41, 89, 93, 94, 151], "costmodelinst": 91, "costs_at_term": [91, 93, 151], "could": [2, 42, 43, 44, 48, 49, 72, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240, 253], "count": [44, 93], "coupl": 279, "cours": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "cp": [154, 157], "cp_c": 155, "cp_h": 155, "creat": [2, 7, 9, 10, 13, 14, 20, 22, 25, 29, 31, 33, 42, 43, 44, 48, 49, 52, 59, 72, 83, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 178, 185, 188, 189, 219, 222, 227, 229, 240, 242, 243, 253, 257, 279], "create_dynamic_matrici": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "create_feedthrough_matrix": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "create_graph_from_pipe_or_nod": 132, "create_input_matrix": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "create_inst": [7, 9, 10, 14, 22, 25, 29, 33], "create_meta": 72, "create_output_const": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "create_output_matrix": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "create_state_const": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "create_state_matrix": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "creation": [2, 42, 43, 44, 48, 49, 52, 83, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 222, 240], "crit": 175, "criteria": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 185, 219, 222, 240, 253], "critic": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "cross": 117, "csv": [132, 206, 222, 240, 279], "csv_latest": 279, "csvreport": 279, "ctx": [16, 235], "ctx_ex": 220, "ctx_fail_new": [185, 188, 189], "cumulative_cost": 89, "current": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 222, 227, 240, 279], "current_flow": 133, "current_item": [42, 43, 44], "curv": 279, "custom": [25, 59, 89, 132, 222, 240, 279], "custom_cost": [89, 91, 151], "custom_object": [132, 222, 240], "customiz": [2, 31, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "customsystem": 239, "cyan": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "cyclic": 239, "d": [42, 43, 44, 48, 83, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 124, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "daili": 279, "darkgrid": 279, "data": [2, 8, 9, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 60, 61, 84, 85, 86, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 188, 189, 193, 201, 204, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 239, 240, 241, 244, 252, 253, 279], "data_dict": [2, 42, 43, 44, 48, 49, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 133, 151, 154, 155, 156, 157, 253], "databas": 72, "database_nam": 72, "dataflow": 239, "datafram": [2, 9, 10, 11, 14, 15, 25, 41, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 135, 151, 154, 155, 156, 157, 188, 189, 204, 214, 239, 240, 253, 279], "dataframe_properti": [63, 66], "dataframemixin": [2, 188, 253], "datasourc": 279, "db": 72, "db_driver": 167, "db_host": 167, "db_password": 167, "de": [185, 189], "deactiv": [132, 185, 188, 189, 222, 240], "deal": 167, "debug": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 175, 187, 188, 189, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "debug_fail": [85, 132, 240], "debug_level": [188, 189], "declare_cost": 91, "declare_var": [29, 279], "decor": [55, 178, 184], "decoupl": [5, 23, 30], "deect": 95, "deep": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240, 279], "def": [89, 197, 204, 279], "default": [2, 7, 9, 10, 11, 14, 15, 22, 24, 25, 29, 33, 42, 43, 44, 48, 49, 52, 55, 73, 83, 84, 85, 89, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 167, 168, 185, 188, 189, 222, 228, 236, 240, 257, 266, 279], "default_arg": 25, "default_cost": [89, 91, 151], "default_kwarg": 25, "default_ok": 25, "default_solv": 279, "defaults_ok": 25, "defin": [7, 8, 9, 10, 14, 21, 22, 24, 25, 27, 29, 31, 33, 41, 59, 83, 89, 91, 116, 134, 151, 167, 178, 185, 205, 206, 207, 208, 209, 210, 211, 215, 219, 220, 239, 240, 242, 253, 279], "define_iter": [25, 41, 279], "define_valid": [7, 9, 10, 14, 22, 25, 29, 33], "definit": [91, 151, 184, 227, 239], "defualt": 279, "delta_dict": [243, 249], "demonstr": 279, "densiti": [101, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 158, 159, 160, 161], "dep": 279, "depend": [9, 14, 43, 101, 188, 189, 220, 239, 279], "deriv": 279, "desc": [56, 93, 168, 197, 204], "describ": [132, 222, 240], "descript": [56, 168, 239], "design": [43, 242, 279], "design_flow_curv": 133, "desir": [234, 279], "destin": 152, "destruct": 220, "detail": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 89, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "detect": [83, 84], "determin": [2, 25, 42, 43, 44, 48, 49, 52, 84, 85, 89, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 188, 189, 240, 253], "determine_failure_stress": 119, "determine_nearest_stationary_st": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "develop": 124, "df": [2, 42, 43, 44, 48, 49, 62, 69, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 135, 151, 154, 155, 156, 157, 188, 240, 253, 279], "dflt": 230, "dflt_kw": 25, "dh": 158, "diamet": [113, 115, 158], "dict": [2, 7, 9, 10, 13, 14, 22, 25, 29, 33, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 94, 95, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 185, 188, 189, 219, 222, 229, 234, 236, 240, 253], "dictionari": [2, 7, 9, 10, 13, 14, 22, 25, 29, 33, 42, 43, 44, 48, 49, 52, 69, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 185, 188, 189, 219, 222, 227, 229, 235, 236, 240, 242, 243, 249, 253], "diff": 177, "differ": [2, 11, 15, 25, 29, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 185, 219, 222, 235, 236, 240, 253, 279], "differenti": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "dimens": 9, "direct": 279, "directli": [30, 167, 227, 239], "disabl": [132, 222, 240, 242, 243], "discard": [188, 189], "discard_context": [188, 189], "discount_r": [89, 92], "disk": 279, "diskcach": 73, "diskplotreport": 279, "diskreportermixin": [206, 207, 209], "displot": 9, "divid": [113, 115, 117, 118, 119, 120, 135], "do": [2, 7, 9, 10, 14, 22, 25, 29, 33, 42, 43, 44, 48, 49, 52, 72, 84, 85, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 168, 185, 219, 222, 240, 253], "doc": [39, 64, 93, 183, 194, 197, 198, 199, 200, 201, 204, 279], "doe": [7, 9, 10, 14, 22, 25, 29, 33, 185, 279], "doesn": [73, 91, 151, 168, 188, 189], "don": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "done": [83, 151, 279], "dontovrrid": 168, "doset": 236, "dot": 20, "doubl": 266, "down": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "dp": 124, "dp_design": 279, "dp_f": 129, "dp_fan": 279, "dp_filter": 279, "dp_p": 129, "dp_parasit": 279, "dpi": 20, "dpressur": 133, "drive": 279, "driven": 29, "driveplot": 207, "dry": 142, "dt": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 189, 219, 222, 240, 253, 279], "due": [129, 158, 161], "dur": 93, "durat": 198, "dure": 29, "dx": 279, "dxdt": [132, 188, 189, 222, 240], "dxtdt_ref": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "dynam": [2, 42, 43, 44, 48, 49, 52, 89, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 188, 189, 219, 222, 240, 242, 243, 253, 279], "dynamic_input_var": [132, 240], "dynamic_output_var": [132, 240], "dynamic_solv": [188, 189], "dynamic_state_var": [132, 240], "dynamicmixin": 85, "dynamicsmixin": [48, 83, 85], "dynamicsystem": 83, "e": [177, 179, 184], "each": [2, 8, 9, 14, 25, 41, 42, 43, 44, 48, 49, 73, 89, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 185, 200, 222, 239, 240, 253, 279], "eas": 178, "easi": 174, "echo": 72, "econ": 89, "econom": [89, 93], "economic_output": 92, "ect": [132, 188, 189, 222, 240], "effici": [154, 155, 156, 157, 279], "either": [7, 29, 43], "elastic_modulu": [137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147], "electrical_resistit": [137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147], "element": [44, 100, 132, 204], "elimin": [188, 189], "els": [7, 20, 29, 42], "embelish": 192, "emerg": 151, "emphasi": 266, "empti": [2, 42, 43, 44, 48, 49, 62, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 240, 253], "empty_str": [188, 189], "enabl": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 222, 240, 253], "encount": 239, "end": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 219, 222, 240, 253], "end_factor": 151, "endtim": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253, 279], "engforge_prop": [64, 194, 204], "engin": 72, "ensu": 236, "ensur": [2, 24, 42, 43, 44, 45, 48, 49, 64, 84, 85, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 168, 184, 194, 197, 198, 199, 200, 201, 204, 219, 222, 240, 253, 279], "ensure_database_exist": 72, "enter": [188, 189, 279], "enter_refresh": [132, 222, 240], "entiti": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "entracnc": [185, 189], "entranc": [159, 161, 185], "entri": 185, "env": [167, 168], "envarg": 168, "enviornment": 168, "envvari": [167, 279], "eq": [7, 9, 10, 14, 22, 25, 29, 33, 101], "eq_kei": [7, 9, 10, 14, 22, 25, 29, 33], "eq_of_st": 104, "equal": [29, 188, 189], "equat": [29, 99, 239], "error": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 83, 84, 85, 90, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 175, 185, 187, 188, 189, 190, 191, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "error_act": [188, 189], "est": 119, "establish": [29, 30, 83, 85, 185, 189, 239], "establish_system": [188, 189], "estim": [119, 151], "estimate_failur": 119, "estimate_stress": [119, 151], "euler": 7, "eval": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 251, 253], "eval_f": 243, "eval_kw": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "evald": [93, 239, 243], "evalu": [29, 132, 222, 227, 240, 242, 243], "evaluat": 48, "even": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "event": [12, 26, 28, 32, 36, 51, 61, 73, 90, 114, 130, 164, 165, 173, 174, 185, 187, 193, 218, 219, 221, 222, 224, 241, 244, 252, 253], "everi": [12, 26, 28, 32, 36, 51, 61, 73, 90, 114, 130, 164, 165, 173, 174, 185, 187, 188, 189, 193, 218, 219, 221, 222, 224, 241, 244, 252, 253], "everyth": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "evolv": [7, 9, 10, 14, 22, 25, 29, 33], "ex": 204, "exact": [177, 179], "exactli": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "exampl": [167, 185], "excel": [209, 279], "except": [185, 186, 188, 189, 190, 191, 243], "exchang": [124, 158, 159, 160], "exclud": [39, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 166, 183], "exclude_var": [188, 189], "exclus": [132, 185, 222, 240], "execut": [2, 25, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 188, 189, 219, 220, 222, 239, 240, 253, 279], "execution_context": 220, "exist": [2, 9, 10, 14, 20, 42, 43, 44, 48, 49, 62, 72, 73, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 135, 151, 154, 155, 156, 157, 168, 188, 222, 240, 253, 279], "exit": [160, 161, 185, 186, 188, 189, 190, 191, 220], "exit_act": [188, 189], "exit_on_failur": [185, 188, 189], "expand_valu": 119, "expens": 197, "expir": 73, "explicitli": [2, 42, 43, 44, 48, 49, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240, 253], "exploratori": 279, "extend": [44, 93], "extens": 199, "extra": [119, 227], "extra_add": [113, 115, 117, 118, 119, 120, 135], "extra_kw": [226, 228, 230, 231, 232], "extra_margin": [113, 115, 117, 118, 119, 120, 135], "extract": [188, 189], "f": [7, 29, 42, 43, 44, 48, 53, 82, 84, 85, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 124, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 158, 192, 227, 234, 240, 279], "f_lin_min": [236, 237], "fa": 279, "faccel": 279, "factor": [89, 158], "factor_of_saftei": [137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147], "factori": 25, "fail": [2, 25, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 188, 189, 219, 222, 236, 240, 243, 249, 253], "fail_if_discardmod": [188, 189], "fail_learn": 119, "fail_on_miss": 168, "fail_revert": [185, 188, 189], "failur": [119, 121, 185, 188, 189, 236], "failure_mod": 119, "fals": [2, 7, 9, 10, 14, 20, 22, 25, 29, 33, 39, 41, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 121, 125, 126, 127, 128, 129, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 166, 168, 177, 183, 188, 189, 197, 204, 219, 222, 230, 235, 240, 242, 243, 253, 279], "fan": [158, 263, 279], "fan_dp_fan": 279, "fashion": 279, "fdel": [64, 93, 194, 197, 198, 199, 200, 201, 204], "feedthrough": 83, "fext": 279, "ffric": 279, "ffunc": 236, "fg": 151, "fget": [64, 93, 194, 197, 198, 199, 200, 201, 204], "fgrav": 279, "fiber": 140, "field": [2, 7, 9, 10, 12, 14, 22, 25, 26, 28, 29, 32, 33, 36, 42, 43, 44, 48, 49, 51, 52, 59, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 239, 240, 241, 244, 252, 253, 257, 279], "field_transform": 59, "fig": [20, 279], "figur": [2, 9, 14, 20], "file": [2, 12, 20, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "filenam": [2, 20, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "filt": 279, "filt_dp_filt": 279, "filter": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253, 263], "filter_var": [188, 189], "filtrat": 124, "final": [185, 188, 189], "final_object": [188, 189], "find": [38, 119, 152], "first": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 178, 185, 200, 201, 219, 222, 236, 239, 240, 253, 257], "fit": 124, "fixed_output": [89, 92], "fixm": [2, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253, 279], "flag": [58, 59, 132, 188, 189, 198, 204, 222, 240], "flexible_exec": 220, "float": [2, 7, 29, 42, 43, 44, 48, 49, 84, 85, 91, 92, 93, 94, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 118, 119, 120, 121, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 204, 219, 222, 239, 240, 250, 253, 279], "flow": [133, 159, 160, 239, 240, 279], "flow_curv": 279, "flow_in": 125, "flow_var": 279, "flownod": [125, 128], "fluid": [101, 124, 156, 159, 160, 279], "fluidiz": [127, 128, 129], "fluidmateri": [99, 104], "flux": [158, 159, 160, 161], "fnmatch": [132, 222, 240], "follow": [55, 89, 185, 188, 189, 236], "forc": [132, 151, 188, 189, 240], "force_calc": [119, 151], "forg": [2, 42, 43, 44, 48, 49, 52, 84, 85, 89, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240, 279], "forge_db_host": 279, "forge_db_nam": 279, "forge_db_pass": 279, "forge_db_port": 279, "forge_db_us": 279, "forge_hostnam": 279, "forge_report_path": 279, "forge_slack_log_webhook": 279, "form": [29, 46, 132, 222, 240], "format": [25, 42, 43, 44, 56, 92, 174, 188, 189, 239], "formul": 124, "found": [2, 7, 29, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 168, 188, 189, 219, 222, 239, 240, 253], "fracion": [119, 121], "fraction": [121, 151], "frame": 151, "frequenc": 279, "frequent": 52, "friction": 158, "friendli": 229, "from": [2, 9, 10, 13, 14, 23, 37, 42, 43, 44, 48, 49, 52, 84, 85, 89, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 168, 178, 180, 185, 188, 189, 219, 222, 227, 240, 253, 279], "frontal": [159, 160], "fset": [64, 93, 194, 197, 198, 199, 200, 201, 204], "fspring": 279, "full": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "func": [64, 93, 194, 197, 198, 199, 200, 201, 204], "function": [1, 2, 7, 8, 9, 10, 13, 14, 22, 25, 29, 33, 35, 41, 42, 43, 44, 48, 49, 50, 52, 60, 62, 64, 65, 71, 83, 84, 85, 86, 89, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 150, 151, 153, 154, 155, 156, 157, 163, 167, 168, 170, 172, 176, 177, 178, 179, 188, 192, 194, 197, 198, 199, 200, 201, 204, 205, 219, 222, 223, 227, 229, 234, 235, 236, 237, 239, 240, 242, 243, 253, 254, 265, 267, 271, 273], "funki": [197, 204], "further": [132, 185, 189, 222, 240], "fvec": [127, 128, 129], "fxl": 124, "g": [158, 159, 160, 161, 177, 179, 279], "ga": [101, 104], "gain": 161, "gamma": [154, 157], "garunte": 279, "gas_const": [103, 104, 105, 106, 107], "gather": [2, 9, 10, 14, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 189, 219, 222, 240, 253], "gdrive": 210, "gener": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 57, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 116, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 220, 221, 222, 224, 240, 241, 244, 252, 253, 279], "get": [2, 42, 43, 44, 48, 49, 56, 72, 73, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 168, 178, 185, 188, 189, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 219, 222, 240, 253], "get_extra_kw": [188, 189], "get_forces_at": 151, "get_func_return": [64, 93, 194, 197, 198, 199, 200, 201, 204], "get_parent_kei": [188, 189], "get_ref_valu": [188, 189], "get_sesh": [188, 189], "get_stress_at": 151, "get_system_input_ref": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "git": 279, "github": 279, "given": [7, 9, 10, 14, 22, 25, 29, 33, 42, 119, 132, 177, 188, 189, 222, 240], "global": [42, 43, 44, 151, 167], "global_inertia": 151, "globaldynam": 240, "globali": 35, "glue": 279, "go": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253, 279], "go_through_configur": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "goal": 119, "goal_el": 119, "gonna": 124, "good": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "googl": 279, "graph": 132, "graviti": 151, "green": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "grei": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "grid": [9, 279], "group": [2, 42, 43, 44, 48, 49, 84, 85, 89, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "groupbi": 279, "gsheet": [211, 279], "guess": [132, 222, 236, 240], "h": [118, 120], "ha": [2, 13, 42, 43, 44, 48, 49, 64, 84, 85, 89, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 184, 188, 189, 194, 197, 198, 199, 200, 201, 204, 219, 222, 227, 240, 253], "hallow": [113, 115, 117, 118, 119, 120, 151], "handil": 185, "handl": [7, 22, 29, 31, 33, 124, 185, 188, 189, 220], "handle_inst": [7, 9, 10, 14, 22, 25, 29, 33], "happen": [9, 14], "hard": [124, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147], "hash": [7, 9, 10, 14, 22, 25, 29, 33, 55, 119, 148], "hash_id": 119, "hashabl": 184, "have": [2, 12, 14, 26, 28, 29, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 73, 83, 84, 85, 89, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 184, 185, 187, 193, 204, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "haven": [2, 42, 43, 44, 48, 49, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240, 253], "he": 161, "header": 56, "heat": [124, 158, 159, 160], "heatexchang": 155, "height": [118, 120], "helper": [73, 178, 219], "here": 220, "hidden": 119, "histori": [188, 189], "hold": 146, "hollow": 115, "host": [52, 72], "hostnam": 72, "how": [2, 42, 43, 44, 48, 49, 52, 84, 85, 89, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240, 279], "howev": [2, 13, 41, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 185, 240, 243, 279], "html": 279, "http": 279, "hue": 9, "hysterisi": 242, "i": [2, 7, 9, 10, 12, 13, 14, 20, 22, 24, 25, 26, 27, 28, 29, 31, 32, 33, 36, 40, 41, 42, 43, 44, 45, 48, 49, 51, 52, 55, 61, 64, 72, 73, 83, 84, 85, 89, 90, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 121, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 167, 168, 173, 174, 175, 177, 178, 179, 184, 185, 187, 188, 189, 192, 193, 194, 197, 198, 199, 200, 201, 204, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 220, 221, 222, 224, 227, 234, 236, 237, 239, 240, 241, 242, 243, 244, 246, 247, 249, 251, 252, 253, 257, 279], "ib": 56, "id": [2, 42, 43, 44, 48, 49, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240, 253, 266], "ideal": [101, 236], "idealga": [103, 105, 106, 107], "ident": [2, 42, 43, 44, 48, 49, 52, 55, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240, 243], "identif": 199, "identifi": 219, "ie": [2, 9, 11, 15, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 185, 222, 239, 240, 279], "ign_combo": [132, 185, 188, 189, 222, 240], "ign_var": [132, 185, 188, 189, 222, 240], "ignor": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 135, 148, 151, 154, 155, 156, 157, 185, 188, 189, 219, 222, 240, 253], "ignore_none_comp": [2, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "implement": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 178, 219, 222, 240, 253, 279], "import": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253, 279], "importantli": 219, "in_a": 151, "in_ii": 151, "in_ix": 151, "in_ixi": 151, "in_j": 151, "in_nod": 132, "in_shear_modulu": [137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147], "inbound": [113, 115, 117, 118, 119, 120, 135], "inch": 20, "includ": [2, 7, 9, 10, 14, 22, 25, 29, 33, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 174, 192, 219, 222, 239, 240, 253], "inclus": 185, "increment": 251, "indep": 279, "independ": [9, 14, 236, 279], "index": [7, 29, 41, 44, 83, 188, 189, 279], "indexerror": 44, "indic": [113, 115, 117, 118, 119, 120, 132, 135, 188, 189, 222, 240], "individu": [83, 132, 222, 240], "ineq": [7, 29, 235], "inequ": [29, 239], "inertia": 151, "info": [2, 11, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 175, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 235, 240, 241, 244, 252, 253, 279], "inform": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 167, 168, 173, 174, 187, 192, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253, 279], "inherit": [7, 9, 10, 13, 14, 22, 25, 29, 33, 85, 178, 222], "init": [2, 7, 9, 10, 14, 22, 25, 29, 31, 33, 42, 43, 44, 48, 49, 52, 59, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 197, 204, 219, 222, 240, 253, 257], "initi": [12, 26, 28, 32, 36, 51, 61, 73, 83, 89, 90, 93, 114, 130, 132, 164, 165, 173, 174, 187, 188, 189, 193, 218, 219, 221, 222, 224, 236, 240, 241, 244, 252, 253], "inpt": [122, 132, 240], "input": [2, 7, 10, 22, 25, 33, 42, 43, 44, 45, 48, 49, 52, 64, 83, 84, 85, 89, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 116, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 169, 177, 185, 188, 189, 194, 197, 198, 199, 200, 201, 204, 219, 220, 222, 227, 229, 240, 243, 251, 253, 257, 279], "input_as_dict": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "input_dict": [188, 189], "input_field": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "input_var": [188, 189], "insert": 44, "insid": 72, "inspir": 239, "inst": [93, 123, 175, 216, 230, 231, 232], "installstdlogg": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "instanc": [2, 5, 7, 9, 10, 12, 13, 14, 22, 23, 25, 26, 28, 29, 30, 31, 32, 33, 36, 40, 42, 43, 44, 45, 48, 49, 51, 52, 57, 58, 61, 72, 73, 84, 85, 89, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 178, 185, 187, 189, 193, 198, 200, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 239, 240, 241, 244, 252, 253, 266, 279], "instance_class": [7, 9, 10, 14, 22, 25, 29, 33], "instanti": [177, 179, 184], "instead": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 185, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "int": [2, 7, 29, 42, 43, 44, 48, 49, 52, 65, 84, 85, 91, 92, 93, 94, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 175, 204, 219, 222, 239, 240, 253], "integ": [44, 93], "integr": [2, 7, 27, 42, 43, 44, 48, 49, 83, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 189, 219, 220, 222, 240, 253, 279], "integral_r": [188, 189], "integrator_rate_ref": [188, 189], "integrator_var_ref": [188, 189], "integratorinst": 7, "intend": [83, 84, 198, 213], "interacion": [9, 10, 14], "interact": 279, "interfac": [2, 12, 13, 25, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 60, 61, 72, 73, 84, 85, 90, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 167, 168, 173, 174, 185, 187, 193, 199, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253, 279], "interior": [188, 189], "intermedi": 158, "intern": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 89, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 239, 240, 241, 244, 252, 253, 279], "internal_compon": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "internal_configur": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "internal_refer": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "internal_system": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "internal_tabul": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "interpol": 124, "intersect": 119, "interv": [42, 43, 44, 48, 73, 83, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240, 279], "invari": 69, "invok": 279, "io": 279, "ipython": 279, "is_act": [188, 189], "isn": [91, 151, 185, 239], "isonli": 41, "issu": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 242, 244, 252, 253], "item": [25, 42, 44, 73, 89, 91, 151, 185, 188, 189, 222, 251], "item_cost": [89, 91], "iter": [2, 25, 41, 43, 44, 46, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 239, 240, 253, 279], "iter_tkn": [42, 43, 44], "iterable_compon": 41, "its": [2, 7, 12, 26, 28, 29, 32, 36, 41, 42, 43, 44, 48, 49, 51, 52, 61, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 114, 125, 126, 127, 128, 129, 130, 131, 132, 133, 151, 154, 155, 156, 157, 164, 165, 173, 174, 178, 185, 187, 188, 189, 192, 193, 218, 219, 221, 222, 224, 239, 240, 241, 244, 252, 253, 279], "itself": [52, 132, 222, 240], "izod": [137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147], "join": [25, 124, 279], "just": [52, 104, 197, 204], "k": [42, 124, 243, 249, 279], "k_loss": 279, "k_parasit": 279, "keep": [46, 167, 188, 189], "kei": [2, 41, 42, 43, 44, 48, 49, 52, 73, 84, 85, 86, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 188, 189, 206, 207, 208, 209, 210, 211, 215, 219, 222, 228, 240, 242, 243, 253], "kept": 167, "key_f": [2, 42, 43, 44, 48, 49, 62, 65, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 240, 253], "keyerror": 42, "keyword": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 185, 188, 189, 219, 222, 229, 240, 242, 253, 257], "kfit": 128, "kind": [7, 9, 11, 14, 15, 29, 235, 279], "knowledg": 185, "known": [119, 121], "kv": 68, "kw": [2, 7, 22, 29, 30, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 171, 185, 188, 189, 219, 220, 222, 229, 234, 236, 240, 243, 245, 247, 248, 253], "kw_dict": [188, 189], "kw_onli": [7, 9, 10, 14, 22, 25, 29, 33], "kwarg": [2, 7, 9, 10, 11, 14, 15, 19, 22, 25, 29, 30, 33, 34, 39, 42, 43, 44, 48, 49, 52, 55, 56, 64, 72, 73, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 177, 178, 179, 183, 185, 188, 189, 194, 198, 199, 200, 201, 219, 220, 222, 227, 234, 235, 237, 240, 253, 257], "kwargument": 220, "l": 158, "la": 239, "label": [14, 93, 197, 204, 279], "lambda": [2, 42, 43, 44, 48, 49, 62, 65, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 240, 253], "larg": [43, 73], "last": [2, 42, 43, 44, 48, 49, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 185, 188, 189, 240, 253], "last_context": [2, 42, 43, 44, 48, 49, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240, 253], "later": [2, 7, 10, 22, 25, 33, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "law": 279, "lcoe": 92, "learn": 151, "least": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "legend": 279, "length": [116, 158, 236], "less": [2, 29, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "leval": 89, "level": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 83, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 175, 187, 188, 189, 191, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 239, 240, 241, 244, 252, 253, 279], "levels_deep": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "levels_to_descend": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "lh": 29, "librari": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253, 279], "lifecycl": 92, "lifecycle_datafram": 92, "lifecycle_output": 92, "like": [7, 42, 89, 192, 220], "limit": [29, 239], "limit_max": 279, "line": 14, "linear": 124, "linear_output": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "linear_step": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "lineplot": 279, "link": 242, "list": [2, 14, 20, 42, 43, 44, 48, 49, 52, 62, 84, 85, 86, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 188, 189, 219, 222, 236, 238, 240, 253, 257, 279], "ll": 124, "load": 151, "loc": 279, "local": [151, 239], "local_inertia": 151, "localhost": 279, "locat": [2, 42, 43, 44, 48, 49, 73, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 189, 219, 222, 240, 253, 279], "locate_ref": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "log": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 243, 244, 252, 253], "logger": [12, 26, 28, 32, 36, 51, 61, 73, 90, 114, 130, 164, 165, 173, 174, 187, 193, 218, 219, 221, 222, 224, 241, 244, 252, 253], "loggingmixin": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "logic": [2, 13, 119, 132, 240], "long": 236, "longer": [188, 189], "look": [7, 132, 168, 220, 222, 240], "look_back_num": [188, 189], "lookup": 227, "loop": [2, 25, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253, 279], "loss": [129, 158, 159, 160, 161, 279], "low": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "lower": 151, "lowest": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "lst": [37, 180], "lvl": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "m": 279, "m1": [98, 100], "m2": [98, 100], "machin": [119, 279], "made": [2, 85, 132, 188, 189, 222, 227, 240], "magenta": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "mai": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 185, 219, 222, 239, 240, 253, 279], "mainli": [7, 9, 10, 14, 22, 25, 29, 33], "maintain": 198, "mainten": 93, "make": [2, 7, 9, 10, 13, 14, 22, 25, 29, 33, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 134, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 243, 253, 279], "make_attribut": [7, 9, 10, 14, 22, 25, 29, 33], "make_plot": [2, 13, 132, 240], "manag": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 185, 189, 219, 222, 240, 253], "mani": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "manipul": 60, "manufactur": 89, "map": [17, 52], "mark": [132, 240], "mark_all_comps_chang": [132, 240], "mass": [98, 100, 151, 158, 159, 160, 161], "massflow": 158, "massrat": [98, 100], "mat": 152, "match": [132, 222, 240, 267], "materi": [97, 98, 99, 100, 101, 102, 104, 108, 109, 110, 111, 119, 127, 128, 129, 146, 151], "math": 185, "matplotlib": [14, 279], "matrici": [83, 85, 132, 240], "matrix": [42, 43, 44, 48, 83, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 152, 154, 155, 156, 157, 240], "max": [7, 29, 132, 133, 151, 222, 235, 239, 240, 279], "max_flow": 133, "max_it": 119, "max_pressur": 133, "max_record": 119, "max_von_mis": 151, "max_von_mises_by_cas": 151, "maximum": 121, "maxium_service_temp": [137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147], "mdot": [154, 157], "mdot_c": 155, "mdot_h": 155, "mean": [132, 188, 189, 222, 240], "meant": [7, 9, 10, 14, 22, 25, 29, 33], "measur": [113, 115, 117, 118, 119, 120, 135, 161], "meet": 279, "melting_point": [137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147], "membership": [243, 249], "memori": [167, 168, 279], "mesh": 119, "mesh_extent_decim": 119, "mesh_sect": 119, "messag": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "message_with_identii": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "meta": [22, 33, 192, 197, 204], "metaclass": [177, 178, 179, 184], "metadata": [7, 9, 10, 14, 22, 25, 29, 33, 56], "method": [2, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 22, 23, 25, 26, 28, 29, 30, 32, 33, 34, 36, 39, 42, 43, 44, 46, 48, 49, 51, 52, 61, 62, 64, 72, 73, 84, 85, 86, 90, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 116, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 162, 164, 165, 168, 173, 174, 177, 178, 179, 183, 185, 187, 188, 189, 193, 194, 197, 198, 199, 200, 201, 204, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 220, 221, 222, 224, 240, 241, 242, 243, 244, 252, 253, 279], "methodologi": [132, 222, 240], "mfin": 156, "middl": [2, 7, 9, 10, 14, 22, 25, 29, 33, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "might": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "min": [7, 29, 132, 222, 235, 239, 240, 279], "min_est_record": 119, "min_kw": [85, 132, 240], "min_mesh_angl": 119, "min_mesh_s": [119, 151], "min_rec": [113, 115, 117, 118, 119, 120, 135], "minim": [132, 188, 189, 222, 227, 236, 237, 240], "minimum": [159, 160], "misc": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "miscellan": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "miss": 73, "mix": 124, "mixin": [2, 42, 43, 44, 48, 49, 52, 83, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 213, 240], "mixtur": 100, "mkdir": 279, "mode": [7, 22, 41, 89, 91, 93, 119, 151, 185, 279], "model": [83, 84, 89, 91, 113, 115, 117, 118, 119, 120, 135, 151], "modif": [83, 84], "modifi": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 83, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 237, 240, 241, 244, 252, 253], "modul": [8, 21, 24, 60, 83, 84, 97, 98, 99, 100, 102, 108, 109, 110, 111, 134, 185, 242, 251, 259, 262, 266, 279], "modular": 279, "modulu": [137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147], "molar": [98, 100], "momentum": [127, 128, 129], "monthli": 279, "more": [29, 113, 115, 117, 118, 119, 120, 135, 151, 279], "mount": 279, "move": 124, "mro": [177, 179], "msg": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 175, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "much": [9, 14], "mult": [119, 247, 250], "mult_sigma": [113, 115, 117, 118, 119, 120, 135], "multipl": [14, 25, 89, 93, 219, 279], "multivari": 116, "must": [7, 29, 92, 184, 204, 239, 242, 243], "mutlipl": 185, "mxx": [119, 121], "myclass": [177, 179], "myi": [119, 121], "mzz": [119, 121], "n": [37, 113, 115, 117, 118, 119, 120, 121, 135, 180], "n_frac": 279, "name": [2, 7, 9, 10, 12, 14, 20, 22, 25, 26, 28, 29, 32, 33, 36, 42, 43, 44, 48, 49, 51, 52, 57, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 173, 174, 184, 185, 187, 188, 189, 193, 198, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "nan": [91, 92, 151], "narrow": 279, "nasa": 239, "ndarrai": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "nearest": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 222, 240], "neither": [2, 13, 132, 240], "nessicari": 72, "network": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "networkx": 132, "never": [91, 151, 279], "new": [20, 178, 188, 189, 220, 279], "new_config": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "new_log_level": 175, "new_nam": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "new_valu": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "nice": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 197, 204, 240], "nincr": 119, "node": [126, 132], "node_": 127, "node_or_pip": 132, "non": [178, 220], "non_default_connection_arg": 72, "none": [2, 7, 9, 10, 12, 13, 14, 19, 20, 22, 25, 26, 28, 29, 32, 33, 36, 38, 39, 42, 43, 44, 48, 49, 51, 52, 55, 56, 61, 62, 64, 72, 73, 84, 85, 89, 90, 91, 92, 93, 94, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 166, 168, 171, 173, 174, 175, 183, 187, 188, 189, 190, 191, 193, 194, 197, 198, 199, 200, 201, 204, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 226, 227, 228, 229, 230, 231, 232, 234, 236, 237, 240, 241, 243, 244, 246, 247, 250, 252, 253], "none_ok": [2, 25, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "nonlinear": [42, 43, 44, 48, 83, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "nonlinear_output": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "nonlinear_step": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "norm": 233, "normal": [119, 192, 237], "noth": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 188, 189, 197, 219, 222, 240, 253], "notifi": 204, "np": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240, 279], "nparm": 119, "npss": [239, 279], "number": [44, 73, 119], "numer": [2, 7, 29, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 239, 240, 253], "numeric_onli": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "numericproperti": 239, "numpi": [91, 279], "numpy_arrai": 74, "numpy_float32": 75, "numpy_float64": 76, "numpy_int32": 77, "numpy_int64": 78, "o": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 167, 240, 266, 279], "obj": [29, 38, 132, 188, 189, 222, 240], "obj_f": 237, "object": [2, 13, 20, 29, 34, 38, 42, 43, 44, 46, 48, 49, 52, 55, 62, 73, 84, 85, 86, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 116, 117, 118, 119, 120, 121, 125, 126, 127, 128, 129, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 177, 178, 179, 184, 185, 188, 189, 197, 199, 204, 219, 220, 222, 229, 236, 237, 240, 242, 243], "obscur": [167, 168], "observ": 240, "observe_and_predict": [113, 115, 117, 118, 119, 120, 135], "occcur": 279, "occur": 185, "occurr": 44, "od": 7, "often": [132, 240, 279], "ok": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 236, 240, 253], "on_miss": 73, "on_setattr": [2, 7, 9, 10, 14, 22, 25, 29, 33, 42, 43, 44, 48, 49, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 201, 240, 253], "onc": [2, 43, 185, 189, 239, 279], "one": [2, 41, 42, 43, 44, 48, 49, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 119, 124, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 178, 239, 240, 246, 253], "ones": [2, 42, 43, 44, 48, 49, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240, 253], "onetim": [7, 9, 10, 14, 22, 25, 29, 33], "onli": [2, 9, 10, 12, 14, 26, 28, 32, 36, 41, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 178, 185, 187, 188, 189, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 237, 240, 241, 243, 244, 252, 253, 279], "only_act": [132, 185, 188, 189, 222, 240], "only_combo": [132, 185, 188, 189, 222, 240], "only_inst": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "only_var": [132, 185, 188, 189, 222, 240], "open": [20, 73, 124, 279], "oper": [2, 5, 7, 9, 10, 14, 22, 23, 25, 29, 30, 33, 42, 43, 44, 48, 49, 52, 72, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 188, 189, 219, 222, 240, 253, 263], "oppos": 83, "opt": [188, 189], "optim": [7, 29, 42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 119, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 189, 227, 229, 239, 240, 242, 243], "option": [7, 9, 10, 14, 22, 25, 29, 33, 42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 167, 168, 175, 185, 188, 189, 222, 229, 236, 240], "orchestr": [85, 89, 239], "order": [7, 9, 10, 14, 22, 25, 29, 33, 41, 177, 179, 229, 236], "order_kei": [7, 9, 10, 14, 22, 25, 29, 33], "orient": 151, "origin": [85, 132, 188, 189, 236, 240], "oterwis": 25, "other": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 124, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 178, 188, 189, 219, 222, 229, 239, 240, 242, 253], "other_arg": 185, "otherwis": [2, 25, 41, 42, 43, 44, 48, 49, 62, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 119, 121, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 189, 222, 227, 236, 240, 246, 247, 253], "ottermat": 279, "otyp": [39, 183], "out": [2, 7, 9, 10, 14, 22, 25, 29, 33, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 238, 240], "outer": [25, 185, 188, 189, 279], "outerproduct": 25, "output": [42, 43, 44, 48, 83, 84, 85, 89, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 185, 188, 189, 192, 204, 240, 279], "output_st": [188, 189], "output_typ": 92, "outsid": [113, 115, 117, 118, 119, 120, 151], "over": [7, 25, 39, 41, 42, 43, 44, 48, 83, 84, 85, 89, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 183, 219, 240, 279], "overal": 83, "overhead": [197, 240], "overid": 236, "overrid": [2, 7, 11, 15, 22, 25, 29, 33, 42, 43, 44, 48, 49, 52, 84, 85, 89, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 168, 222, 240], "override_kw": [11, 15], "overriden": [2, 91, 151, 279], "overwrit": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "own": [2, 185], "p": [97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 124], "p1": 116, "p1d": 116, "p2": 116, "p2d": 116, "page": 279, "pair": 42, "paper": 279, "paral": 151, "param": [2, 7, 9, 10, 12, 13, 14, 22, 25, 26, 28, 29, 32, 33, 36, 42, 43, 44, 48, 49, 51, 52, 56, 61, 72, 73, 84, 85, 90, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 121, 125, 126, 127, 128, 129, 130, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 152, 154, 155, 156, 157, 158, 159, 160, 161, 164, 165, 168, 173, 174, 175, 187, 188, 189, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253, 257], "paramet": [2, 5, 7, 9, 10, 11, 12, 13, 14, 15, 20, 22, 25, 26, 28, 29, 30, 32, 33, 34, 36, 42, 43, 44, 48, 49, 51, 52, 61, 65, 67, 69, 72, 73, 84, 85, 86, 90, 91, 92, 93, 94, 95, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 166, 168, 169, 173, 174, 175, 185, 187, 188, 189, 190, 191, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 227, 229, 236, 238, 240, 241, 244, 252, 253, 279], "parameter_iter": 279, "parametr": [91, 151], "parasit": 279, "parent": [2, 41, 42, 43, 44, 48, 49, 84, 85, 89, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 189, 219, 222, 240, 253, 279], "parent_configurations_cl": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "parent_level": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "parial": [132, 222, 240], "parm": 119, "pars": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 189, 219, 220, 222, 240, 253], "parse_default": [188, 189], "parse_rtkwarg": 220, "parse_run_kwarg": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "parse_simulation_input": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "partial": [132, 222, 240], "particular": 7, "pass": [2, 7, 9, 10, 14, 22, 24, 25, 29, 30, 33, 42, 43, 44, 48, 49, 52, 73, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 168, 177, 179, 185, 188, 189, 219, 222, 240, 253, 257, 279], "passd": 72, "passthrough": 25, "password": 72, "path": [206, 207, 208, 209, 279], "pathlib": 279, "pattern": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 185, 219, 222, 240, 253], "pdf": 20, "pdfpage": 20, "pe": 185, "per": [20, 29, 59, 91, 132, 151, 185, 220, 222, 240, 251, 279], "perform": [5, 7, 9, 10, 14, 22, 23, 25, 29, 30, 33], "period": 215, "permit": 73, "permut": 119, "persist": 119, "persist_context": [188, 189], "phase": 124, "physic": 146, "pickl": [119, 184], "pickleabl": 72, "pin": [156, 157], "pip": 279, "pipeflow": [127, 128], "pipenod": 126, "pkl": 119, "place": [44, 132, 222, 236, 240], "placehold": 101, "plot": [2, 8, 10, 11, 13, 14, 15, 42, 43, 44, 48, 49, 52, 59, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 205, 212, 219, 222, 240, 253, 279], "plot_attribut": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "plot_cl": [11, 15], "plot_report": [2, 212, 279], "plot_var": [9, 10, 14], "plotable_vari": [2, 42, 43, 44, 48, 49, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240, 253], "plotbas": [9, 14], "plotclass": 11, "plotinst": [9, 10, 14, 15], "plotreport": [207, 210], "plots_latest": 279, "plottingmixin": [2, 240], "pluggabl": 279, "po": 279, "point": [116, 279], "pointer": 73, "poissons_ratio": [137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147], "polygon": 119, "pop": [42, 44, 242], "popitem": 42, "popul": 119, "port": 72, "portabl": 243, "pos_obj": [188, 189], "posit": [7, 29, 46, 132, 188, 189, 222, 229, 240], "possibl": [7, 9, 10, 14, 22, 25, 33, 167, 279], "post": [2, 52, 132, 188, 189, 220, 222, 240, 279], "post_execut": [188, 189, 239, 279], "post_process": [2, 279], "post_run_callback": [132, 222, 240], "post_upd": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "post_update_system": [188, 189], "postgr": 279, "potenti": [129, 132, 222, 240], "pout": 157, "power": [124, 133, 247, 250], "pr": 124, "pr_eq": 279, "pre": [2, 13, 22, 132, 188, 189, 220, 222, 240, 279], "pre_compil": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "pre_execut": [29, 188, 189, 239, 279], "pre_run_callback": [132, 222, 240], "pre_train_margin": 119, "precis": 119, "precreat": [197, 204], "predefin": 83, "predict": [113, 115, 117, 118, 119, 120], "prediction_goal_error": 119, "prediction_record": 119, "predictionmixin": [117, 134], "prefer": 279, "prepend": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "presens": 239, "present": [44, 91, 151], "pressur": [101, 129, 133, 159, 160, 161, 279], "pressure_ratio": [154, 156], "prevent": [73, 167, 168, 242], "primari": [83, 237], "print": 168, "print_env_var": [168, 279], "print_interv": 119, "priorti": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "privat": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "prob": [132, 190, 191, 222, 229, 234, 236, 240], "problem": [185, 186, 189, 190, 191, 220, 242, 243], "problem_opt_var": [188, 189], "problemexec": [185, 188, 190, 191, 220], "procedur": 242, "process": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253, 279], "product": 279, "profil": 119, "profile2d": [113, 115, 118, 119, 120, 151], "progam": 167, "program": [167, 198, 279], "progress": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253, 279], "proivd": 52, "prompt": 279, "prop": [42, 43, 44], "properti": [2, 7, 42, 43, 44, 48, 49, 52, 55, 56, 58, 62, 64, 84, 85, 89, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 188, 189, 206, 207, 208, 209, 210, 211, 215, 219, 222, 239, 240, 242, 243, 253, 279], "propig": 41, "propuls": 239, "provid": [9, 13, 42, 60, 64, 72, 89, 91, 93, 113, 115, 117, 118, 120, 135, 151, 167, 175, 185, 188, 189, 194, 197, 198, 199, 200, 201, 204, 215, 219, 222, 227, 243, 279], "pump": [124, 156], "purpos": [167, 168], "push": 242, "put": 220, "pyee": 175, "pyfunc": [39, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 183], "pylab": 279, "pynit": [112, 146, 151], "python": [185, 192], "q": [100, 124], "qp": 124, "queri": [132, 222, 240], "quick": [239, 279], "rais": [2, 42, 43, 44, 48, 49, 83, 84, 85, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 178, 185, 188, 189, 219, 222, 240, 253], "random": 204, "rang": [44, 185], "rate": [7, 42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 189, 222, 240], "rate_linear": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "rate_nonlinear": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "ratio": [98, 100, 119, 121, 159, 160], "raw": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 65, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 121, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "rc_overrid": 19, "re": [132, 162, 185, 240, 279], "reach": 239, "reactor": 175, "readi": 239, "real": 267, "realli": [91, 151, 197, 204], "reason": 185, "rebuild": 72, "rebuild_databas": 72, "recach": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "recalcul": 192, "reciev": 220, "recommen": 242, "recommend": [44, 132, 222, 240], "record": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 121, 125, 126, 127, 128, 129, 130, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 167, 168, 173, 174, 185, 187, 188, 189, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 251, 252, 253, 279], "record_st": [188, 189], "record_stress": 119, "recrus": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "rectangular": [113, 115, 118, 120], "recurs": [2, 7, 9, 10, 14, 22, 25, 29, 33, 38, 42, 43, 44, 48, 49, 52, 84, 85, 89, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253, 266], "recus": 185, "red": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "ref": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 189, 219, 222, 227, 240, 242, 246, 247, 248, 249, 253, 279], "ref_dxdt": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "refer": [2, 30, 41, 42, 43, 44, 46, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 185, 188, 189, 219, 220, 222, 227, 229, 235, 236, 239, 240, 242, 243, 253, 279], "referenc": 242, "refernc": 236, "reflect": 89, "refresh": [188, 189], "refresh_refer": [188, 189], "refset_get": 243, "refset_input": 243, "regard": 93, "regardless": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "rel": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "relat": [91, 151], "relationship": [8, 73], "reliabl": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "relplot": [9, 11, 15], "remov": [42, 44, 168, 185, 188, 189], "render": [9, 242, 243], "replac": [91, 184], "repor": [9, 10, 14], "report": [2, 41, 91, 92, 93, 239, 266], "report_mod": [206, 207, 208, 209, 279], "report_result": 2, "report_root": [206, 207, 208, 209, 210, 211, 215], "repr": [7, 9, 10, 14, 22, 25, 29, 33, 55], "repres": 189, "represent": 184, "request": [2, 48, 49, 84, 85, 91, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "requir": [2, 14, 29, 42, 43, 44, 48, 49, 84, 85, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253, 279], "reset": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 188, 189, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 220, 221, 222, 224, 236, 240, 241, 244, 252, 253, 279], "reset_context": [188, 189], "reset_data": [188, 189], "resetlog": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "resetsystemlog": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "residu": [132, 222, 240], "residual_rss": [132, 222, 240], "resolut": [20, 177, 179], "reson": 279, "respect": [89, 132, 185, 222, 240], "restrict": 178, "result": [2, 25, 39, 85, 92, 113, 115, 117, 118, 119, 120, 132, 134, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 167, 168, 178, 183, 184, 188, 189, 192, 197, 200, 222, 239, 240, 242, 243, 267], "retrain": [113, 115, 117, 118, 119, 120, 135], "retri": 73, "retriv": 93, "returend": [2, 13, 132, 234, 240], "return": [2, 7, 9, 10, 13, 14, 20, 22, 25, 29, 33, 39, 42, 43, 44, 48, 49, 52, 62, 64, 69, 73, 84, 85, 89, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 121, 125, 126, 127, 128, 129, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 152, 154, 155, 156, 157, 164, 177, 178, 179, 183, 184, 185, 188, 189, 194, 197, 198, 199, 200, 201, 204, 219, 220, 222, 226, 227, 229, 235, 240, 246, 247, 250, 253, 279], "return_al": [85, 132, 240], "return_data": [85, 132, 240], "return_pdf": 20, "return_ref": 235, "return_system": [85, 132, 240], "revers": [44, 188, 189], "revert": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 185, 188, 189, 190, 191, 219, 220, 222, 227, 240, 253], "revert_everi": [185, 188, 189], "revert_last": [185, 188, 189], "rga": 104, "rh": 29, "rho": [158, 159, 160], "rhoe": 161, "rhoi": 161, "ride": [113, 115, 117, 118, 119, 120, 151], "right": 279, "rmv": [188, 189], "root": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 188, 189, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 239, 240, 241, 244, 252, 253], "rotat": [151, 152], "rough": 127, "routin": [2, 7, 9, 10, 12, 14, 22, 25, 26, 28, 29, 32, 33, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 239, 240, 241, 244, 252, 253], "row": [2, 9, 25, 42, 43, 44, 48, 49, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 121, 125, 126, 127, 128, 129, 131, 133, 135, 151, 154, 155, 156, 157, 253, 279], "rule": 7, "run": [2, 25, 29, 40, 42, 43, 44, 48, 49, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 119, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 175, 185, 188, 189, 220, 222, 234, 239, 240, 279], "run_arg": 279, "run_id": 279, "run_internal_system": [132, 222, 240], "run_kwarg": 279, "run_solv": [85, 132, 240], "runtim": [168, 185, 192, 198], "sa": 279, "safe": [2, 42, 43, 44, 48, 49, 52, 72, 73, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 178, 192, 219, 222, 234, 240, 243, 253], "same": [7, 25, 29, 91, 151, 177, 179, 184, 185, 189, 236, 279], "sampl": [113, 115, 117, 118, 119, 120, 135], "save": [2, 20, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 94, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 185, 188, 189, 204, 219, 222, 240, 253, 279], "save_data": [185, 188, 189, 251], "save_on_exit": [132, 222, 240], "scatter": 14, "scatterplot": [9, 11, 15], "scheme": [22, 33], "scipi": [7, 29, 83, 227, 229, 239], "scope": [9, 10, 14, 72, 132, 222, 240], "score": [113, 115, 117, 118, 119, 120, 135], "score_data": [113, 115, 117, 118, 119, 120, 135], "seaborn": [9, 10, 14], "seaborn_context": 279, "seaborn_palett": 279, "seaborn_them": 279, "search": 279, "second": 73, "secondari": 237, "secret": [167, 168, 279], "secret_var_nam": 168, "secretvari": 168, "section": [113, 115, 117, 118, 119, 120, 121, 146, 151], "section_properti": 151, "sectionproperti": [112, 119], "secur": 168, "see": [151, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215], "seen": 38, "select": [43, 132, 185, 188, 189, 222, 240], "self": [2, 7, 9, 10, 14, 22, 25, 29, 33, 42, 43, 44, 48, 49, 52, 84, 85, 86, 89, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 168, 177, 178, 179, 185, 219, 220, 222, 240, 253, 279], "sep": 238, "separ": 124, "seq": 225, "sequenc": 44, "seri": [67, 72], "serializ": 72, "server": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "sesh": [188, 189], "session": [188, 189], "session_scop": 72, "set": [2, 14, 23, 29, 35, 41, 42, 43, 44, 48, 49, 52, 58, 64, 73, 83, 84, 85, 89, 91, 92, 93, 94, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 185, 188, 189, 194, 197, 198, 199, 200, 201, 204, 205, 219, 222, 236, 240, 242, 243, 249, 253], "set_checkpoint": [185, 188, 189], "set_default_cost": [91, 151], "set_fan_n": 279, "set_filter_w": 279, "set_i": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "set_ref_valu": [188, 189], "set_tim": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "set_titl": 279, "set_xlabel": 279, "setattr": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253, 257], "setdefault": 42, "settabl": [188, 189], "setup": 29, "setup_cal": 243, "setup_global_dynam": [85, 132, 240], "sever": [219, 279], "shape": 119, "shapelysect": 151, "shapelysection_": 119, "share_dr": 210, "shear": [137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147], "shear_modulu": [137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147], "sheet": 279, "shorthand": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "should": [2, 7, 12, 13, 26, 28, 29, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 89, 90, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 178, 187, 188, 189, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253, 279], "show_plot": 2, "sigma": [159, 160], "signal": [2, 5, 23, 30, 42, 43, 44, 48, 49, 52, 59, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 188, 189, 201, 219, 220, 222, 239, 240, 253], "signal_nam": 239, "signalinst": 22, "signals_attribut": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "signatur": [39, 93, 183], "sim": 279, "sim_matrix": [85, 132, 240], "similar": [11, 15, 185], "similarli": [7, 9, 10, 14, 22, 25, 29, 33], "simpl": [60, 151], "simul": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 239, 240, 253], "sinc": 197, "singl": [72, 83, 124, 206, 207, 208, 209, 215, 279], "singleton": [72, 73, 177, 179, 184, 185], "size": [37, 38, 113, 115, 117, 118, 119, 120, 135, 180], "skip": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240, 253], "skip_plot_var": [2, 42, 43, 44, 48, 49, 62, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 240, 253], "skip_principl": 151, "sklearn": 134, "slight": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "slope": 116, "slot": [2, 21, 24, 41, 42, 43, 44, 48, 49, 52, 59, 84, 85, 89, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 239, 240, 253], "slot__7081d854a38b4a7": [127, 128, 129], "slot__7782db09be534f57": 132, "slot__7b164a55fd5440bf": 127, "slot__a25909281b144bca": 127, "slot_item": 94, "slot_nam": [89, 91, 151, 239], "slot_ref": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "slots_attribut": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "slv_info": 234, "slv_kw": [188, 189], "slv_var": [185, 188, 189, 279], "sm": 279, "smart": 83, "smart_split_datafram": [2, 42, 43, 44, 48, 49, 62, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 240, 253], "so": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 185, 188, 189, 219, 220, 222, 240, 253, 279], "soil": [142, 143, 147], "sol2": 279, "solid": [113, 146], "solidmateri": [137, 138, 139, 140, 141, 142, 143, 144, 145, 147, 151], "solut": [188, 189, 236, 279], "solv": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 188, 189, 219, 222, 236, 239, 240, 253, 263, 279], "solvabl": [48, 49, 185, 188, 189], "solve_min": [185, 188, 189], "solveabl": [188, 189, 222], "solveableinterfac": [48, 240], "solveablemixin": [49, 84, 222, 253], "solver": [2, 5, 7, 27, 30, 42, 43, 44, 48, 49, 59, 83, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 185, 188, 189, 219, 227, 239, 240, 253, 279], "solver_cach": 192, "solver_inst": [132, 222, 226, 240], "solver_opt": [132, 222, 240], "solver_var": [132, 222, 240], "solverinst": 29, "solvermixin": [27, 220, 240], "solvers_attribut": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "solversystem": 279, "some": [42, 197, 204], "someth": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253, 279], "soon": 281, "sort": [64, 93, 194, 197, 198, 199, 200, 201, 204], "sourc": [2, 3, 5, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 22, 23, 25, 26, 28, 29, 30, 32, 33, 34, 36, 37, 38, 39, 40, 42, 43, 44, 45, 46, 48, 49, 51, 52, 55, 56, 57, 58, 59, 61, 62, 64, 65, 67, 69, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 84, 85, 86, 87, 90, 91, 92, 93, 94, 95, 99, 100, 101, 104, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 125, 126, 127, 128, 129, 130, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 151, 152, 154, 155, 156, 157, 158, 159, 160, 161, 162, 164, 165, 166, 168, 169, 171, 173, 174, 175, 177, 178, 179, 180, 181, 182, 183, 184, 186, 187, 188, 189, 190, 191, 193, 194, 197, 198, 199, 200, 201, 204, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 218, 219, 221, 222, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 240, 241, 243, 244, 245, 246, 247, 248, 249, 250, 252, 253, 255, 256, 257, 258, 279], "source_attr": 239, "source_attr_or_properti": 239, "space": [83, 84], "specif": [52, 185], "specifi": [2, 9, 12, 14, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 61, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 114, 125, 126, 127, 128, 129, 130, 131, 132, 133, 151, 154, 155, 156, 157, 164, 165, 173, 174, 186, 187, 188, 189, 193, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "specific_heat": [137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147], "speed": 119, "speedup": 243, "spline": 116, "split": [2, 42, 43, 44, 48, 49, 62, 69, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 189, 240, 253], "split_group": [2, 42, 43, 44, 48, 49, 62, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 240, 253], "splitter": 124, "springmass": 279, "squar": [132, 222, 240], "ss": [188, 189], "stabil": 279, "stainless": 145, "standard": 92, "start": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253, 279], "start_factor": 151, "stat_tab": [2, 42, 43, 44, 48, 49, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240, 253], "state": [2, 42, 43, 44, 48, 49, 52, 83, 84, 85, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 185, 188, 189, 219, 222, 234, 236, 239, 240, 242, 243, 279], "static": 239, "stationari": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "statist": 8, "std": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "steadi": [85, 132, 188, 189, 222, 240], "steel": [137, 138, 145], "step": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "still": 184, "stochast": [93, 197, 204], "stop": 44, "storag": [167, 188, 189, 219, 279], "store": [2, 42, 44, 52, 60, 83, 92, 168, 188, 189, 192, 212, 214, 229, 279], "store_figur": [2, 13, 132, 240], "str": [2, 7, 12, 14, 22, 26, 28, 29, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 169, 173, 174, 187, 191, 193, 204, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 227, 240, 241, 244, 252, 253, 279], "strategi": [2, 11, 15, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253, 279], "stress": [119, 121, 151], "stress_dict": 119, "stress_obj": 119, "string": [2, 7, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 184, 187, 188, 189, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 242, 244, 252, 253], "structur": [146, 151, 219, 279], "stuff": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "sub": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "sub_cost": [91, 151], "sub_items_cost": 91, "subclass": [2, 7, 9, 10, 14, 22, 25, 29, 31, 33, 42, 43, 44, 48, 49, 52, 73, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 174, 192, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 240, 253, 266], "subclass_of": 166, "subcls_compil": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "subcompon": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "subdictionari": [132, 222, 240], "subplot": 279, "subproblem": 189, "subsequ": [178, 185], "subsystem": [2, 13, 42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 239, 240], "success": [37, 180, 200, 236, 242], "suffici": [113, 115, 117, 118, 119, 120, 135], "sum": [89, 91, 132, 151, 222, 240], "sum_cost": [91, 151], "sum_dp": 279, "sumf": 279, "summar": [91, 92], "summari": 89, "support": [41, 44, 119, 185, 199, 279], "suptitl": [9, 14], "sweep": 279, "sy": [59, 132, 185, 222, 240], "symmetr": 119, "sys_kei": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "sys_kw": [85, 132, 222, 240], "sys_solver_constraint": [188, 189], "sys_solver_object": [188, 189], "system": [2, 5, 7, 8, 9, 10, 11, 13, 14, 15, 22, 23, 25, 27, 29, 30, 33, 34, 41, 42, 43, 44, 46, 48, 49, 52, 83, 84, 85, 89, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 124, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 185, 188, 189, 197, 204, 219, 220, 222, 227, 229, 234, 235, 236, 237, 242, 243, 253, 263], "system_id": [2, 42, 43, 44, 48, 49, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240, 253], "system_properti": [2, 7, 29, 42, 43, 44, 48, 49, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 192, 195, 196, 197, 202, 203, 240, 251, 253, 279], "system_properties_classdef": [2, 42, 43, 44, 48, 49, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240, 253], "system_refer": [2, 9, 10, 14, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "t": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 185, 187, 188, 189, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 239, 240, 241, 244, 252, 253], "tabl": [2, 41, 42, 43, 44, 48, 49, 72, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 189, 204, 205, 214, 240, 253], "table_report": [2, 214, 279], "tablereport": [206, 209, 211], "tabul": [2, 42, 43, 44, 48, 49, 83, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 204, 219, 222, 240, 279], "tabulationmixin": [2, 49, 91], "take": [2, 7, 10, 22, 25, 33, 91, 119, 132, 151, 178, 222, 235, 239, 240, 243], "target": [22, 23, 188, 189, 279], "target_attr": 239, "target_item": [113, 115, 117, 118, 119, 120, 135], "tci": 155, "technic": [72, 185], "temporalreportermixin": [208, 210, 211], "tensile_strength_ultim": [137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147], "tensor": 151, "term": [89, 91, 92, 93, 151], "term_length": [89, 92, 93], "termcolor": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "terms_per_year": 92, "test": [113, 115, 117, 118, 119, 120, 132, 135, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 222, 240, 279], "test_frac": [113, 115, 117, 118, 119, 120, 135], "test_val": [91, 151], "than": [2, 29, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 178, 240], "thei": [2, 42, 43, 44, 48, 49, 52, 84, 85, 89, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 188, 189, 219, 222, 240, 253], "them": [2, 42, 43, 44, 48, 49, 83, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 220, 222, 240, 253], "theme": 18, "therefor": [113, 115, 117, 118, 119, 120, 135], "thermal": 279, "thermal_conduct": [137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147], "thermal_expans": [137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147], "thi": [2, 7, 8, 9, 10, 12, 13, 14, 21, 22, 24, 25, 26, 28, 29, 32, 33, 36, 41, 42, 43, 44, 48, 49, 51, 52, 55, 58, 61, 64, 72, 73, 83, 84, 85, 89, 90, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 167, 168, 173, 174, 178, 185, 187, 188, 189, 193, 194, 197, 198, 199, 200, 201, 204, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 220, 221, 222, 224, 239, 240, 241, 242, 243, 244, 252, 253, 279], "thick": 115, "thin": 93, "this_dir": 279, "this_nam": [42, 43, 44], "those": [132, 222, 240], "though": 279, "thread": [72, 178], "threshold": [113, 115, 117, 118, 119, 120, 135], "throttl": 279, "through": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 173, 174, 187, 193, 218, 219, 220, 221, 222, 224, 240, 241, 242, 244, 252, 253], "thu": [188, 189], "time": [2, 5, 6, 14, 41, 42, 43, 44, 48, 49, 73, 83, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 185, 188, 189, 192, 201, 219, 222, 240, 253, 279], "timestep": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 219, 222, 240, 253], "tin": [154, 156, 157], "titl": [9, 14, 56, 279], "todo": [2, 11, 15, 25, 41, 42, 43, 44, 48, 49, 52, 83, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 185, 188, 189, 219, 222, 240, 253, 279], "togeth": [12, 26, 28, 32, 36, 51, 61, 73, 90, 114, 130, 164, 165, 173, 174, 187, 193, 218, 219, 221, 222, 224, 241, 244, 252, 253], "tolerr": [91, 151], "top": [65, 83, 189, 279], "total": [113, 115, 117, 118, 119, 120, 135], "trace": [2, 8, 13, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253, 279], "trace_attribut": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "traceinst": 14, "track": [46, 167], "train": [113, 115, 117, 118, 119, 120, 135], "train_compar": [113, 115, 117, 118, 119, 120, 135], "train_frac": [113, 115, 117, 118, 119, 120, 135], "train_ful": [113, 115, 117, 118, 119, 120, 135], "train_until_valid": 119, "training_callback": [113, 115, 117, 118, 119, 120, 135], "transact": 72, "transform": [7, 9, 10, 14, 22, 25, 29, 33, 152, 184], "transient": [2, 7, 8, 14, 27, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 189, 219, 220, 222, 240, 253, 267], "transients_attribut": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "trigger": [2, 13, 132, 240], "true": [2, 7, 9, 10, 13, 14, 20, 22, 25, 29, 33, 41, 42, 43, 44, 48, 49, 52, 58, 59, 72, 73, 84, 85, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 121, 125, 126, 127, 128, 129, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 168, 175, 179, 185, 188, 189, 204, 219, 222, 236, 240, 243, 249, 253, 279], "try": 178, "ttl": 73, "tupl": [2, 42, 43, 44, 48, 49, 52, 69, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "turbin": 157, "turbul": 162, "two": [100, 236], "type": [2, 7, 9, 10, 11, 12, 13, 14, 15, 20, 22, 24, 25, 26, 28, 29, 31, 32, 33, 36, 41, 42, 43, 44, 45, 46, 48, 49, 51, 52, 56, 61, 64, 69, 72, 73, 84, 85, 90, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 121, 125, 126, 127, 128, 129, 130, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 152, 154, 155, 156, 157, 158, 159, 160, 161, 164, 165, 166, 168, 173, 174, 175, 177, 179, 187, 188, 189, 193, 194, 197, 198, 199, 200, 201, 204, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 226, 227, 240, 241, 244, 250, 252, 253, 279], "type_conv": 168, "type_to_check": 3, "typeerror": 178, "typic": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 192, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "u": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240, 279], "ultim": [22, 33], "underli": [83, 204], "underscor": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "understand": 243, "uniform": [116, 185, 189], "uniniti": 189, "union": 14, "uniqu": [2, 42, 43, 44, 48, 49, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 185, 240, 253], "unit": [89, 175], "unless": [2, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 135, 151, 154, 155, 156, 157, 188, 189, 219, 222, 240, 253, 257], "unspecifi": [188, 189], "until": [119, 185, 189], "unus": [242, 243], "up": [2, 7, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 168, 229, 240], "updat": [2, 21, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 185, 188, 189, 192, 201, 219, 220, 222, 239, 240, 253, 279], "update_dflt_cost": [91, 151], "update_dynam": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "update_feedthrough": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "update_input": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "update_mass_ratio": [98, 100], "update_output_const": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "update_output_matrix": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "update_st": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "update_state_const": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "update_system": [188, 189], "upload": [212, 214], "upon": [178, 239, 240, 242, 279], "upper": 279, "us": [2, 7, 9, 10, 12, 14, 22, 25, 26, 27, 28, 29, 30, 32, 33, 36, 42, 43, 44, 48, 49, 51, 52, 55, 59, 61, 72, 73, 83, 84, 85, 89, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 167, 168, 173, 174, 178, 185, 187, 188, 189, 193, 197, 204, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 220, 221, 222, 224, 227, 235, 239, 240, 241, 242, 243, 244, 252, 253, 279], "use_cal": 243, "use_default": [188, 189], "use_dict": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "user": [2, 72, 132, 222, 240], "userdict": 42, "userlist": 44, "usernam": 72, "usual": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "ut_ref": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "util": [188, 189, 242], "uuid": 189, "v": [2, 42, 48, 49, 54, 84, 85, 91, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 124, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 189, 219, 222, 240, 253, 279], "val": [148, 235, 250], "valid": [2, 7, 9, 10, 14, 22, 25, 29, 33, 42, 43, 44, 48, 49, 52, 64, 84, 85, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 194, 197, 198, 199, 200, 201, 204, 240, 257], "validate_class": [2, 42, 43, 44, 48, 49, 52, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 240], "validate_plot_arg": [9, 10, 14], "valu": [2, 7, 9, 10, 14, 22, 25, 29, 33, 35, 42, 43, 44, 45, 48, 49, 52, 58, 62, 69, 83, 84, 85, 89, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 121, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 168, 188, 189, 198, 216, 219, 222, 227, 229, 234, 235, 236, 239, 240, 242, 243, 246, 247, 249, 251, 253, 279], "valueerror": 44, "valv": 124, "var": [2, 7, 9, 10, 11, 14, 15, 29, 42, 43, 44, 48, 49, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 167, 168, 185, 188, 189, 219, 222, 225, 227, 230, 231, 232, 235, 240, 253], "var_a": 279, "var_b": 279, "var_nam": 226, "var_ref": 235, "vara": 29, "variabl": [2, 29, 42, 43, 44, 48, 49, 52, 58, 69, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 167, 168, 188, 189, 192, 219, 222, 240, 243, 253], "varianc": [113, 115, 117, 118, 119, 120, 135], "variant": [2, 42, 43, 44, 48, 49, 62, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 240, 253], "variou": 279, "vec1": 152, "vec2": 152, "vector": [39, 116, 119, 127, 128, 129, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 152, 183], "version": [7, 9, 10, 14, 22, 25, 29, 33], "via": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 83, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 220, 221, 222, 224, 239, 240, 241, 242, 244, 252, 253, 279], "view": 42, "viscos": [101, 104], "von_mis": 119, "von_mises_stress_max": [137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147], "vonmis": [121, 151], "vtx": 279, "vx": [119, 121], "vxc": 124, "vy": [119, 121], "w": [266, 279], "w_design": 279, "wa": [25, 113, 115, 117, 118, 119, 120, 135, 240, 279], "wai": [2, 25, 42, 43, 44, 48, 49, 52, 72, 84, 85, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 168, 219, 222, 240, 243, 253, 279], "want": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "warn": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 175, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 243, 244, 249, 252, 253], "warn_on_non_costmodel": [91, 151], "water": 101, "watt": 133, "we": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 55, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "weight": [119, 188, 189, 229, 236], "well": [2, 13, 27, 89, 132, 167, 188, 189, 220, 239, 240], "wet": [143, 147], "what": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "when": [2, 7, 9, 10, 14, 22, 25, 29, 33, 41, 42, 43, 44, 48, 49, 52, 55, 58, 64, 84, 85, 89, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 135, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 152, 154, 155, 156, 157, 167, 185, 188, 189, 194, 197, 198, 199, 200, 201, 204, 219, 222, 237, 240, 253, 279], "where": [25, 83, 132, 220, 222, 236, 240, 279], "wherea": 279, "whether": [20, 185, 188, 189], "which": [2, 12, 14, 26, 28, 29, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 73, 83, 84, 85, 89, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 152, 154, 155, 156, 157, 164, 165, 173, 174, 184, 187, 193, 218, 219, 220, 221, 222, 224, 227, 229, 239, 240, 241, 243, 244, 252, 253, 279], "while": [83, 84], "white": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "wide": [25, 41, 42, 43, 44, 91, 151, 279], "widget": 89, "wildcard": [132, 222, 240], "window": [113, 115, 117, 118, 119, 120, 135], "wish": [7, 22, 29, 33], "without": [2, 42, 43, 44, 48, 49, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 185, 190, 191, 240, 253], "wo_f": 279, "won": 72, "work": [7, 9, 10, 14, 22, 25, 29, 33, 83, 84, 242, 279], "workflow": 279, "world": 267, "worst": 151, "wrap": [55, 168, 204, 279], "wrapper": [2, 42, 43, 44, 48, 49, 52, 56, 73, 84, 85, 91, 92, 93, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 219, 222, 240, 253], "write": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253, 279], "wrt": [188, 189], "x": [9, 11, 14, 15, 29, 42, 43, 44, 48, 79, 80, 81, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 119, 124, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 188, 189, 192, 222, 227, 229, 234, 236, 240, 242, 279], "x0": [85, 132, 222, 240], "x_frac": 151, "x_neutral": 279, "x_solver": 227, "xarrai": 29, "xlabel": 14, "xnew": [185, 188, 189], "xnext": 185, "xo": [132, 222, 236, 240], "xref": [185, 188, 189, 227, 229, 233, 234, 235, 236, 237], "xss": [188, 189], "xt": [132, 222, 240], "xt_ref": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "xtx": 279, "y": [9, 14, 119, 125, 126, 128, 131, 192, 229, 236, 279], "y2": [14, 279], "y2label": 14, "yellow": [2, 12, 26, 28, 32, 36, 42, 43, 44, 48, 49, 51, 52, 61, 72, 73, 84, 85, 90, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 114, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 130, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 165, 168, 173, 174, 187, 193, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 218, 219, 221, 222, 224, 240, 241, 244, 252, 253], "yet": 279, "yield": [37, 177, 179, 180], "yield_strength": [137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147], "ylabel": 14, "yobj": [188, 189], "you": [2, 7, 22, 29, 33, 42, 43, 44, 48, 49, 52, 72, 73, 84, 85, 91, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 113, 115, 117, 118, 119, 120, 125, 126, 127, 128, 129, 131, 132, 133, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 151, 154, 155, 156, 157, 164, 168, 197, 204, 219, 222, 240, 253], "your": [132, 206, 207, 208, 209, 210, 211, 215, 222, 240, 242, 279], "yref": [185, 188, 189, 229, 233, 236], "yt_ref": [42, 43, 44, 48, 84, 85, 92, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 125, 126, 127, 128, 129, 131, 132, 133, 151, 154, 155, 156, 157, 240], "z": [125, 126, 128, 131], "zero": [29, 91, 119, 151, 188, 189, 236, 243, 279]}, "titles": ["engforge", "engforge.analysis", "engforge.analysis.Analysis", "engforge.analysis.make_reporter_check", "engforge.attr_dynamics", "engforge.attr_dynamics.IntegratorInstance", "engforge.attr_dynamics.TRANSIENT", "engforge.attr_dynamics.Time", "engforge.attr_plotting", "engforge.attr_plotting.Plot", "engforge.attr_plotting.PlotBase", "engforge.attr_plotting.PlotInstance", "engforge.attr_plotting.PlotLog", "engforge.attr_plotting.PlottingMixin", "engforge.attr_plotting.Trace", "engforge.attr_plotting.TraceInstance", "engforge.attr_plotting.conv_ctx", "engforge.attr_plotting.conv_maps", "engforge.attr_plotting.conv_theme", "engforge.attr_plotting.install_seaborn", "engforge.attr_plotting.save_all_figures_to_pdf", "engforge.attr_signals", "engforge.attr_signals.Signal", "engforge.attr_signals.SignalInstance", "engforge.attr_slots", "engforge.attr_slots.Slot", "engforge.attr_slots.SlotLog", "engforge.attr_solver", "engforge.attr_solver.AttrSolverLog", "engforge.attr_solver.Solver", "engforge.attr_solver.SolverInstance", "engforge.attributes", "engforge.attributes.ATTRLog", "engforge.attributes.ATTR_BASE", "engforge.attributes.AttributeInstance", "engforge.common", "engforge.common.ForgeLog", "engforge.common.chunks", "engforge.common.get_size", "engforge.common.inst_vectorize", "engforge.common.is_ec2_instance", "engforge.component_collections", "engforge.component_collections.ComponentDict", "engforge.component_collections.ComponentIter", "engforge.component_collections.ComponentIterator", "engforge.component_collections.check_comp_type", "engforge.component_collections.iter_tkn", "engforge.components", "engforge.components.Component", "engforge.components.SolveableInterface", "engforge.configuration", "engforge.configuration.ConfigLog", "engforge.configuration.Configuration", "engforge.configuration.comp_transform", "engforge.configuration.conv_nms", "engforge.configuration.forge", "engforge.configuration.meta", "engforge.configuration.name_generator", "engforge.configuration.property_changed", "engforge.configuration.signals_slots_handler", "engforge.dataframe", "engforge.dataframe.DataFrameLog", "engforge.dataframe.DataframeMixin", "engforge.dataframe.dataframe_prop", "engforge.dataframe.dataframe_property", "engforge.dataframe.determine_split", "engforge.dataframe.df_prop", "engforge.dataframe.is_uniform", "engforge.dataframe.key_func", "engforge.dataframe.split_dataframe", "engforge.datastores", "engforge.datastores.data", "engforge.datastores.data.DBConnection", "engforge.datastores.data.DiskCacheStore", "engforge.datastores.data.addapt_numpy_array", "engforge.datastores.data.addapt_numpy_float32", "engforge.datastores.data.addapt_numpy_float64", "engforge.datastores.data.addapt_numpy_int32", "engforge.datastores.data.addapt_numpy_int64", "engforge.datastores.data.autocorrelation_direct", "engforge.datastores.data.autocorrelation_fft", "engforge.datastores.data.autocorrelation_numpy", "engforge.datastores.data.nan_to_null", "engforge.dynamics", "engforge.dynamics.DynamicsMixin", "engforge.dynamics.GlobalDynamics", "engforge.dynamics.INDEX_MAP", "engforge.dynamics.valid_mtx", "engforge.eng", "engforge.eng.costs", "engforge.eng.costs.CostLog", "engforge.eng.costs.CostModel", "engforge.eng.costs.Economics", "engforge.eng.costs.cost_property", "engforge.eng.costs.eval_slot_cost", "engforge.eng.costs.gend", "engforge.eng.fluid_material", "engforge.eng.fluid_material.Air", "engforge.eng.fluid_material.AirWaterMix", "engforge.eng.fluid_material.CoolPropMaterial", "engforge.eng.fluid_material.CoolPropMixture", "engforge.eng.fluid_material.FluidMaterial", "engforge.eng.fluid_material.Hydrogen", "engforge.eng.fluid_material.IdealAir", "engforge.eng.fluid_material.IdealGas", "engforge.eng.fluid_material.IdealH2", "engforge.eng.fluid_material.IdealOxygen", "engforge.eng.fluid_material.IdealSteam", "engforge.eng.fluid_material.Oxygen", "engforge.eng.fluid_material.SeaWater", "engforge.eng.fluid_material.Steam", "engforge.eng.fluid_material.Water", "engforge.eng.geometry", "engforge.eng.geometry.Circle", "engforge.eng.geometry.GeometryLog", "engforge.eng.geometry.HollowCircle", "engforge.eng.geometry.ParametricSpline", "engforge.eng.geometry.Profile2D", "engforge.eng.geometry.Rectangle", "engforge.eng.geometry.ShapelySection", "engforge.eng.geometry.Triangle", "engforge.eng.geometry.calculate_stress", "engforge.eng.geometry.conver_np", "engforge.eng.geometry.get_mesh_size", "engforge.eng.pipes", "engforge.eng.pipes.FlowInput", "engforge.eng.pipes.FlowNode", "engforge.eng.pipes.Pipe", "engforge.eng.pipes.PipeFitting", "engforge.eng.pipes.PipeFlow", "engforge.eng.pipes.PipeLog", "engforge.eng.pipes.PipeNode", "engforge.eng.pipes.PipeSystem", "engforge.eng.pipes.Pump", "engforge.eng.prediction", "engforge.eng.prediction.PredictionMixin", "engforge.eng.solid_materials", "engforge.eng.solid_materials.ANSI_4130", "engforge.eng.solid_materials.ANSI_4340", "engforge.eng.solid_materials.Aluminum", "engforge.eng.solid_materials.CarbonFiber", "engforge.eng.solid_materials.Concrete", "engforge.eng.solid_materials.DrySoil", "engforge.eng.solid_materials.Rock", "engforge.eng.solid_materials.Rubber", "engforge.eng.solid_materials.SS_316", "engforge.eng.solid_materials.SolidMaterial", "engforge.eng.solid_materials.WetSoil", "engforge.eng.solid_materials.ih", "engforge.eng.solid_materials.random_color", "engforge.eng.structure_beams", "engforge.eng.structure_beams.Beam", "engforge.eng.structure_beams.rotation_matrix_from_vectors", "engforge.eng.thermodynamics", "engforge.eng.thermodynamics.SimpleCompressor", "engforge.eng.thermodynamics.SimpleHeatExchanger", "engforge.eng.thermodynamics.SimplePump", "engforge.eng.thermodynamics.SimpleTurbine", "engforge.eng.thermodynamics.dp_he_core", "engforge.eng.thermodynamics.dp_he_entrance", "engforge.eng.thermodynamics.dp_he_exit", "engforge.eng.thermodynamics.dp_he_gas_losses", "engforge.eng.thermodynamics.fanning_friction_factor", "engforge.engforge_attributes", "engforge.engforge_attributes.AttributedBaseMixin", "engforge.engforge_attributes.EngAttr", "engforge.engforge_attributes.get_attributes_of", "engforge.env_var", "engforge.env_var.EnvVariable", "engforge.env_var.parse_bool", "engforge.locations", "engforge.locations.client_path", "engforge.logging", "engforge.logging.Log", "engforge.logging.LoggingMixin", "engforge.logging.change_all_log_levels", "engforge.patterns", "engforge.patterns.InputSingletonMeta", "engforge.patterns.Singleton", "engforge.patterns.SingletonMeta", "engforge.patterns.chunks", "engforge.patterns.flat2gen", "engforge.patterns.flatten", "engforge.patterns.inst_vectorize", "engforge.patterns.singleton_meta_object", "engforge.problem_context", "engforge.problem_context.IllegalArgument", "engforge.problem_context.ProbLog", "engforge.problem_context.Problem", "engforge.problem_context.ProblemExec", "engforge.problem_context.ProblemExit", "engforge.problem_context.ProblemExitAtLevel", "engforge.properties", "engforge.properties.PropertyLog", "engforge.properties.cache_prop", "engforge.properties.cached_sys_prop", "engforge.properties.cached_system_prop", "engforge.properties.cached_system_property", "engforge.properties.class_cache", "engforge.properties.engforge_prop", "engforge.properties.instance_cached", "engforge.properties.solver_cached", "engforge.properties.sys_prop", "engforge.properties.system_prop", "engforge.properties.system_property", "engforge.reporting", "engforge.reporting.CSVReporter", "engforge.reporting.DiskPlotReporter", "engforge.reporting.DiskReporterMixin", "engforge.reporting.ExcelReporter", "engforge.reporting.GdriveReporter", "engforge.reporting.GsheetsReporter", "engforge.reporting.PlotReporter", "engforge.reporting.Reporter", "engforge.reporting.TableReporter", "engforge.reporting.TemporalReporterMixin", "engforge.reporting.path_exist_validator", "engforge.solveable", "engforge.solveable.SolvableLog", "engforge.solveable.SolveableMixin", "engforge.solver", "engforge.solver.SolverLog", "engforge.solver.SolverMixin", "engforge.solver_utils", "engforge.solver_utils.SolverUtilLog", "engforge.solver_utils.arg_var_compare", "engforge.solver_utils.combo_filter", "engforge.solver_utils.create_constraint", "engforge.solver_utils.ext_str_list", "engforge.solver_utils.f_lin_min", "engforge.solver_utils.filt_active", "engforge.solver_utils.filter_combos", "engforge.solver_utils.filter_vals", "engforge.solver_utils.handle_normalize", "engforge.solver_utils.objectify", "engforge.solver_utils.ref_to_val_constraint", "engforge.solver_utils.refmin_solve", "engforge.solver_utils.secondary_obj", "engforge.solver_utils.str_list_f", "engforge.system", "engforge.system.System", "engforge.system.SystemsLog", "engforge.system_reference", "engforge.system_reference.Ref", "engforge.system_reference.RefLog", "engforge.system_reference.eval_ref", "engforge.system_reference.maybe_attr_inst", "engforge.system_reference.maybe_ref", "engforge.system_reference.refset_get", "engforge.system_reference.refset_input", "engforge.system_reference.scale_val", "engforge.tabulation", "engforge.tabulation.TableLog", "engforge.tabulation.TabulationMixin", "engforge.typing", "engforge.typing.NUMERIC_NAN_VALIDATOR", "engforge.typing.NUMERIC_VALIDATOR", "engforge.typing.Options", "engforge.typing.STR_VALIDATOR", "examples", "examples.air_filter", "examples.spring_mass", "test", "test.test_airfilter", "test.test_comp_iter", "test.test_composition", "test.test_costs", "test.test_dynamics", "test.test_dynamics_spaces", "test.test_four_bar", "test.test_modules", "test.test_performance", "test.test_pipes", "test.test_problem_deepscoping", "test.test_slider_crank", "test.test_solver", "test.test_tabulation", "<no title>", "Examples", "Welcome to engforge\u2019s documentation!", "Tests", "Tutorials"], "titleterms": {"": 279, "On": 279, "addapt_numpy_arrai": 74, "addapt_numpy_float32": 75, "addapt_numpy_float64": 76, "addapt_numpy_int32": 77, "addapt_numpy_int64": 78, "air": [97, 279], "air_filt": 260, "airwatermix": 98, "aluminum": 139, "analysi": [1, 2, 3, 279], "ansi_4130": 137, "ansi_4340": 138, "arg_var_compar": 225, "attr_bas": 33, "attr_dynam": [4, 5, 6, 7], "attr_plot": [8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20], "attr_sign": [21, 22, 23], "attr_slot": [24, 25, 26], "attr_solv": [27, 28, 29, 30], "attribut": [31, 32, 33, 34], "attributedbasemixin": 164, "attributeinst": 34, "attrlog": 32, "attrsolverlog": 28, "autocorrelation_direct": 79, "autocorrelation_fft": 80, "autocorrelation_numpi": 81, "beam": 151, "cache_prop": 194, "cached_sys_prop": 195, "cached_system_prop": 196, "cached_system_properti": 197, "calculate_stress": 121, "carbonfib": 140, "change_all_log_level": 175, "check_comp_typ": 45, "chunk": [37, 180], "circl": 113, "class_cach": 198, "client_path": 171, "combo_filt": 226, "common": [35, 36, 37, 38, 39, 40], "comp_transform": 53, "compon": [47, 48, 49, 279], "component_collect": [41, 42, 43, 44, 45, 46], "componentdict": 42, "componentit": 43, "componentiter": 44, "concret": 141, "configlog": 51, "configur": [50, 51, 52, 53, 54, 55, 56, 57, 58, 59], "conv_ctx": 16, "conv_map": 17, "conv_nm": 54, "conv_them": 18, "conver_np": 122, "coolpropmateri": 99, "coolpropmixtur": 100, "core": 279, "cost": [89, 90, 91, 92, 93, 94, 95], "cost_properti": 93, "costlog": 90, "costmodel": 91, "create_constraint": 227, "csvreport": 206, "damp": 279, "damper": 279, "data": [71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82], "datafram": [60, 61, 62, 63, 64, 65, 66, 67, 68, 69], "dataframe_prop": 63, "dataframe_properti": 64, "dataframelog": 61, "dataframemixin": 62, "datastor": [70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 279], "dbconnect": 72, "determine_split": 65, "df_prop": 66, "diskcachestor": 73, "diskplotreport": 207, "diskreportermixin": 208, "document": 279, "dp_he_cor": 158, "dp_he_entr": 159, "dp_he_exit": 160, "dp_he_gas_loss": 161, "drysoil": 142, "dynam": [83, 84, 85, 86, 87], "dynamicsmixin": 84, "econom": 92, "eng": [88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162], "engattr": 165, "engforg": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254, 255, 256, 257, 258, 279], "engforge_attribut": [163, 164, 165, 166], "engforge_prop": 199, "engin": 279, "env_var": [167, 168, 169], "environment": 279, "envvari": 168, "eval_ref": 245, "eval_slot_cost": 94, "exampl": [259, 260, 261, 278, 279], "excelreport": 209, "ext_str_list": 228, "f_lin_min": 229, "fanning_friction_factor": 162, "featur": 279, "filt_act": 230, "filter": 279, "filter_combo": 231, "filter_v": 232, "flat2gen": 181, "flatten": 182, "flowinput": 125, "flownod": 126, "fluid_materi": [96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111], "fluidmateri": 101, "forg": 55, "forgelog": 36, "function": 279, "gdrivereport": 210, "gend": 95, "geometri": [112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123], "geometrylog": 114, "get_attributes_of": 166, "get_mesh_s": 123, "get_siz": 38, "globaldynam": 85, "gsheetsreport": 211, "handle_norm": 233, "hollowcircl": 115, "hydrogen": 102, "idealair": 103, "idealga": 104, "idealh2": 105, "idealoxygen": 106, "idealsteam": 107, "ih": 148, "illegalargu": 186, "index_map": 86, "indic": 279, "inputsingletonmeta": 177, "inst_vector": [39, 183], "instal": 279, "install_seaborn": 19, "instance_cach": 200, "integratorinst": 5, "is_ec2_inst": 40, "is_uniform": 67, "iter_tkn": 46, "key_func": 68, "locat": [170, 171], "log": [172, 173, 174, 175], "loggingmixin": 174, "make_reporter_check": 3, "mass": 279, "maybe_attr_inst": 246, "maybe_ref": 247, "meta": 56, "mvp": 279, "name_gener": 57, "nan_to_nul": 82, "numeric_nan_valid": 255, "numeric_valid": 256, "objectifi": 234, "off": 279, "option": 257, "overview": 279, "oxygen": 108, "parametricsplin": 116, "parse_bool": 169, "path_exist_valid": 216, "pattern": [176, 177, 178, 179, 180, 181, 182, 183, 184], "pipe": [124, 125, 126, 127, 128, 129, 130, 131, 132, 133], "pipefit": 128, "pipeflow": 129, "pipelog": 130, "pipenod": 131, "pipesystem": 132, "plot": 9, "plotbas": 10, "plotinst": 11, "plotlog": 12, "plotreport": 212, "plottingmixin": 13, "predict": [134, 135], "predictionmixin": 135, "problem": [188, 279], "problem_context": [185, 186, 187, 188, 189, 190, 191], "problemexec": 189, "problemexit": 190, "problemexitatlevel": 191, "problog": 187, "profile2d": 117, "properti": [192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204], "property_chang": 58, "propertylog": 193, "pump": 133, "random_color": 149, "rectangl": 118, "ref": 243, "ref_to_val_constraint": 235, "reflog": 244, "refmin_solv": 236, "refset_get": 248, "refset_input": 249, "report": [205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 279], "result": 279, "rock": 143, "rotation_matrix_from_vector": 152, "rubber": 144, "save_all_figures_to_pdf": 20, "scale_v": 250, "seawat": 109, "secondary_obj": 237, "shapelysect": 119, "signal": [22, 279], "signalinst": 23, "signals_slots_handl": 59, "simplecompressor": 154, "simpleheatexchang": 155, "simplepump": 156, "simpleturbin": 157, "singleton": 178, "singleton_meta_object": 184, "singletonmeta": 179, "slot": [25, 279], "slotlog": 26, "solid_materi": [136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149], "solidmateri": 146, "solvablelog": 218, "solveabl": [217, 218, 219], "solveableinterfac": 49, "solveablemixin": 219, "solver": [29, 220, 221, 222], "solver_cach": 201, "solver_util": [223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238], "solverinst": 30, "solverlog": 221, "solvermixin": 222, "solverutillog": 224, "split_datafram": 69, "spring": 279, "spring_mass": 261, "ss_316": 145, "steam": 110, "str_list_f": 238, "str_valid": 258, "structure_beam": [150, 151, 152], "sys_prop": 202, "system": [239, 240, 241, 279], "system_prop": 203, "system_properti": 204, "system_refer": [242, 243, 244, 245, 246, 247, 248, 249, 250], "systemslog": 241, "tabl": 279, "tablelog": 252, "tablereport": 214, "tabul": [251, 252, 253], "tabulationmixin": 253, "temporalreportermixin": 215, "test": [262, 263, 264, 265, 266, 267, 268, 269, 270, 271, 272, 273, 274, 275, 276, 280], "test_airfilt": 263, "test_comp_it": 264, "test_composit": 265, "test_cost": 266, "test_dynam": 267, "test_dynamics_spac": 268, "test_four_bar": 269, "test_modul": 270, "test_perform": 271, "test_pip": 272, "test_problem_deepscop": 273, "test_slider_crank": 274, "test_solv": 275, "test_tabul": 276, "thermodynam": [153, 154, 155, 156, 157, 158, 159, 160, 161, 162], "time": 7, "trace": 14, "traceinst": 15, "transient": 6, "triangl": 120, "tutori": 281, "type": [254, 255, 256, 257, 258], "valid_mtx": 87, "variabl": 279, "water": 111, "welcom": 279, "wetsoil": 147, "wip": 279}}) \ No newline at end of file diff --git a/docs/_build/html/tests.html b/docs/_build/html/tests.html deleted file mode 100644 index 2d02bf0..0000000 --- a/docs/_build/html/tests.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - Tests — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • Tests
    • -
  • -
    • -
-
-
-
-
- -
-

Tests

- - - - - - -

test

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/_build/html/tutorials.html b/docs/_build/html/tutorials.html deleted file mode 100644 index f3abbad..0000000 --- a/docs/_build/html/tutorials.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - - Tutorials — engforge 1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • Tutorials
    • -
  • -
    • -
-
-
-
-
- -
-

Tutorials

-

coming soon…

-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/engforge.egg-info/PKG-INFO b/engforge.egg-info/PKG-INFO deleted file mode 100644 index 2ad2f47..0000000 --- a/engforge.egg-info/PKG-INFO +++ /dev/null @@ -1,9 +0,0 @@ -Metadata-Version: 2.1 -Name: engforge -Version: 0.1.0 -Summary: The Engineer's Framework -Home-page: https://github.com/SoundsSerious/engforge -Author: Kevin russell -Author-email: kevin@ottermatics.com -License: MIT -License-File: LICENSE diff --git a/engforge.egg-info/SOURCES.txt b/engforge.egg-info/SOURCES.txt deleted file mode 100644 index e8f97a7..0000000 --- a/engforge.egg-info/SOURCES.txt +++ /dev/null @@ -1,79 +0,0 @@ -LICENSE -README.md -setup.cfg -setup.py -engforge/__init__.py -engforge/_testing_components.py -engforge/analysis.py -engforge/attr_dynamics.py -engforge/attr_plotting.py -engforge/attr_signals.py -engforge/attr_slots.py -engforge/attr_solver.py -engforge/attributes.py -engforge/common.py -engforge/component_collections.py -engforge/components.py -engforge/configuration.py -engforge/dataframe.py -engforge/dynamics.py -engforge/engforge_attributes.py -engforge/env_var.py -engforge/locations.py -engforge/logging.py -engforge/patterns.py -engforge/problem_context.py -engforge/properties.py -engforge/reporting.py -engforge/solveable.py -engforge/solver.py -engforge/solver_utils.py -engforge/system.py -engforge/system_reference.py -engforge/tabulation.py -engforge/typing.py -engforge.egg-info/PKG-INFO -engforge.egg-info/SOURCES.txt -engforge.egg-info/dependency_links.txt -engforge.egg-info/not-zip-safe -engforge.egg-info/requires.txt -engforge.egg-info/top_level.txt -engforge/datastores/__init__.py -engforge/datastores/data.py -engforge/datastores/gdocs.py -engforge/datastores/reporting.py -engforge/datastores/secrets.py -engforge/eng/__init__.py -engforge/eng/costs.py -engforge/eng/fluid_material.py -engforge/eng/geometry.py -engforge/eng/pipes.py -engforge/eng/prediction.py -engforge/eng/solid_materials.py -engforge/eng/structure.py -engforge/eng/structure_beams.py -engforge/eng/thermodynamics.py -engforge/test/__init__.py -engforge/test/report_testing.py -engforge/test/test_airfilter.py -engforge/test/test_analysis.py -engforge/test/test_comp_iter.py -engforge/test/test_composition.py -engforge/test/test_costs.py -engforge/test/test_dynamics.py -engforge/test/test_dynamics_spaces.py -engforge/test/test_four_bar.py -engforge/test/test_modules.py -engforge/test/test_performance.py -engforge/test/test_pipes.py -engforge/test/test_problem.py -engforge/test/test_problem_deepscoping.py -engforge/test/test_slider_crank.py -engforge/test/test_solver.py -engforge/test/test_structures.py -engforge/test/test_tabulation.py -examples/__init__.py -examples/air_filter.py -examples/field_area.py -examples/spring_mass.py -test/test_problem.py \ No newline at end of file diff --git a/engforge.egg-info/dependency_links.txt b/engforge.egg-info/dependency_links.txt deleted file mode 100644 index 8b13789..0000000 --- a/engforge.egg-info/dependency_links.txt +++ /dev/null @@ -1 +0,0 @@ - diff --git a/engforge.egg-info/not-zip-safe b/engforge.egg-info/not-zip-safe deleted file mode 100644 index 8b13789..0000000 --- a/engforge.egg-info/not-zip-safe +++ /dev/null @@ -1 +0,0 @@ - diff --git a/engforge.egg-info/requires.txt b/engforge.egg-info/requires.txt deleted file mode 100644 index d1a63c7..0000000 --- a/engforge.egg-info/requires.txt +++ /dev/null @@ -1,30 +0,0 @@ -virtualenv -wheel -attrs>=23.1.0 -arrow -deepdiff>=6.3.1 -numpy==1.24.3 -scipy -matplotlib~=3.8.1 -jupyter -pandas -scikit-learn~=1.3.2 -seaborn -sectionproperties~=3.1.2 -PyNiteFEA@ git+https://github.com/Ottermatics/PyNite.git@v2nept -control -fluids -CoolProp -expiringdict~=1.2.2 -zipp==3.1.0 -jinja2>=2.11.3 -freezegun>=0.3.12 -sphinx>=3.2.1 -recommonmark>=0.6.0 -sphinx-rtd-theme>=1.0.0 -networkx-query==1.0.1 -networkx>=2.5.1 -randomname~=0.2.1 -termcolor -pyee -methodtools~=0.4.7 diff --git a/engforge.egg-info/top_level.txt b/engforge.egg-info/top_level.txt deleted file mode 100644 index 50be3ae..0000000 --- a/engforge.egg-info/top_level.txt +++ /dev/null @@ -1,2 +0,0 @@ -engforge -examples diff --git a/engforge/datastores/__init__.py b/engforge/datastores/__init__.py index c016d6a..8867cd7 100644 --- a/engforge/datastores/__init__.py +++ b/engforge/datastores/__init__.py @@ -1,21 +1,101 @@ -# Install datastores libraries -import os, pathlib, sys, subprocess +# Auto-install datastores dependencies from pyproject.toml +import sys +import subprocess +import importlib.util +from pathlib import Path -this_file = pathlib.Path(__file__) -this_dir = this_file.parent -req_file = os.path.join(this_dir, "datastores_requirements.txt") -# try: -import engforge.datastores.data +def get_project_root(): + """Find the project root containing pyproject.toml""" + current = Path(__file__).parent + while current.parent != current: + if (current / "pyproject.toml").exists(): + return current + current = current.parent + return None -# FIXME: works on every import error including this modules imports (circular buffer issue) -# except ImportError as e: -# print(f"got import error {e}") -# -# answer = input("type `CONFIRM` to install datastore requirements:") -# if answer.strip() == "CONFIRM": -# cmd = f'{sys.executable} -m pip install -r "{req_file}"' -# print(f"running: {cmd}") -# os.system(cmd) -# -# else: -# print("ok fine, enjoy your error then") +def install_optional_dependencies(group_name="database"): + """Install optional dependencies for a specific group""" + project_root = get_project_root() + if not project_root: + print("Could not find pyproject.toml. Manual installation required:") + print(f"pip install engforge[{group_name}]") + return False + + try: + # Try to import tomllib (Python 3.11+) or tomli (fallback) + try: + import tomllib + except ImportError: + import tomli as tomllib + + # Read pyproject.toml + with open(project_root / "pyproject.toml", "rb") as f: + config = tomllib.load(f) + + optional_deps = config.get("project", {}).get("optional-dependencies", {}) + if group_name not in optional_deps: + print(f"No optional dependency group '{group_name}' found") + return False + + # Install the optional dependencies + package_name = config.get("project", {}).get("name", "engforge") + install_spec = f"{package_name}[{group_name}]" + + print(f"Installing {install_spec}...") + result = subprocess.run([ + sys.executable, "-m", "pip", "install", install_spec + ], capture_output=True, text=True) + + if result.returncode == 0: + print(f"✅ Successfully installed {install_spec}") + return True + else: + print(f"❌ Failed to install {install_spec}") + print(f"Error: {result.stderr}") + return False + + except Exception as e: + print(f"Error during auto-installation: {e}") + print(f"Please install manually: pip install engforge[{group_name}]") + return False + +def check_and_install_datastores(): + """Check if datastores dependencies are available, auto-install if needed""" + try: + import engforge.datastores.data + return True + except ImportError as e: + print(f"Datastores dependencies not available: {e}") + print("") + + # Check if we're in development mode (editable install) and interactive + project_root = get_project_root() + is_interactive = hasattr(sys, 'ps1') or sys.stdout.isatty() + + if project_root and (project_root / "pyproject.toml").exists() and is_interactive: + try: + answer = input("Auto-install database dependencies? (y/N): ").strip().lower() + if answer in ['y', 'yes']: + if install_optional_dependencies("database"): + print("Please restart your Python session to use the newly installed dependencies.") + return False + else: + print("Auto-installation failed. Install manually with:") + print("pip install engforge[database]") + return False + else: + print("Install database dependencies with:") + print("pip install engforge[database]") + return False + except (EOFError, KeyboardInterrupt): + print("Install database dependencies with:") + print("pip install engforge[database]") + return False + else: + print("Install database dependencies with:") + print("pip install engforge[database]") + return False + +# Auto-check and install on import +if not check_and_install_datastores(): + pass # Dependencies not available, but user has been informed diff --git a/engforge/datastores/datastores_requirements.txt b/engforge/datastores/datastores_requirements.txt deleted file mode 100644 index 686d697..0000000 --- a/engforge/datastores/datastores_requirements.txt +++ /dev/null @@ -1,34 +0,0 @@ -#Remote -SQLAlchemy~=1.3.17 -SQLAlchemy-Utils -psycopg2-binary - -#Local -diskcache>=5.6.1 -expiringdict>=1.2.1 - -#Google -pygsheets==2.0.4 -pydrive2==1.8.1 - -#Networkign -#Twisted>=20.3.0 -#klein>=19.6.0 -#treq>=20.4.1 -#aiortc -#aiohttp>=3.6.3 -#aioice~=0.6.18 -#aioredis~=1.3.1 - -#Filesystem -#watchdog==0.10.3 -#watchgod==0.6 -#dropbox==10.6.0 - -#Supercomputing -boto3 - -#deco -ray[default]~=2.35.0 -ray[tune]~=2.35.0 -sqlalchemy-batch-inserts diff --git a/engforge/test/test_costs.py b/engforge/test/test_costs.py index 2399c51..e79867a 100644 --- a/engforge/test/test_costs.py +++ b/engforge/test/test_costs.py @@ -265,7 +265,7 @@ def test_dataframe(self): "fan.V": [1, 5, 10], "fan.area": [1, 5, 10], }, - base=[None, MetalBase()] + base=[None, MetalBase()], ) # Get the dataframe diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..a3ee5dd --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,110 @@ +[build-system] +requires = ["setuptools>=45", "wheel"] +build-backend = "setuptools.build_meta" + +[project] +name = "engforge" +version = "0.2.0" +description = "The Engineer's Framework" +readme = "README.md" +license = "MIT" +authors = [ + {name = "Kevin Russell", email = "kevin@ottermatics.com"} +] +classifiers = [ + "Development Status :: 3 - Alpha", + "Intended Audience :: Developers", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", +] +requires-python = ">=3.9" +dependencies = [ + "virtualenv", + "wheel", + "attrs~=23.2.0", + "arrow", + "deepdiff>=6.3.1", + "numpy==1.24.3", + "scipy", + "matplotlib~=3.8.1", + "jupyter", + "pandas", + "scikit-learn~=1.3.2", + "seaborn", + "tabulate", + "sectionproperties~=3.1.2", + "PyNiteFEA @ git+https://github.com/Ottermatics/PyNite.git@v2nept", + "control", + "fluids", + "CoolProp", + "expiringdict~=1.2.2", + "zipp==3.1.0", + "jinja2>=2.11.3", + "freezegun>=0.3.12", + "sphinx>=3.2.1", + "recommonmark>=0.6.0", + "sphinx-rtd-theme>=1.0.0", + "networkx-query==1.0.1", + "networkx>=2.5.1", + "black~=24.8.0", + "randomname~=0.2.1", + "termcolor", + "pyee", + "methodtools~=0.4.7", + "tomli>=1.2.0;python_version<'3.11'" +] + +[project.urls] +Homepage = "https://github.com/Ottermatics/engforge" +Repository = "https://github.com/Ottermatics/engforge" +Documentation = "https://ottermatics.github.io/engforge/" + +[project.optional-dependencies] +database = [ + "SQLAlchemy~=1.3.17", + "SQLAlchemy-Utils", + "psycopg2-binary", + "diskcache>=5.6.1", + "sqlalchemy-batch-inserts", +] +google = [ + "pygsheets==2.0.4", + "pydrive2==1.8.1", +] +cloud = [ + "boto3", +] +distributed = [ + "ray[default]~=2.35.0", + "ray[tune]~=2.35.0", +] +all = [ + "engforge[database,google,cloud,distributed]", +] + +[tool.setuptools] +include-package-data = true +zip-safe = false + +[tool.setuptools.packages.find] +include = ["engforge*"] + +[tool.black] +line-length = 88 +target-version = ["py39", "py310", "py311"] +include = '\.pyi?$' +extend-exclude = ''' +/( + # directories + \.eggs + | \.git + | \.hg + | \.mypy_cache + | \.tox + | \.venv + | build + | dist +)/ +''' \ No newline at end of file diff --git a/setup.py b/setup.py deleted file mode 100644 index f1e61f2..0000000 --- a/setup.py +++ /dev/null @@ -1,47 +0,0 @@ -#!/usr/bin/env python2 -# -*- coding: utf-8 -*- -""" -Created on Sat May 11 22:38:11 2019 - -@author: kevinrussell -""" - -from setuptools import setup -import setuptools - -__version__ = "0.1.0" - - -def parse_requirements(filename): - """load requirements from a pip requirements file""" - lineiter = (line.strip() for line in open(filename)) - return [line for line in lineiter if line and not line.startswith("#")] - - -install_reqs = parse_requirements("requirements.txt") - -setup( - name="engforge", - version=__version__, - description="The Engineer's Framework", - url="https://github.com/SoundsSerious/engforge", - author="Kevin russell", - # packages=["ottermatics"], - packages=setuptools.find_packages(), - author_email="kevin@ottermatics.com", - license="MIT", - entry_points={ - "console_scripts": [ - # command = package.module:function - # "condaenvset=engforge.common:main_cli", - # "ollymakes=engforge.locations:main_cli", - # "engforgedrive=engforge.gdocs:main_cli", - # TODO: inspect folders / list / display components + solver options - # TODO: test adhoc modules with - # TODO: run analysis adhoc on components with cli options - ] - }, - install_requires=install_reqs, - include_package_data=True, - zip_safe=False, -)