Add changes for 2123dbe

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: c3bcc630eee9c5aa54edb672f5364faa
+tags: 645f666f9bcd5a90fca523b33c5a78b7

.github/actions/prepare-cache-pip/action.yml

@@ -0,0 +1,17 @@
+name: "prepare-cache-pip"
+description: "Prepare setup cache of pip wheels"
+outputs:
+  cache-dir:
+    description: "Pip cache dir"
+    value: ${{ steps.get-pip-cache-dir.outputs.dir }}
+runs:
+  using: "composite"
+  steps:
+    - name: upgrade pip setuptools wheel
+      run: python -m pip install --upgrade pip setuptools wheel
+      shell: bash
+    - name: Get pip cache dir
+      id: get-pip-cache-dir
+      run: |
+        echo "::set-output name=dir::$(pip cache dir)"
+      shell: bash

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,71 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '28 3 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/docs.yml

@@ -0,0 +1,46 @@
+name: build doc
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@master
+      with:
+        persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token
+        fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
+    - name: install pandoc linux
+      run: sudo apt install pandoc
+      if: runner.os == 'Linux'
+
+    - name: Set up Python 3.9
+      uses: actions/[email protected]
+      with:
+        python-version: 3.9
+    - name: prepare pip cache
+      id: prepare-cache-pip
+      uses: ./.github/actions/prepare-cache-pip
+    - name: pip cache
+      uses: actions/[email protected]
+      with:
+        path: ${{ steps.prepare-cache-pip.outputs.cache-dir }}
+        key: ubuntu-latest-3.9-pip-${{ hashFiles('**/docs_requirements.txt') }}-${{ hashFiles('**/setup.cfg') }}
+        restore-keys: |
+          ubuntu-latest-3.9-pip-
+    #- name: install requirements.txt
+    #  run: |
+    #    pip install -r requirements.txt
+    - name: install docs_requirements.txt
+      run: |
+        pip install -r docs_requirements.txt
+
+    - name: Build and Commit
+      uses: sphinx-notes/pages@master
+      with:
+        documentation_path: docs
+    - name: Push changes
+      uses: ad-m/github-push-action@master
+      with:
+        github_token: ${{ secrets.DOC_TOKEN }}
+        branch: docs
+        force: true

.gitignore

@@ -0,0 +1,135 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+doc_html/
+docs/api/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# MacOS
+.DS_Store
+.gitignore

_sources/api/analysis/generated/mesoscopy.analysis.hall.rst.txt

@@ -0,0 +1,36 @@
+mesoscopy.analysis.hall
+=======================
+
+.. automodule:: mesoscopy.analysis.hall
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      density
+      fet_mobility
+      hall_mobility
+      meanfreepath
+      rhoxx
+      rhoxy
+      sigma
+      symmetrise
+
+
+
+
+
+
+
+
+
+
+
+
+

_sources/api/analysis/generated/mesoscopy.analysis.josephson.rst.txt

@@ -0,0 +1,31 @@
+mesoscopy.analysis.josephson
+============================
+
+.. automodule:: mesoscopy.analysis.josephson
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      extract_zeros
+      find_ic
+      mapping_SC
+
+
+
+
+
+
+
+
+
+
+
+
+

_sources/api/analysis/generated/mesoscopy.analysis.load.rst.txt

@@ -0,0 +1,33 @@
+mesoscopy.analysis.load
+=======================
+
+.. automodule:: mesoscopy.analysis.load
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      get_data_by_paramname
+      get_dataset
+      get_run_timestamp
+      import_sweep
+      list_parameters
+
+
+
+
+
+
+
+
+
+
+
+
+