diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index bceffc6..5f276d3 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -14,7 +14,7 @@ jobs: uses: code-specialist/pypi-poetry-publish@v1.2 with: PACKAGE_DIRECTORY: "./src/simstock/" - PYTHON_VERSION: "3.9" + PYTHON_VERSION: "3.13" POETRY_VERSION: "1.4.2" ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }} BRANCH: "main" diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 37ff526..edf793f 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -8,17 +8,21 @@ on: jobs: test: runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + python-version: ["3.11", "3.12", "3.13"] steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - - uses: actions/setup-python@v4 + - uses: actions/setup-python@v5 with: - python-version: 3.9 + python-version: ${{ matrix.python-version }} # Cache the installation of Poetry itself, e.g. the next step. This prevents the workflow # from installing Poetry every time which can be slow - name: Cache Poetry install - uses: actions/cache@v3 + uses: actions/cache@v4 with: path: ~/.local key: poetry-1.4.2 @@ -33,10 +37,10 @@ jobs: # Cache your dependencies - name: Cache deps id: cache-deps - uses: actions/cache@v3 + uses: actions/cache@v4 with: path: .venv - key: pydeps-${{ hashFiles('**/poetry.lock') }} + key: pydeps-${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }} # Install dependencies - run: poetry install --no-interaction --no-root @@ -56,4 +60,5 @@ jobs: run: poetry run python -m unittest -v - name: Build Docs + if: matrix.python-version == '3.13' run: poetry run sphinx-build -n -b html docs/source docs/build/html diff --git a/.gitignore b/.gitignore index 1414de3..9dd6ee5 100644 --- a/.gitignore +++ b/.gitignore @@ -32,6 +32,7 @@ share/python-wheels/ *.egg MANIFEST .vscode/ +.venv/ # Django stuff: *.log diff --git a/.venv/bin/Activate.ps1 b/.venv/bin/Activate.ps1 deleted file mode 100644 index b49d77b..0000000 --- a/.venv/bin/Activate.ps1 +++ /dev/null @@ -1,247 +0,0 @@ -<# -.Synopsis -Activate a Python virtual environment for the current PowerShell session. - -.Description -Pushes the python executable for a virtual environment to the front of the -$Env:PATH environment variable and sets the prompt to signify that you are -in a Python virtual environment. Makes use of the command line switches as -well as the `pyvenv.cfg` file values present in the virtual environment. - -.Parameter VenvDir -Path to the directory that contains the virtual environment to activate. The -default value for this is the parent of the directory that the Activate.ps1 -script is located within. - -.Parameter Prompt -The prompt prefix to display when this virtual environment is activated. By -default, this prompt is the name of the virtual environment folder (VenvDir) -surrounded by parentheses and followed by a single space (ie. '(.venv) '). - -.Example -Activate.ps1 -Activates the Python virtual environment that contains the Activate.ps1 script. - -.Example -Activate.ps1 -Verbose -Activates the Python virtual environment that contains the Activate.ps1 script, -and shows extra information about the activation as it executes. - -.Example -Activate.ps1 -VenvDir C:\Users\MyUser\Common\.venv -Activates the Python virtual environment located in the specified location. - -.Example -Activate.ps1 -Prompt "MyPython" -Activates the Python virtual environment that contains the Activate.ps1 script, -and prefixes the current prompt with the specified string (surrounded in -parentheses) while the virtual environment is active. - -.Notes -On Windows, it may be required to enable this Activate.ps1 script by setting the -execution policy for the user. You can do this by issuing the following PowerShell -command: - -PS C:\> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser - -For more information on Execution Policies: -https://go.microsoft.com/fwlink/?LinkID=135170 - -#> -Param( - [Parameter(Mandatory = $false)] - [String] - $VenvDir, - [Parameter(Mandatory = $false)] - [String] - $Prompt -) - -<# Function declarations --------------------------------------------------- #> - -<# -.Synopsis -Remove all shell session elements added by the Activate script, including the -addition of the virtual environment's Python executable from the beginning of -the PATH variable. - -.Parameter NonDestructive -If present, do not remove this function from the global namespace for the -session. - -#> -function global:deactivate ([switch]$NonDestructive) { - # Revert to original values - - # The prior prompt: - if (Test-Path -Path Function:_OLD_VIRTUAL_PROMPT) { - Copy-Item -Path Function:_OLD_VIRTUAL_PROMPT -Destination Function:prompt - Remove-Item -Path Function:_OLD_VIRTUAL_PROMPT - } - - # The prior PYTHONHOME: - if (Test-Path -Path Env:_OLD_VIRTUAL_PYTHONHOME) { - Copy-Item -Path Env:_OLD_VIRTUAL_PYTHONHOME -Destination Env:PYTHONHOME - Remove-Item -Path Env:_OLD_VIRTUAL_PYTHONHOME - } - - # The prior PATH: - if (Test-Path -Path Env:_OLD_VIRTUAL_PATH) { - Copy-Item -Path Env:_OLD_VIRTUAL_PATH -Destination Env:PATH - Remove-Item -Path Env:_OLD_VIRTUAL_PATH - } - - # Just remove the VIRTUAL_ENV altogether: - if (Test-Path -Path Env:VIRTUAL_ENV) { - Remove-Item -Path env:VIRTUAL_ENV - } - - # Just remove VIRTUAL_ENV_PROMPT altogether. - if (Test-Path -Path Env:VIRTUAL_ENV_PROMPT) { - Remove-Item -Path env:VIRTUAL_ENV_PROMPT - } - - # Just remove the _PYTHON_VENV_PROMPT_PREFIX altogether: - if (Get-Variable -Name "_PYTHON_VENV_PROMPT_PREFIX" -ErrorAction SilentlyContinue) { - Remove-Variable -Name _PYTHON_VENV_PROMPT_PREFIX -Scope Global -Force - } - - # Leave deactivate function in the global namespace if requested: - if (-not $NonDestructive) { - Remove-Item -Path function:deactivate - } -} - -<# -.Description -Get-PyVenvConfig parses the values from the pyvenv.cfg file located in the -given folder, and returns them in a map. - -For each line in the pyvenv.cfg file, if that line can be parsed into exactly -two strings separated by `=` (with any amount of whitespace surrounding the =) -then it is considered a `key = value` line. The left hand string is the key, -the right hand is the value. - -If the value starts with a `'` or a `"` then the first and last character is -stripped from the value before being captured. - -.Parameter ConfigDir -Path to the directory that contains the `pyvenv.cfg` file. -#> -function Get-PyVenvConfig( - [String] - $ConfigDir -) { - Write-Verbose "Given ConfigDir=$ConfigDir, obtain values in pyvenv.cfg" - - # Ensure the file exists, and issue a warning if it doesn't (but still allow the function to continue). - $pyvenvConfigPath = Join-Path -Resolve -Path $ConfigDir -ChildPath 'pyvenv.cfg' -ErrorAction Continue - - # An empty map will be returned if no config file is found. - $pyvenvConfig = @{ } - - if ($pyvenvConfigPath) { - - Write-Verbose "File exists, parse `key = value` lines" - $pyvenvConfigContent = Get-Content -Path $pyvenvConfigPath - - $pyvenvConfigContent | ForEach-Object { - $keyval = $PSItem -split "\s*=\s*", 2 - if ($keyval[0] -and $keyval[1]) { - $val = $keyval[1] - - # Remove extraneous quotations around a string value. - if ("'""".Contains($val.Substring(0, 1))) { - $val = $val.Substring(1, $val.Length - 2) - } - - $pyvenvConfig[$keyval[0]] = $val - Write-Verbose "Adding Key: '$($keyval[0])'='$val'" - } - } - } - return $pyvenvConfig -} - - -<# Begin Activate script --------------------------------------------------- #> - -# Determine the containing directory of this script -$VenvExecPath = Split-Path -Parent $MyInvocation.MyCommand.Definition -$VenvExecDir = Get-Item -Path $VenvExecPath - -Write-Verbose "Activation script is located in path: '$VenvExecPath'" -Write-Verbose "VenvExecDir Fullname: '$($VenvExecDir.FullName)" -Write-Verbose "VenvExecDir Name: '$($VenvExecDir.Name)" - -# Set values required in priority: CmdLine, ConfigFile, Default -# First, get the location of the virtual environment, it might not be -# VenvExecDir if specified on the command line. -if ($VenvDir) { - Write-Verbose "VenvDir given as parameter, using '$VenvDir' to determine values" -} -else { - Write-Verbose "VenvDir not given as a parameter, using parent directory name as VenvDir." - $VenvDir = $VenvExecDir.Parent.FullName.TrimEnd("\\/") - Write-Verbose "VenvDir=$VenvDir" -} - -# Next, read the `pyvenv.cfg` file to determine any required value such -# as `prompt`. -$pyvenvCfg = Get-PyVenvConfig -ConfigDir $VenvDir - -# Next, set the prompt from the command line, or the config file, or -# just use the name of the virtual environment folder. -if ($Prompt) { - Write-Verbose "Prompt specified as argument, using '$Prompt'" -} -else { - Write-Verbose "Prompt not specified as argument to script, checking pyvenv.cfg value" - if ($pyvenvCfg -and $pyvenvCfg['prompt']) { - Write-Verbose " Setting based on value in pyvenv.cfg='$($pyvenvCfg['prompt'])'" - $Prompt = $pyvenvCfg['prompt']; - } - else { - Write-Verbose " Setting prompt based on parent's directory's name. (Is the directory name passed to venv module when creating the virtual environment)" - Write-Verbose " Got leaf-name of $VenvDir='$(Split-Path -Path $venvDir -Leaf)'" - $Prompt = Split-Path -Path $venvDir -Leaf - } -} - -Write-Verbose "Prompt = '$Prompt'" -Write-Verbose "VenvDir='$VenvDir'" - -# Deactivate any currently active virtual environment, but leave the -# deactivate function in place. -deactivate -nondestructive - -# Now set the environment variable VIRTUAL_ENV, used by many tools to determine -# that there is an activated venv. -$env:VIRTUAL_ENV = $VenvDir - -if (-not $Env:VIRTUAL_ENV_DISABLE_PROMPT) { - - Write-Verbose "Setting prompt to '$Prompt'" - - # Set the prompt to include the env name - # Make sure _OLD_VIRTUAL_PROMPT is global - function global:_OLD_VIRTUAL_PROMPT { "" } - Copy-Item -Path function:prompt -Destination function:_OLD_VIRTUAL_PROMPT - New-Variable -Name _PYTHON_VENV_PROMPT_PREFIX -Description "Python virtual environment prompt prefix" -Scope Global -Option ReadOnly -Visibility Public -Value $Prompt - - function global:prompt { - Write-Host -NoNewline -ForegroundColor Green "($_PYTHON_VENV_PROMPT_PREFIX) " - _OLD_VIRTUAL_PROMPT - } - $env:VIRTUAL_ENV_PROMPT = $Prompt -} - -# Clear PYTHONHOME -if (Test-Path -Path Env:PYTHONHOME) { - Copy-Item -Path Env:PYTHONHOME -Destination Env:_OLD_VIRTUAL_PYTHONHOME - Remove-Item -Path Env:PYTHONHOME -} - -# Add the venv to the PATH -Copy-Item -Path Env:PATH -Destination Env:_OLD_VIRTUAL_PATH -$Env:PATH = "$VenvExecDir$([System.IO.Path]::PathSeparator)$Env:PATH" diff --git a/.venv/bin/activate b/.venv/bin/activate deleted file mode 100644 index 393836b..0000000 --- a/.venv/bin/activate +++ /dev/null @@ -1,63 +0,0 @@ -# This file must be used with "source bin/activate" *from bash* -# you cannot run it directly - -deactivate () { - # reset old environment variables - if [ -n "${_OLD_VIRTUAL_PATH:-}" ] ; then - PATH="${_OLD_VIRTUAL_PATH:-}" - export PATH - unset _OLD_VIRTUAL_PATH - fi - if [ -n "${_OLD_VIRTUAL_PYTHONHOME:-}" ] ; then - PYTHONHOME="${_OLD_VIRTUAL_PYTHONHOME:-}" - export PYTHONHOME - unset _OLD_VIRTUAL_PYTHONHOME - fi - - # Call hash to forget past commands. Without forgetting - # past commands the $PATH changes we made may not be respected - hash -r 2> /dev/null - - if [ -n "${_OLD_VIRTUAL_PS1:-}" ] ; then - PS1="${_OLD_VIRTUAL_PS1:-}" - export PS1 - unset _OLD_VIRTUAL_PS1 - fi - - unset VIRTUAL_ENV - unset VIRTUAL_ENV_PROMPT - if [ ! "${1:-}" = "nondestructive" ] ; then - # Self destruct! - unset -f deactivate - fi -} - -# unset irrelevant variables -deactivate nondestructive - -VIRTUAL_ENV="/Users/oliversmith/git/simstock/.venv" -export VIRTUAL_ENV - -_OLD_VIRTUAL_PATH="$PATH" -PATH="$VIRTUAL_ENV/bin:$PATH" -export PATH - -# unset PYTHONHOME if set -# this will fail if PYTHONHOME is set to the empty string (which is bad anyway) -# could use `if (set -u; : $PYTHONHOME) ;` in bash -if [ -n "${PYTHONHOME:-}" ] ; then - _OLD_VIRTUAL_PYTHONHOME="${PYTHONHOME:-}" - unset PYTHONHOME -fi - -if [ -z "${VIRTUAL_ENV_DISABLE_PROMPT:-}" ] ; then - _OLD_VIRTUAL_PS1="${PS1:-}" - PS1="(.venv) ${PS1:-}" - export PS1 - VIRTUAL_ENV_PROMPT="(.venv) " - export VIRTUAL_ENV_PROMPT -fi - -# Call hash to forget past commands. Without forgetting -# past commands the $PATH changes we made may not be respected -hash -r 2> /dev/null diff --git a/.venv/bin/activate.csh b/.venv/bin/activate.csh deleted file mode 100644 index a93ffbb..0000000 --- a/.venv/bin/activate.csh +++ /dev/null @@ -1,26 +0,0 @@ -# This file must be used with "source bin/activate.csh" *from csh*. -# You cannot run it directly. -# Created by Davide Di Blasi . -# Ported to Python 3.3 venv by Andrew Svetlov - -alias deactivate 'test $?_OLD_VIRTUAL_PATH != 0 && setenv PATH "$_OLD_VIRTUAL_PATH" && unset _OLD_VIRTUAL_PATH; rehash; test $?_OLD_VIRTUAL_PROMPT != 0 && set prompt="$_OLD_VIRTUAL_PROMPT" && unset _OLD_VIRTUAL_PROMPT; unsetenv VIRTUAL_ENV; unsetenv VIRTUAL_ENV_PROMPT; test "\!:*" != "nondestructive" && unalias deactivate' - -# Unset irrelevant variables. -deactivate nondestructive - -setenv VIRTUAL_ENV "/Users/oliversmith/git/simstock/.venv" - -set _OLD_VIRTUAL_PATH="$PATH" -setenv PATH "$VIRTUAL_ENV/bin:$PATH" - - -set _OLD_VIRTUAL_PROMPT="$prompt" - -if (! "$?VIRTUAL_ENV_DISABLE_PROMPT") then - set prompt = "(.venv) $prompt" - setenv VIRTUAL_ENV_PROMPT "(.venv) " -endif - -alias pydoc python -m pydoc - -rehash diff --git a/.venv/bin/activate.fish b/.venv/bin/activate.fish deleted file mode 100644 index 5cdd795..0000000 --- a/.venv/bin/activate.fish +++ /dev/null @@ -1,69 +0,0 @@ -# This file must be used with "source /bin/activate.fish" *from fish* -# (https://fishshell.com/); you cannot run it directly. - -function deactivate -d "Exit virtual environment and return to normal shell environment" - # reset old environment variables - if test -n "$_OLD_VIRTUAL_PATH" - set -gx PATH $_OLD_VIRTUAL_PATH - set -e _OLD_VIRTUAL_PATH - end - if test -n "$_OLD_VIRTUAL_PYTHONHOME" - set -gx PYTHONHOME $_OLD_VIRTUAL_PYTHONHOME - set -e _OLD_VIRTUAL_PYTHONHOME - end - - if test -n "$_OLD_FISH_PROMPT_OVERRIDE" - set -e _OLD_FISH_PROMPT_OVERRIDE - # prevents error when using nested fish instances (Issue #93858) - if functions -q _old_fish_prompt - functions -e fish_prompt - functions -c _old_fish_prompt fish_prompt - functions -e _old_fish_prompt - end - end - - set -e VIRTUAL_ENV - set -e VIRTUAL_ENV_PROMPT - if test "$argv[1]" != "nondestructive" - # Self-destruct! - functions -e deactivate - end -end - -# Unset irrelevant variables. -deactivate nondestructive - -set -gx VIRTUAL_ENV "/Users/oliversmith/git/simstock/.venv" - -set -gx _OLD_VIRTUAL_PATH $PATH -set -gx PATH "$VIRTUAL_ENV/bin" $PATH - -# Unset PYTHONHOME if set. -if set -q PYTHONHOME - set -gx _OLD_VIRTUAL_PYTHONHOME $PYTHONHOME - set -e PYTHONHOME -end - -if test -z "$VIRTUAL_ENV_DISABLE_PROMPT" - # fish uses a function instead of an env var to generate the prompt. - - # Save the current fish_prompt function as the function _old_fish_prompt. - functions -c fish_prompt _old_fish_prompt - - # With the original prompt function renamed, we can override with our own. - function fish_prompt - # Save the return status of the last command. - set -l old_status $status - - # Output the venv prompt; color taken from the blue of the Python logo. - printf "%s%s%s" (set_color 4B8BBE) "(.venv) " (set_color normal) - - # Restore the return status of the previous command. - echo "exit $old_status" | . - # Output the original/"old" prompt. - _old_fish_prompt - end - - set -gx _OLD_FISH_PROMPT_OVERRIDE "$VIRTUAL_ENV" - set -gx VIRTUAL_ENV_PROMPT "(.venv) " -end diff --git a/.venv/bin/epylint b/.venv/bin/epylint deleted file mode 100755 index ada11b9..0000000 --- a/.venv/bin/epylint +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from pylint import run_epylint -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(run_epylint()) diff --git a/.venv/bin/f2py b/.venv/bin/f2py deleted file mode 100755 index 6db3d44..0000000 --- a/.venv/bin/f2py +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from numpy.f2py.f2py2e import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/f2py3 b/.venv/bin/f2py3 deleted file mode 100755 index 6db3d44..0000000 --- a/.venv/bin/f2py3 +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from numpy.f2py.f2py2e import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/f2py3.11 b/.venv/bin/f2py3.11 deleted file mode 100755 index 6db3d44..0000000 --- a/.venv/bin/f2py3.11 +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from numpy.f2py.f2py2e import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/fio b/.venv/bin/fio deleted file mode 100755 index 59d8377..0000000 --- a/.venv/bin/fio +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from fiona.fio.main import main_group -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main_group()) diff --git a/.venv/bin/fonttools b/.venv/bin/fonttools deleted file mode 100755 index 1d41911..0000000 --- a/.venv/bin/fonttools +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from fontTools.__main__ import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/futurize b/.venv/bin/futurize deleted file mode 100755 index 2437ff9..0000000 --- a/.venv/bin/futurize +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from libfuturize.main import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/get_gprof b/.venv/bin/get_gprof deleted file mode 100755 index 6f816cd..0000000 --- a/.venv/bin/get_gprof +++ /dev/null @@ -1,62 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -# Author: Mike McKerns (mmckerns @caltech and @uqfoundation) -# Copyright (c) 2008-2016 California Institute of Technology. -# Copyright (c) 2016-2023 The Uncertainty Quantification Foundation. -# License: 3-clause BSD. The full license text is available at: -# - https://github.com/uqfoundation/dill/blob/master/LICENSE -''' -build profile graph for the given instance - -running: - $ get_gprof - -executes: - gprof2dot -f pstats .prof | dot -Tpng -o .call.png - -where: - are arguments for gprof2dot, such as "-n 5 -e 5" - is code to create the instance to profile - is the class of the instance (i.e. type(instance)) - -For example: - $ get_gprof -n 5 -e 1 "import numpy; numpy.array([1,2])" - -will create 'ndarray.call.png' with the profile graph for numpy.array([1,2]), -where '-n 5' eliminates nodes below 5% threshold, similarly '-e 1' eliminates -edges below 1% threshold -''' - -import sys -# grab args for gprof2dot -args = sys.argv[1:-1] -args = ' '.join(args) -# last arg builds the object -obj = sys.argv[-1] -obj = obj.split(';') -# multi-line prep for generating an instance -for line in obj[:-1]: - exec(line) -# one-line generation of an instance -obj = eval(obj[-1]) - -# get object 'name' -objtype = type(obj) -name = getattr(objtype, '__name__', getattr(objtype, '__class__', objtype)) - -# profile dumping an object -import dill -import os -import cProfile -#name = os.path.splitext(os.path.basename(__file__))[0] -cProfile.run("dill.dumps(obj)", filename="%s.prof" % name) -msg = "gprof2dot -f pstats %s %s.prof | dot -Tpng -o %s.call.png" % (args, name, name) -os.system(msg) - -# get stats -f_prof = "%s.prof" % name -import pstats -stats = pstats.Stats(f_prof, stream=sys.stdout) -stats.strip_dirs().sort_stats('cumtime') -stats.print_stats(20) #XXX: save to file instead of print top 20? -os.remove(f_prof) diff --git a/.venv/bin/get_objgraph b/.venv/bin/get_objgraph deleted file mode 100755 index 411344c..0000000 --- a/.venv/bin/get_objgraph +++ /dev/null @@ -1,54 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -# Author: Mike McKerns (mmckerns @caltech and @uqfoundation) -# Copyright (c) 2008-2016 California Institute of Technology. -# Copyright (c) 2016-2023 The Uncertainty Quantification Foundation. -# License: 3-clause BSD. The full license text is available at: -# - https://github.com/uqfoundation/dill/blob/master/LICENSE -""" -display the reference paths for objects in ``dill.types`` or a .pkl file - -Notes: - the generated image is useful in showing the pointer references in - objects that are or can be pickled. Any object in ``dill.objects`` - listed in ``dill.load_types(picklable=True, unpicklable=True)`` works. - -Examples:: - - $ get_objgraph ArrayType - Image generated as ArrayType.png -""" - -import dill as pickle -#pickle.debug.trace(True) -#import pickle - -# get all objects for testing -from dill import load_types -load_types(pickleable=True,unpickleable=True) -from dill import objects - -if __name__ == "__main__": - import sys - if len(sys.argv) != 2: - print ("Please provide exactly one file or type name (e.g. 'IntType')") - msg = "\n" - for objtype in list(objects.keys())[:40]: - msg += objtype + ', ' - print (msg + "...") - else: - objtype = str(sys.argv[-1]) - try: - obj = objects[objtype] - except KeyError: - obj = pickle.load(open(objtype,'rb')) - import os - objtype = os.path.splitext(objtype)[0] - try: - import objgraph - objgraph.show_refs(obj, filename=objtype+'.png') - except ImportError: - print ("Please install 'objgraph' to view object graphs") - - -# EOF diff --git a/.venv/bin/ipython b/.venv/bin/ipython deleted file mode 100755 index 6ec0464..0000000 --- a/.venv/bin/ipython +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from IPython import start_ipython -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(start_ipython()) diff --git a/.venv/bin/ipython3 b/.venv/bin/ipython3 deleted file mode 100755 index 6ec0464..0000000 --- a/.venv/bin/ipython3 +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from IPython import start_ipython -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(start_ipython()) diff --git a/.venv/bin/isort b/.venv/bin/isort deleted file mode 100755 index 1392b23..0000000 --- a/.venv/bin/isort +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from isort.main import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/isort-identify-imports b/.venv/bin/isort-identify-imports deleted file mode 100755 index 471ec36..0000000 --- a/.venv/bin/isort-identify-imports +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from isort.main import identify_imports_main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(identify_imports_main()) diff --git a/.venv/bin/jupyter b/.venv/bin/jupyter deleted file mode 100755 index c46a5f0..0000000 --- a/.venv/bin/jupyter +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from jupyter_core.command import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/jupyter-kernel b/.venv/bin/jupyter-kernel deleted file mode 100755 index 60416f8..0000000 --- a/.venv/bin/jupyter-kernel +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from jupyter_client.kernelapp import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/jupyter-kernelspec b/.venv/bin/jupyter-kernelspec deleted file mode 100755 index e960d68..0000000 --- a/.venv/bin/jupyter-kernelspec +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from jupyter_client.kernelspecapp import KernelSpecApp -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(KernelSpecApp.launch_instance()) diff --git a/.venv/bin/jupyter-migrate b/.venv/bin/jupyter-migrate deleted file mode 100755 index bf5bd7a..0000000 --- a/.venv/bin/jupyter-migrate +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from jupyter_core.migrate import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/jupyter-run b/.venv/bin/jupyter-run deleted file mode 100755 index d50b867..0000000 --- a/.venv/bin/jupyter-run +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from jupyter_client.runapp import RunApp -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(RunApp.launch_instance()) diff --git a/.venv/bin/jupyter-troubleshoot b/.venv/bin/jupyter-troubleshoot deleted file mode 100755 index 66f2296..0000000 --- a/.venv/bin/jupyter-troubleshoot +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from jupyter_core.troubleshoot import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/normalizer b/.venv/bin/normalizer deleted file mode 100755 index ecd6485..0000000 --- a/.venv/bin/normalizer +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from charset_normalizer.cli.normalizer import cli_detect -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(cli_detect()) diff --git a/.venv/bin/pasteurize b/.venv/bin/pasteurize deleted file mode 100755 index ecea509..0000000 --- a/.venv/bin/pasteurize +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from libpasteurize.main import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/pdoc b/.venv/bin/pdoc deleted file mode 100755 index 0fc5c57..0000000 --- a/.venv/bin/pdoc +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from pdoc.__main__ import cli -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(cli()) diff --git a/.venv/bin/pip b/.venv/bin/pip deleted file mode 100755 index 570b878..0000000 --- a/.venv/bin/pip +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python3.11 -# -*- coding: utf-8 -*- -import re -import sys -from pip._internal.cli.main import main -if __name__ == '__main__': - sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/pip3 b/.venv/bin/pip3 deleted file mode 100755 index 570b878..0000000 --- a/.venv/bin/pip3 +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python3.11 -# -*- coding: utf-8 -*- -import re -import sys -from pip._internal.cli.main import main -if __name__ == '__main__': - sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/pip3.11 b/.venv/bin/pip3.11 deleted file mode 100755 index 570b878..0000000 --- a/.venv/bin/pip3.11 +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python3.11 -# -*- coding: utf-8 -*- -import re -import sys -from pip._internal.cli.main import main -if __name__ == '__main__': - sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/poetry2conda b/.venv/bin/poetry2conda deleted file mode 100755 index 12cfb75..0000000 --- a/.venv/bin/poetry2conda +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from poetry2conda.convert import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/pybabel b/.venv/bin/pybabel deleted file mode 100755 index d6c7f2f..0000000 --- a/.venv/bin/pybabel +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from babel.messages.frontend import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/pyftmerge b/.venv/bin/pyftmerge deleted file mode 100755 index 52e570d..0000000 --- a/.venv/bin/pyftmerge +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from fontTools.merge import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/pyftsubset b/.venv/bin/pyftsubset deleted file mode 100755 index 2609d48..0000000 --- a/.venv/bin/pyftsubset +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from fontTools.subset import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/pygmentize b/.venv/bin/pygmentize deleted file mode 100755 index da5b123..0000000 --- a/.venv/bin/pygmentize +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from pygments.cmdline import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/pylint b/.venv/bin/pylint deleted file mode 100755 index 3fc087c..0000000 --- a/.venv/bin/pylint +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from pylint import run_pylint -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(run_pylint()) diff --git a/.venv/bin/pylint-config b/.venv/bin/pylint-config deleted file mode 100755 index be30c6c..0000000 --- a/.venv/bin/pylint-config +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from pylint import _run_pylint_config -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(_run_pylint_config()) diff --git a/.venv/bin/pyproj b/.venv/bin/pyproj deleted file mode 100755 index 48c3ab8..0000000 --- a/.venv/bin/pyproj +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from pyproj.__main__ import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/pyreverse b/.venv/bin/pyreverse deleted file mode 100755 index 3e3337c..0000000 --- a/.venv/bin/pyreverse +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from pylint import run_pyreverse -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(run_pyreverse()) diff --git a/.venv/bin/python b/.venv/bin/python deleted file mode 120000 index 6e7f3c7..0000000 --- a/.venv/bin/python +++ /dev/null @@ -1 +0,0 @@ -python3.11 \ No newline at end of file diff --git a/.venv/bin/python3 b/.venv/bin/python3 deleted file mode 120000 index 6e7f3c7..0000000 --- a/.venv/bin/python3 +++ /dev/null @@ -1 +0,0 @@ -python3.11 \ No newline at end of file diff --git a/.venv/bin/python3.11 b/.venv/bin/python3.11 deleted file mode 120000 index 3cf1fbd..0000000 --- a/.venv/bin/python3.11 +++ /dev/null @@ -1 +0,0 @@ -/opt/homebrew/opt/python@3.11/bin/python3.11 \ No newline at end of file diff --git a/.venv/bin/rst2html.py b/.venv/bin/rst2html.py deleted file mode 100755 index 5f2c5bb..0000000 --- a/.venv/bin/rst2html.py +++ /dev/null @@ -1,23 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python - -# $Id: rst2html.py 4564 2006-05-21 20:44:42Z wiemann $ -# Author: David Goodger -# Copyright: This module has been placed in the public domain. - -""" -A minimal front end to the Docutils Publisher, producing HTML. -""" - -try: - import locale - locale.setlocale(locale.LC_ALL, '') -except: - pass - -from docutils.core import publish_cmdline, default_description - - -description = ('Generates (X)HTML documents from standalone reStructuredText ' - 'sources. ' + default_description) - -publish_cmdline(writer_name='html', description=description) diff --git a/.venv/bin/rst2html4.py b/.venv/bin/rst2html4.py deleted file mode 100755 index f251abe..0000000 --- a/.venv/bin/rst2html4.py +++ /dev/null @@ -1,26 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python - -# $Id: rst2html4.py 7994 2016-12-10 17:41:45Z milde $ -# Author: David Goodger -# Copyright: This module has been placed in the public domain. - -""" -A minimal front end to the Docutils Publisher, producing (X)HTML. - -The output conforms to XHTML 1.0 transitional -and almost to HTML 4.01 transitional (except for closing empty tags). -""" - -try: - import locale - locale.setlocale(locale.LC_ALL, '') -except: - pass - -from docutils.core import publish_cmdline, default_description - - -description = ('Generates (X)HTML documents from standalone reStructuredText ' - 'sources. ' + default_description) - -publish_cmdline(writer_name='html4', description=description) diff --git a/.venv/bin/rst2html5.py b/.venv/bin/rst2html5.py deleted file mode 100755 index 2b89b23..0000000 --- a/.venv/bin/rst2html5.py +++ /dev/null @@ -1,34 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf8 -*- -# :Copyright: © 2015 Günter Milde. -# :License: Released under the terms of the `2-Clause BSD license`_, in short: -# -# Copying and distribution of this file, with or without modification, -# are permitted in any medium without royalty provided the copyright -# notice and this notice are preserved. -# This file is offered as-is, without any warranty. -# -# .. _2-Clause BSD license: https://opensource.org/licenses/BSD-2-Clause -# -# Revision: $Revision: 8567 $ -# Date: $Date: 2020-09-30 13:57:21 +0200 (Mi, 30. Sep 2020) $ - -""" -A minimal front end to the Docutils Publisher, producing HTML 5 documents. - -The output is also valid XML. -""" - -try: - import locale # module missing in Jython - locale.setlocale(locale.LC_ALL, '') -except locale.Error: - pass - -from docutils.core import publish_cmdline, default_description - -description = (u'Generates HTML5 documents from standalone ' - u'reStructuredText sources.\n' - + default_description) - -publish_cmdline(writer_name='html5', description=description) diff --git a/.venv/bin/rst2latex.py b/.venv/bin/rst2latex.py deleted file mode 100755 index f1aeb5f..0000000 --- a/.venv/bin/rst2latex.py +++ /dev/null @@ -1,26 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python - -# $Id: rst2latex.py 5905 2009-04-16 12:04:49Z milde $ -# Author: David Goodger -# Copyright: This module has been placed in the public domain. - -""" -A minimal front end to the Docutils Publisher, producing LaTeX. -""" - -try: - import locale - locale.setlocale(locale.LC_ALL, '') -except: - pass - -from docutils.core import publish_cmdline - -description = ('Generates LaTeX documents from standalone reStructuredText ' - 'sources. ' - 'Reads from (default is stdin) and writes to ' - ' (default is stdout). See ' - ' for ' - 'the full reference.') - -publish_cmdline(writer_name='latex', description=description) diff --git a/.venv/bin/rst2man.py b/.venv/bin/rst2man.py deleted file mode 100755 index d656d22..0000000 --- a/.venv/bin/rst2man.py +++ /dev/null @@ -1,26 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python - -# Author: -# Contact: grubert@users.sf.net -# Copyright: This module has been placed in the public domain. - -""" -man.py -====== - -This module provides a simple command line interface that uses the -man page writer to output from ReStructuredText source. -""" - -import locale -try: - locale.setlocale(locale.LC_ALL, '') -except: - pass - -from docutils.core import publish_cmdline, default_description -from docutils.writers import manpage - -description = ("Generates plain unix manual documents. " + default_description) - -publish_cmdline(writer=manpage.Writer(), description=description) diff --git a/.venv/bin/rst2odt.py b/.venv/bin/rst2odt.py deleted file mode 100755 index 7ad2b3e..0000000 --- a/.venv/bin/rst2odt.py +++ /dev/null @@ -1,30 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python - -# $Id: rst2odt.py 5839 2009-01-07 19:09:28Z dkuhlman $ -# Author: Dave Kuhlman -# Copyright: This module has been placed in the public domain. - -""" -A front end to the Docutils Publisher, producing OpenOffice documents. -""" - -import sys -try: - import locale - locale.setlocale(locale.LC_ALL, '') -except: - pass - -from docutils.core import publish_cmdline_to_binary, default_description -from docutils.writers.odf_odt import Writer, Reader - - -description = ('Generates OpenDocument/OpenOffice/ODF documents from ' - 'standalone reStructuredText sources. ' + default_description) - - -writer = Writer() -reader = Reader() -output = publish_cmdline_to_binary(reader=reader, writer=writer, - description=description) - diff --git a/.venv/bin/rst2odt_prepstyles.py b/.venv/bin/rst2odt_prepstyles.py deleted file mode 100755 index bd63f92..0000000 --- a/.venv/bin/rst2odt_prepstyles.py +++ /dev/null @@ -1,67 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python - -# $Id: rst2odt_prepstyles.py 8346 2019-08-26 12:11:32Z milde $ -# Author: Dave Kuhlman -# Copyright: This module has been placed in the public domain. - -""" -Fix a word-processor-generated styles.odt for odtwriter use: Drop page size -specifications from styles.xml in STYLE_FILE.odt. -""" - -# Author: Michael Schutte - -from __future__ import print_function - -from lxml import etree -import sys -import zipfile -from tempfile import mkstemp -import shutil -import os - -NAMESPACES = { - "style": "urn:oasis:names:tc:opendocument:xmlns:style:1.0", - "fo": "urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0" -} - - -def prepstyle(filename): - - zin = zipfile.ZipFile(filename) - styles = zin.read("styles.xml") - - root = etree.fromstring(styles) - for el in root.xpath("//style:page-layout-properties", - namespaces=NAMESPACES): - for attr in el.attrib: - if attr.startswith("{%s}" % NAMESPACES["fo"]): - del el.attrib[attr] - - tempname = mkstemp() - zout = zipfile.ZipFile(os.fdopen(tempname[0], "w"), "w", - zipfile.ZIP_DEFLATED) - - for item in zin.infolist(): - if item.filename == "styles.xml": - zout.writestr(item, etree.tostring(root)) - else: - zout.writestr(item, zin.read(item.filename)) - - zout.close() - zin.close() - shutil.move(tempname[1], filename) - - -def main(): - args = sys.argv[1:] - if len(args) != 1: - print(__doc__, file=sys.stderr) - print("Usage: %s STYLE_FILE.odt\n" % sys.argv[0], file=sys.stderr) - sys.exit(1) - filename = args[0] - prepstyle(filename) - - -if __name__ == '__main__': - main() diff --git a/.venv/bin/rst2pseudoxml.py b/.venv/bin/rst2pseudoxml.py deleted file mode 100755 index 73707d9..0000000 --- a/.venv/bin/rst2pseudoxml.py +++ /dev/null @@ -1,23 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python - -# $Id: rst2pseudoxml.py 4564 2006-05-21 20:44:42Z wiemann $ -# Author: David Goodger -# Copyright: This module has been placed in the public domain. - -""" -A minimal front end to the Docutils Publisher, producing pseudo-XML. -""" - -try: - import locale - locale.setlocale(locale.LC_ALL, '') -except: - pass - -from docutils.core import publish_cmdline, default_description - - -description = ('Generates pseudo-XML from standalone reStructuredText ' - 'sources (for testing purposes). ' + default_description) - -publish_cmdline(description=description) diff --git a/.venv/bin/rst2s5.py b/.venv/bin/rst2s5.py deleted file mode 100755 index 8ebffbc..0000000 --- a/.venv/bin/rst2s5.py +++ /dev/null @@ -1,24 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python - -# $Id: rst2s5.py 4564 2006-05-21 20:44:42Z wiemann $ -# Author: Chris Liechti -# Copyright: This module has been placed in the public domain. - -""" -A minimal front end to the Docutils Publisher, producing HTML slides using -the S5 template system. -""" - -try: - import locale - locale.setlocale(locale.LC_ALL, '') -except: - pass - -from docutils.core import publish_cmdline, default_description - - -description = ('Generates S5 (X)HTML slideshow documents from standalone ' - 'reStructuredText sources. ' + default_description) - -publish_cmdline(writer_name='s5', description=description) diff --git a/.venv/bin/rst2xetex.py b/.venv/bin/rst2xetex.py deleted file mode 100755 index ffed2b8..0000000 --- a/.venv/bin/rst2xetex.py +++ /dev/null @@ -1,27 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python - -# $Id: rst2xetex.py 7847 2015-03-17 17:30:47Z milde $ -# Author: Guenter Milde -# Copyright: This module has been placed in the public domain. - -""" -A minimal front end to the Docutils Publisher, producing Lua/XeLaTeX code. -""" - -try: - import locale - locale.setlocale(locale.LC_ALL, '') -except: - pass - -from docutils.core import publish_cmdline - -description = ('Generates LaTeX documents from standalone reStructuredText ' - 'sources for compilation with the Unicode-aware TeX variants ' - 'XeLaTeX or LuaLaTeX. ' - 'Reads from (default is stdin) and writes to ' - ' (default is stdout). See ' - ' for ' - 'the full reference.') - -publish_cmdline(writer_name='xetex', description=description) diff --git a/.venv/bin/rst2xml.py b/.venv/bin/rst2xml.py deleted file mode 100755 index cef35be..0000000 --- a/.venv/bin/rst2xml.py +++ /dev/null @@ -1,23 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python - -# $Id: rst2xml.py 4564 2006-05-21 20:44:42Z wiemann $ -# Author: David Goodger -# Copyright: This module has been placed in the public domain. - -""" -A minimal front end to the Docutils Publisher, producing Docutils XML. -""" - -try: - import locale - locale.setlocale(locale.LC_ALL, '') -except: - pass - -from docutils.core import publish_cmdline, default_description - - -description = ('Generates Docutils-native XML from standalone ' - 'reStructuredText sources. ' + default_description) - -publish_cmdline(writer_name='xml', description=description) diff --git a/.venv/bin/rstpep2html.py b/.venv/bin/rstpep2html.py deleted file mode 100755 index fc38622..0000000 --- a/.venv/bin/rstpep2html.py +++ /dev/null @@ -1,25 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python - -# $Id: rstpep2html.py 4564 2006-05-21 20:44:42Z wiemann $ -# Author: David Goodger -# Copyright: This module has been placed in the public domain. - -""" -A minimal front end to the Docutils Publisher, producing HTML from PEP -(Python Enhancement Proposal) documents. -""" - -try: - import locale - locale.setlocale(locale.LC_ALL, '') -except: - pass - -from docutils.core import publish_cmdline, default_description - - -description = ('Generates (X)HTML from reStructuredText-format PEP files. ' - + default_description) - -publish_cmdline(reader_name='pep', writer_name='pep_html', - description=description) diff --git a/.venv/bin/sphinx-apidoc b/.venv/bin/sphinx-apidoc deleted file mode 100755 index 42ddba4..0000000 --- a/.venv/bin/sphinx-apidoc +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from sphinx.ext.apidoc import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/sphinx-autogen b/.venv/bin/sphinx-autogen deleted file mode 100755 index ad4448b..0000000 --- a/.venv/bin/sphinx-autogen +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from sphinx.ext.autosummary.generate import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/sphinx-build b/.venv/bin/sphinx-build deleted file mode 100755 index c0a4c3f..0000000 --- a/.venv/bin/sphinx-build +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from sphinx.cmd.build import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/sphinx-quickstart b/.venv/bin/sphinx-quickstart deleted file mode 100755 index cc7056b..0000000 --- a/.venv/bin/sphinx-quickstart +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from sphinx.cmd.quickstart import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/symilar b/.venv/bin/symilar deleted file mode 100755 index f0c16e6..0000000 --- a/.venv/bin/symilar +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from pylint import run_symilar -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(run_symilar()) diff --git a/.venv/bin/ttx b/.venv/bin/ttx deleted file mode 100755 index 1fe9fef..0000000 --- a/.venv/bin/ttx +++ /dev/null @@ -1,8 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -*- coding: utf-8 -*- -import re -import sys -from fontTools.ttx import main -if __name__ == "__main__": - sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0]) - sys.exit(main()) diff --git a/.venv/bin/undill b/.venv/bin/undill deleted file mode 100755 index 8abaa59..0000000 --- a/.venv/bin/undill +++ /dev/null @@ -1,22 +0,0 @@ -#!/Users/oliversmith/git/simstock/.venv/bin/python -# -# Author: Mike McKerns (mmckerns @caltech and @uqfoundation) -# Copyright (c) 2008-2016 California Institute of Technology. -# Copyright (c) 2016-2023 The Uncertainty Quantification Foundation. -# License: 3-clause BSD. The full license text is available at: -# - https://github.com/uqfoundation/dill/blob/master/LICENSE -""" -unpickle the contents of a pickled object file - -Examples:: - - $ undill hello.pkl - ['hello', 'world'] -""" - -if __name__ == '__main__': - import sys - import dill - for file in sys.argv[1:]: - print (dill.load(open(file,'rb'))) - diff --git a/.venv/pyvenv.cfg b/.venv/pyvenv.cfg deleted file mode 100644 index 37339dd..0000000 --- a/.venv/pyvenv.cfg +++ /dev/null @@ -1,5 +0,0 @@ -home = /opt/homebrew/opt/python@3.11/bin -include-system-site-packages = false -version = 3.11.9 -executable = /opt/homebrew/Cellar/python@3.11/3.11.9/Frameworks/Python.framework/Versions/3.11/bin/python3.11 -command = /opt/homebrew/opt/python@3.11/bin/python3.11 -m venv /Users/oliversmith/git/simstock/.venv diff --git a/.venv/share/jupyter/kernels/python3/kernel.json b/.venv/share/jupyter/kernels/python3/kernel.json deleted file mode 100644 index cca38a4..0000000 --- a/.venv/share/jupyter/kernels/python3/kernel.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "argv": [ - "python", - "-m", - "ipykernel_launcher", - "-f", - "{connection_file}" - ], - "display_name": "Python 3 (ipykernel)", - "language": "python", - "metadata": { - "debugger": true - } -} \ No newline at end of file diff --git a/.venv/share/jupyter/kernels/python3/logo-32x32.png b/.venv/share/jupyter/kernels/python3/logo-32x32.png deleted file mode 100644 index be81330..0000000 Binary files a/.venv/share/jupyter/kernels/python3/logo-32x32.png and /dev/null differ diff --git a/.venv/share/jupyter/kernels/python3/logo-64x64.png b/.venv/share/jupyter/kernels/python3/logo-64x64.png deleted file mode 100644 index eebbff6..0000000 Binary files a/.venv/share/jupyter/kernels/python3/logo-64x64.png and /dev/null differ diff --git a/.venv/share/jupyter/kernels/python3/logo-svg.svg b/.venv/share/jupyter/kernels/python3/logo-svg.svg deleted file mode 100644 index 467b07b..0000000 --- a/.venv/share/jupyter/kernels/python3/logo-svg.svg +++ /dev/null @@ -1,265 +0,0 @@ - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/.venv/share/man/man1/ipython.1 b/.venv/share/man/man1/ipython.1 deleted file mode 100644 index 0f4a191..0000000 --- a/.venv/share/man/man1/ipython.1 +++ /dev/null @@ -1,60 +0,0 @@ -.\" Hey, EMACS: -*- nroff -*- -.\" First parameter, NAME, should be all caps -.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection -.\" other parameters are allowed: see man(7), man(1) -.TH IPYTHON 1 "July 15, 2011" -.\" Please adjust this date whenever revising the manpage. -.\" -.\" Some roff macros, for reference: -.\" .nh disable hyphenation -.\" .hy enable hyphenation -.\" .ad l left justify -.\" .ad b justify to both left and right margins -.\" .nf disable filling -.\" .fi enable filling -.\" .br insert line break -.\" .sp insert n+1 empty lines -.\" for manpage-specific macros, see man(7) and groff_man(7) -.\" .SH section heading -.\" .SS secondary section heading -.\" -.\" -.\" To preview this page as plain text: nroff -man ipython.1 -.\" -.SH NAME -ipython \- Tools for Interactive Computing in Python. -.SH SYNOPSIS -.B ipython -.RI [ options ] " files" ... - -.B ipython subcommand -.RI [ options ] ... - -.SH DESCRIPTION -An interactive Python shell with automatic history (input and output), dynamic -object introspection, easier configuration, command completion, access to the -system shell, integration with numerical and scientific computing tools, -web notebook, Qt console, and more. - -For more information on how to use IPython, see 'ipython \-\-help', -or 'ipython \-\-help\-all' for all available command\(hyline options. - -.SH "ENVIRONMENT VARIABLES" -.sp -.PP -\fIIPYTHONDIR\fR -.RS 4 -This is the location where IPython stores all its configuration files. The default -is $HOME/.ipython if IPYTHONDIR is not defined. - -You can see the computed value of IPYTHONDIR with `ipython locate`. - -.SH FILES - -IPython uses various configuration files stored in profiles within IPYTHONDIR. -To generate the default configuration files and start configuring IPython, -do 'ipython profile create', and edit '*_config.py' files located in -IPYTHONDIR/profile_default. - -.SH AUTHORS -IPython is written by the IPython Development Team . diff --git a/.venv/share/man/man1/ttx.1 b/.venv/share/man/man1/ttx.1 deleted file mode 100644 index bba23b5..0000000 --- a/.venv/share/man/man1/ttx.1 +++ /dev/null @@ -1,225 +0,0 @@ -.Dd May 18, 2004 -.\" ttx is not specific to any OS, but contrary to what groff_mdoc(7) -.\" seems to imply, entirely omitting the .Os macro causes 'BSD' to -.\" be used, so I give a zero-width space as its argument. -.Os \& -.\" The "FontTools Manual" argument apparently has no effect in -.\" groff 1.18.1. I think it is a bug in the -mdoc groff package. -.Dt TTX 1 "FontTools Manual" -.Sh NAME -.Nm ttx -.Nd tool for manipulating TrueType and OpenType fonts -.Sh SYNOPSIS -.Nm -.Bk -.Op Ar option ... -.Ek -.Bk -.Ar file ... -.Ek -.Sh DESCRIPTION -.Nm -is a tool for manipulating TrueType and OpenType fonts. It can convert -TrueType and OpenType fonts to and from an -.Tn XML Ns -based format called -.Tn TTX . -.Tn TTX -files have a -.Ql .ttx -extension. -.Pp -For each -.Ar file -argument it is given, -.Nm -detects whether it is a -.Ql .ttf , -.Ql .otf -or -.Ql .ttx -file and acts accordingly: if it is a -.Ql .ttf -or -.Ql .otf -file, it generates a -.Ql .ttx -file; if it is a -.Ql .ttx -file, it generates a -.Ql .ttf -or -.Ql .otf -file. -.Pp -By default, every output file is created in the same directory as the -corresponding input file and with the same name except for the -extension, which is substituted appropriately. -.Nm -never overwrites existing files; if necessary, it appends a suffix to -the output file name before the extension, as in -.Pa Arial#1.ttf . -.Ss "General options" -.Bl -tag -width ".Fl t Ar table" -.It Fl h -Display usage information. -.It Fl d Ar dir -Write the output files to directory -.Ar dir -instead of writing every output file to the same directory as the -corresponding input file. -.It Fl o Ar file -Write the output to -.Ar file -instead of writing it to the same directory as the -corresponding input file. -.It Fl v -Be verbose. Write more messages to the standard output describing what -is being done. -.It Fl a -Allow virtual glyphs ID's on compile or decompile. -.El -.Ss "Dump options" -The following options control the process of dumping font files -(TrueType or OpenType) to -.Tn TTX -files. -.Bl -tag -width ".Fl t Ar table" -.It Fl l -List table information. Instead of dumping the font to a -.Tn TTX -file, display minimal information about each table. -.It Fl t Ar table -Dump table -.Ar table . -This option may be given multiple times to dump several tables at -once. When not specified, all tables are dumped. -.It Fl x Ar table -Exclude table -.Ar table -from the list of tables to dump. This option may be given multiple -times to exclude several tables from the dump. The -.Fl t -and -.Fl x -options are mutually exclusive. -.It Fl s -Split tables. Dump each table to a separate -.Tn TTX -file and write (under the name that would have been used for the output -file if the -.Fl s -option had not been given) one small -.Tn TTX -file containing references to the individual table dump files. This -file can be used as input to -.Nm -as long as the referenced files can be found in the same directory. -.It Fl i -.\" XXX: I suppose OpenType programs (exist and) are also affected. -Don't disassemble TrueType instructions. When this option is specified, -all TrueType programs (glyph programs, the font program and the -pre-program) are written to the -.Tn TTX -file as hexadecimal data instead of -assembly. This saves some time and results in smaller -.Tn TTX -files. -.It Fl y Ar n -When decompiling a TrueType Collection (TTC) file, -decompile font number -.Ar n , -starting from 0. -.El -.Ss "Compilation options" -The following options control the process of compiling -.Tn TTX -files into font files (TrueType or OpenType): -.Bl -tag -width ".Fl t Ar table" -.It Fl m Ar fontfile -Merge the input -.Tn TTX -file -.Ar file -with -.Ar fontfile . -No more than one -.Ar file -argument can be specified when this option is used. -.It Fl b -Don't recalculate glyph bounding boxes. Use the values in the -.Tn TTX -file as is. -.El -.Sh "THE TTX FILE FORMAT" -You can find some information about the -.Tn TTX -file format in -.Pa documentation.html . -In particular, you will find in that file the list of tables understood by -.Nm -and the relations between TrueType GlyphIDs and the glyph names used in -.Tn TTX -files. -.Sh EXAMPLES -In the following examples, all files are read from and written to the -current directory. Additionally, the name given for the output file -assumes in every case that it did not exist before -.Nm -was invoked. -.Pp -Dump the TrueType font contained in -.Pa FreeSans.ttf -to -.Pa FreeSans.ttx : -.Pp -.Dl ttx FreeSans.ttf -.Pp -Compile -.Pa MyFont.ttx -into a TrueType or OpenType font file: -.Pp -.Dl ttx MyFont.ttx -.Pp -List the tables in -.Pa FreeSans.ttf -along with some information: -.Pp -.Dl ttx -l FreeSans.ttf -.Pp -Dump the -.Sq cmap -table from -.Pa FreeSans.ttf -to -.Pa FreeSans.ttx : -.Pp -.Dl ttx -t cmap FreeSans.ttf -.Sh NOTES -On MS\-Windows and MacOS, -.Nm -is available as a graphical application to which files can be dropped. -.Sh SEE ALSO -.Pa documentation.html -.Pp -.Xr fontforge 1 , -.Xr ftinfo 1 , -.Xr gfontview 1 , -.Xr xmbdfed 1 , -.Xr Font::TTF 3pm -.Sh AUTHORS -.Nm -was written by -.An -nosplit -.An "Just van Rossum" Aq just@letterror.com . -.Pp -This manual page was written by -.An "Florent Rougon" Aq f.rougon@free.fr -for the Debian GNU/Linux system based on the existing FontTools -documentation. It may be freely used, modified and distributed without -restrictions. -.\" For Emacs: -.\" Local Variables: -.\" fill-column: 72 -.\" sentence-end: "[.?!][]\"')}]*\\($\\| $\\| \\| \\)[ \n]*" -.\" sentence-end-double-space: t -.\" End: \ No newline at end of file diff --git a/README.md b/README.md index f16bf63..28faf8d 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,10 @@ Full docs are available at [ReadtheDocs](https://simstock.readthedocs.io/en/late ## Installation -> **_NOTE:_** SimStock requires Python 3.8 or above, as well as an EnergyPlus installation. +> **_NOTE:_** SimStock requires Python 3.11 to 3.13, as well as an EnergyPlus installation. -After ensuring you have EnergyPlus installed, and python >= v3.8, simply run +After ensuring you have EnergyPlus installed, and Python 3.11-3.13, simply run ``` bash pip install simstock @@ -63,4 +63,4 @@ Below is an example of a typical Simstock work flow. Contributions to SimStock are welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidance on testing, bug reporting and constributing code. -Contribution to SimStock is covered by [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). \ No newline at end of file +Contribution to SimStock is covered by [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). diff --git a/docs/build/html/.doctrees/environment.pickle b/docs/build/html/.doctrees/environment.pickle index b8d8d9a..f2b8d73 100644 Binary files a/docs/build/html/.doctrees/environment.pickle and b/docs/build/html/.doctrees/environment.pickle differ diff --git a/docs/build/html/.doctrees/index.doctree b/docs/build/html/.doctrees/index.doctree index 053a60e..156f6b8 100644 Binary files a/docs/build/html/.doctrees/index.doctree and b/docs/build/html/.doctrees/index.doctree differ diff --git a/docs/build/html/.doctrees/installation.doctree b/docs/build/html/.doctrees/installation.doctree index f0bae51..d2839fb 100644 Binary files a/docs/build/html/.doctrees/installation.doctree and b/docs/build/html/.doctrees/installation.doctree differ diff --git a/docs/build/html/.doctrees/simstock.doctree b/docs/build/html/.doctrees/simstock.doctree index 0f7b6d4..9656579 100644 Binary files a/docs/build/html/.doctrees/simstock.doctree and b/docs/build/html/.doctrees/simstock.doctree differ diff --git a/docs/build/html/.doctrees/simstockqgis.doctree b/docs/build/html/.doctrees/simstockqgis.doctree index 8708122..e4acdee 100644 Binary files a/docs/build/html/.doctrees/simstockqgis.doctree and b/docs/build/html/.doctrees/simstockqgis.doctree differ diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt index edbe75a..3b3e40f 100644 --- a/docs/build/html/_sources/index.rst.txt +++ b/docs/build/html/_sources/index.rst.txt @@ -1,4 +1,4 @@ -.. Simstock documentation master file +.. SimStock documentation master file .. figure:: logo.svg :width: 450px @@ -7,10 +7,10 @@ :alt: alternate text :align: left -Simstock +SimStock ======== -Simstock is a python package for taking geographical data, processing it into a form compatible with EnergyPlus, and running thermal simulations. SimStock thereby provides an intermediate +SimStock is a python package for taking geographical data, processing it into a form compatible with EnergyPlus, and running thermal simulations. SimStock thereby provides an intermediate layer between various data types and EnergyPlus, allowing UBEMs to be run straightforwardly from QGIS etc. The software performs the following setps: @@ -19,7 +19,7 @@ UBEMs to be run straightforwardly from QGIS etc. The software performs the follo 3. Running the simulation and handling the results. -Simstock is provided by `Building Stock Lab `_ within UCL's Bartlett Energy Institute `Bartlett Energy Institute `_. +SimStock is provided by `Building Stock Lab `_ within UCL's Bartlett Energy Institute `Bartlett Energy Institute `_. ---- diff --git a/docs/build/html/_sources/installation.rst.txt b/docs/build/html/_sources/installation.rst.txt index 5b5a946..3fce74c 100644 --- a/docs/build/html/_sources/installation.rst.txt +++ b/docs/build/html/_sources/installation.rst.txt @@ -5,16 +5,16 @@ Installation .. admonition:: Requirements \ \ - Simstock requires an installation of EnergyPlus, and Python version 3.8 or above. It is recommended that EnergyPlus .idd files are installed to ``C:\\EnergyPlus*\\Energy+.idd`` if using Windows, where ``*`` will be the EnergyPlus version number. If using Mac or Linux, it is recommended to have the EnergyPlus idd files at either ``/usr/local/EnergyPlus*/Energy+.idd`` or ``/Applications/EnergyPlus*/Energy+.idd``. Silicone Mac users should also have Rosetta installed. + SimStock supports Python versions 3.11 to 3.13 and requires an installation of EnergyPlus. It is recommended that EnergyPlus .idd files are installed to ``C:\\EnergyPlus*\\Energy+.idd`` if using Windows, where ``*`` will be the EnergyPlus version number. If using Mac or Linux, it is recommended to have the EnergyPlus idd files at either ``/usr/local/EnergyPlus*/Energy+.idd`` or ``/Applications/EnergyPlus*/Energy+.idd``. Silicone Mac users should also have Rosetta installed. -Simstock can either being installed from PyPI (recommended for most users) or in developer mode by cloning the repository. +SimStock can either being installed from PyPI (recommended for most users) or in developer mode by cloning the repository. ---- Installation from PyPI (recommended) ==================================== -After ensuring you have EnergyPlus installed, and python >= v3.8, simply run +After ensuring you have EnergyPlus installed, simply run .. code-block:: bash @@ -27,7 +27,7 @@ in the command line. Installation for developers =========================== -First, clone the Simstock repository from `Github `_ by typing into the command line: +First, clone the SimStock repository from `Github `_ by typing into the command line: .. code-block:: bash @@ -45,7 +45,7 @@ Alternatively, download the `zip `_ from Github | ├── tests/ | └── docs/ -The source code for Simstock is contained within ``src/simstock``. The ``docs`` folder contains the documentation you are currently reading. The ``tests`` folder contains unit tests that can be run with Python's unittest suite. +The source code for SimStock is contained within ``src/simstock``. The ``docs`` folder contains the documentation you are currently reading. The ``tests`` folder contains unit tests that can be run with Python's unittest suite. Handling dependencies ********************* @@ -106,7 +106,7 @@ The interactive python shell can now be invoked simply by typing ``python`` into import simstock as sim -to varify the ``Simstock`` installation. Any scripts can be run by the usual python command; e.g., to run a script you have created called ``script.py``: +to varify the ``simstock`` installation. Any scripts can be run by the usual python command; e.g., to run a script you have created called ``script.py``: .. code-block:: bash diff --git a/docs/build/html/_sources/simstockqgis.rst.txt b/docs/build/html/_sources/simstockqgis.rst.txt index 4c9a721..1227950 100644 --- a/docs/build/html/_sources/simstockqgis.rst.txt +++ b/docs/build/html/_sources/simstockqgis.rst.txt @@ -1,4 +1,4 @@ -Simstock QGIS Plugin Documentation +SimStock QGIS Plugin Documentation ********************************** .. _Installation: @@ -16,11 +16,11 @@ The non-LTR versions are likely to work too, however sometimes the Python versio Installation ------------ -1. The Simstock QGIS plugin is available from the official `QGIS Python Plugins Repository `_. It can be installed directly in QGIS by navigating to Plugins -> Manage and install plugins. +1. The SimStock QGIS plugin is available from the official `QGIS Python Plugins Repository `_. It can be installed directly in QGIS by navigating to Plugins -> Manage and install plugins. 2. After installing this, you may need to restart QGIS. -3. If the Simstock QGIS plugin has successfully been installed, you should be able to see it listed under the 'Plugins' list as well as a new icon on the toolbar. +3. If the SimStock QGIS plugin has successfully been installed, you should be able to see it listed under the 'Plugins' list as well as a new icon on the toolbar. 4. The plugin will now need to be setup - see the next section for information. diff --git a/docs/build/html/_static/pygments.css b/docs/build/html/_static/pygments.css index 84ab303..6f8b210 100644 --- a/docs/build/html/_static/pygments.css +++ b/docs/build/html/_static/pygments.css @@ -6,9 +6,9 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: .highlight .hll { background-color: #ffffcc } .highlight { background: #f8f8f8; } .highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ -.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .err { border: 1px solid #F00 } /* Error */ .highlight .k { color: #008000; font-weight: bold } /* Keyword */ -.highlight .o { color: #666666 } /* Operator */ +.highlight .o { color: #666 } /* 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 */ @@ -25,34 +25,34 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: .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 .gt { color: #04D } /* 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 .m { color: #666 } /* 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 .nc { color: #00F; font-weight: bold } /* Name.Class */ +.highlight .no { color: #800 } /* Name.Constant */ +.highlight .nd { color: #A2F } /* 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 .nf { color: #00F } /* Name.Function */ .highlight .nl { color: #767600 } /* Name.Label */ -.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +.highlight .nn { color: #00F; 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 .ow { color: #A2F; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #BBB } /* Text.Whitespace */ +.highlight .mb { color: #666 } /* Literal.Number.Bin */ +.highlight .mf { color: #666 } /* Literal.Number.Float */ +.highlight .mh { color: #666 } /* Literal.Number.Hex */ +.highlight .mi { color: #666 } /* Literal.Number.Integer */ +.highlight .mo { color: #666 } /* Literal.Number.Oct */ .highlight .sa { color: #BA2121 } /* Literal.String.Affix */ .highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ .highlight .sc { color: #BA2121 } /* Literal.String.Char */ @@ -67,9 +67,9 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: .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 .fm { color: #00F } /* 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 +.highlight .il { color: #666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/docs/build/html/devinstructions.html b/docs/build/html/devinstructions.html index 0559170..b2fdff7 100644 --- a/docs/build/html/devinstructions.html +++ b/docs/build/html/devinstructions.html @@ -45,7 +45,7 @@ @@ -108,7 +108,7 @@

