Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
*.pt filter=lfs diff=lfs merge=lfs -text
*.geoh5 filter=lfs diff=lfs merge=lfs -text
*.h5 filter=lfs diff=lfs merge=lfs -text
*.min.js filter=lfs diff=lfs merge=lfs -text
*.ipynb filter=lfs diff=lfs merge=lfs -text
2 changes: 1 addition & 1 deletion .idea/scopes/sources.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 10 additions & 7 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
default_language_version:
python: python3
exclude: (^docs/(conf.py|_ext/))
default_stages: [commit,push]
default_stages: [pre-commit,pre-push]
fail_fast: false

ci:
Expand All @@ -12,19 +12,21 @@ ci:

repos:
- repo: https://github.com/hadialqattan/pycln
rev: v2.4.0
rev: v2.5.0
hooks:
- id: pycln
args: [--config=pyproject.toml]
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.5.5
rev: v0.9.1
hooks:
- id: ruff
args:
- --fix
- --exit-non-zero-on-fix
# - --unsafe-fixes
exclude_types: [jupyter]
- id: ruff-format
exclude_types: [jupyter]
#- repo: https://github.com/pre-commit/mirrors-mypy # TODO: fix mypy errors
# rev: v1.10.0
# hooks:
Expand All @@ -37,15 +39,15 @@ repos:
# ]
# exclude: ^(docs|geoapps-assets)/
- repo: https://github.com/codingjoe/relint
rev: 3.1.1
rev: 3.3.1
hooks:
- id: relint
args: [-W] # to fail on warnings
- repo: https://github.com/MiraGeoscience/pre-commit-hooks
rev: v1.0.1
rev: v1.1.0
hooks:
- id: check-copyright
files: (^LICENSE|^README(|-dev).rst|\.py|\.pyi)$
files: (^package\.rst|^LICENSE|^README(|-dev)\.rst|\.py|\.pyi)$
exclude: (^\.|^docs/)
- id: prepare-commit-msg
- id: check-commit-msg
Expand All @@ -65,7 +67,7 @@ repos:
exclude: (-lock\.ya?ml|\benvironments/.*\.ya?ml|\.ipynb|^THIRD_PARTY_SOFTWARE\.rst)$
entry: codespell -I .codespellignore
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
rev: v5.0.0
hooks:
- id: trailing-whitespace
exclude: \.mdj$
Expand All @@ -74,6 +76,7 @@ repos:
- id: check-toml
- id: check-yaml
- id: check-added-large-files
# args: [--enforce-all]
- id: check-case-conflict
- id: check-merge-conflict
- id: debug-statements
Expand Down
1 change: 1 addition & 0 deletions .rstcheck.cfg
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[rstcheck]
ignore_directives=automodule,jupyter-execute,nbgallery
report_level=WARNING
ignore_substitutions = copyright_notice
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2024 Mira Geoscience
Copyright (c) 2020-2025 Mira Geoscience

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
8 changes: 1 addition & 7 deletions README-dev.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

Setup for development
=====================

Expand Down Expand Up @@ -361,11 +360,6 @@ Here is a suggestion for some plugins you can install in PyCharm.
.. _.pre-commit-config.yaml: .pre-commit-config.yaml


License
^^^^^^^
# TODO: ADD LICENSE TERMS


Copyright
^^^^^^^^^
Copyright (c) 2024 Mira Geoscience Ltd.
Copyright (c) 2020-2025 Mira Geoscience Ltd.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ License
^^^^^^^
MIT License

Copyright (c) 2024 Mira Geoscience
Copyright (c) 2020-2025 Mira Geoscience

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
24 changes: 20 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
import sys
import shutil
import plotly.io as pio
from datetime import datetime
from packaging.version import Version

pio.renderers.default = "sphinx_gallery"

Expand Down Expand Up @@ -92,14 +94,15 @@
master_doc = "index"

# General information about the project.
project = "geoapps v0.13.0-alpha.1"
project = "geoapps"

project_copyright = "%Y, Mira Geoscience Ltd"
author = "Mira Geoscience Ltd."

# The short X.Y version.
version = "0.13.0"
# The full version, including alpha/beta/rc tags.
release = "0.13.0-alpha.1"

# The shorter X.Y.Z version.
version = Version(release).base_version

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down Expand Up @@ -173,6 +176,10 @@
# 'display_github': 'True',
# }

html_theme_options = {
"description": f"version {release}",
}

# html_logo = 'images/mirageoscience-apps.png'

check_meta = False
Expand Down Expand Up @@ -394,3 +401,12 @@

# TODO: build the source
# sphinx-apidoc --templatedir templates/ -o content/api/ ../mirageoscience-apps


def get_copyright_notice():
return f"Copyright {datetime.now().strftime(project_copyright)}"


rst_epilog = f"""
.. |copyright_notice| replace:: {get_copyright_notice()}.
"""
34 changes: 34 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,37 @@ Contents:
content/howto.rst
content/release_notes.rst
content/feedback.rst


License
^^^^^^^
MIT License

Copyright (c) 2020-2025 Mira Geoscience

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Curve-apps is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.


Copyright
^^^^^^^^^
|copyright_notice|
Loading
Loading