Usage and basic examplesSimstockDataframe and the IDFmanager. The SimstockDataframe is an extension of a Pandas Dataframe. It allows data to be read in from a variety of formats. It also performs geometruc simplification on the data. The SimstockDataframe also contains the EnergyPlus settings, allowing easy manipulation of materials etc. Once these settings have been set, and any geometrical simplification perfomed, the IDFmanager then creates the necessary thermal zones from the SimstockDataframe. The IDFmanager can also be used to run an EnergyPlus simulation.

Below is an example of a typical Simstock work flow.

# Import the simstock package
-import simstock as sim
+import simstock as sim
 
 # Let's say we have some test data stored in a file called test.csv.
 # We can read it in as a SimstockDataframe:
@@ -285,7 +285,7 @@ 
Saving data

 
Simstock comes with some basic options for visualising the geographic data stored in the SimstockDataframe, utilising matplotlib.

 
E.g. the following code

-
import matplotlib.pyplot as plt
+
import matplotlib.pyplot as plt
 
 # Assuming we have previously instantiated a SimstockDataframe called sdf
 sim.plot(sdf, facecolor="lightblue", edgecolor="red")
@@ -323,7 +323,7 @@ 
Plotting data
import simstock as sim
+
import simstock as sim
 
 sdf = sim.read_csv(
         "your_data.csv",
@@ -337,7 +337,7 @@ 
Plotting data
Specifying schedules, materials, and constructions

 
As mentioned in the Specifying weather data section, SimstockDataframes contain the settings that specify the EnergyPlus simulation: materials, constructions, and schedules. The SimstockDataframe acts as an interface to view and edit each of these. Internally, these settings are stored as an IDF object.

 
Each of these settings can be viewed as attributes of the SimstockDataframe. E.g.:

-
import simstock as sim
+
import simstock as sim
 
 sdf = sim.read_csv("test.csv")
 
@@ -547,7 +547,7 @@ 
Running a simulation