Rename to grid3d-maps

.github/actions/build-xtgeoapp-grd3dmaps/action.yml → .github/actions/build-grid3d-maps/action.yml

@@ -1,5 +1,5 @@
 name: Build
-description: Builds xtgeoapp-grd3dmaps
+description: Builds grid3d-maps
 
 inputs:
   python-version:
@@ -13,7 +13,7 @@ runs:
       with:
         python-version: ${{ inputs.python-version }}
 
-    - name: Install xtgeoapp-grd3maps
+    - name: Install grid3d-maps
       run: |
         python -m pip install -U pip
         pip install .

.github/actions/test_setup/action.yml

@@ -1,5 +1,5 @@
 name: "Set up for tests"
-description: "Set up the xtgeoapp-grd3dmaps test environment"
+description: "Set up the grid3d-maps test environment"
 
 inputs:
   python-version:
@@ -8,7 +8,7 @@ inputs:
 runs:
   using: "composite"
   steps:
-    - uses: "./.github/actions/build-xtgeoapp-grd3dmaps"
+    - uses: "./.github/actions/build-grid3d-maps"
       with:
         python-version: ${{ inputs.python-version }}
     - run: pip install ".[tests]"

.github/workflows/publish.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     environment:
       name: pypi
-      url: https://pypi.org/p/xtgeoapp-grd3dmaps
+      url: https://pypi.org/p/grid3d-maps
     permissions:
       id-token: write
 

.gitignore

@@ -43,8 +43,8 @@ coverage.xml
 *,cover
 .hypothesis/
 TMP/
-src/xtgeoapp_grd3dmaps/_theversion.py
-src/xtgeoapp_grd3dmaps/version.py
+src/grid3d_maps/_theversion.py
+src/grid3d_maps/version.py
 
 # Translations
 *.mo

CONTRIBUTING.rst

@@ -15,7 +15,7 @@ Types of Contributions
 Report Bugs
 ~~~~~~~~~~~
 
-Report bugs at https://github.com/equinor/xtgeoapp-grd3dmaps/issues.
+Report bugs at https://github.com/equinor/grid3d-maps/issues.
 
 If you are reporting a bug, please include:
 
@@ -38,15 +38,15 @@ and "help wanted" is open to whoever wants to implement it.
 Write Documentation
 ~~~~~~~~~~~~~~~~~~~
 
-xtgeoapp-grd3dmaps could always use more documentation, whether as part of the
-official xtgeoapp-grd3dmaps docs, in docstrings, or even on the web in blog posts,
+grid3d-maps could always use more documentation, whether as part of the
+official grid3d-maps docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
 Submit Feedback
 ~~~~~~~~~~~~~~~
 
 The best way to send feedback is to file an issue
-at https://github.com/equinor/xtgeoapp-grd3dmaps/issues.
+at https://github.com/equinor/grid3d-maps/issues.
 
 If you are proposing a feature:
 
@@ -58,18 +58,18 @@ If you are proposing a feature:
 Get Started!
 ------------
 
-Ready to contribute? Here's how to set up `xtgeoapp-grd3dmaps` for local development.
+Ready to contribute? Here's how to set up `grid3d-maps` for local development.
 
-1. Fork the `xtgeoapp-grd3dmaps` repo on Github equinor
+1. Fork the `grid3d-maps` repo on Github equinor
 2. Clone your fork locally::
 
-    $ git clone git@github.com:your_name_here/xtgeoapp-grd3dmaps.git
+    $ git clone git@github.com:your_name_here/grid3d-maps.git
 
 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed,
    this is how you set up your fork for local development::
 
-    $ mkvirtualenv xtgeoapp-grd3dmaps
-    $ cd xtgeoapp-grd3dmaps/
+    $ mkvirtualenv grid3d-maps
+    $ cd grid3d-maps/
     $ python setup.py develop
 
 4. Create a branch for local development::
@@ -81,7 +81,7 @@ Ready to contribute? Here's how to set up `xtgeoapp-grd3dmaps` for local develop
 5. When you're done making changes, check that your changes pass flake8 and the tests,
    including testing other Python versions with tox::
 
-    $ flake8 xtgeoapp-grd3dmaps tests
+    $ flake8 grid3d-maps tests
     $ python setup.py test or py.test
 
    To get flake8 etc, just pip install them into your virtualenv.

HISTORY.rst

@@ -4,5 +4,5 @@ History
 
 See commits and releases on Github:
 
-* https://github.com/equinor/xtgeoapp-grd3dmaps/commits/main
-* https://github.com/equinor/xtgeoapp-grd3dmaps/releases
+* https://github.com/equinor/grid3d-maps/commits/main
+* https://github.com/equinor/grid3d-maps/releases

Makefile

@@ -30,7 +30,7 @@ endef
 export PRINT_HELP_PYSCRIPT
 
 
-APPLICATION := xtgeoapp_grd3dmaps
+APPLICATION := grid3d_maps
 DOCSINSTALL := /project/sdpdocs/XTGeo/apps
 
 BROWSER := firefox

README.md

@@ -1,8 +1,8 @@
-# xtgeoapp-grd3dmaps
+# grid3d-maps
 
-[![tests](https://github.com/equinor/xtgeoapp-grd3dmaps/actions/workflows/test.yml/badge.svg)](https://github.com/equinor/xtgeoapp-grd3dmaps/actions/workflows/test.yml)
+[![tests](https://github.com/equinor/grid3d-maps/actions/workflows/test.yml/badge.svg)](https://github.com/equinor/grid3d-maps/actions/workflows/test.yml)
 ![Python Version](https://img.shields.io/badge/python-3.8%20|%203.9%20|%203.10%20|%203.11-blue.svg)
-[![License: GPL v3](https://img.shields.io/github/license/equinor/subscript)](https://www.gnu.org/licenses/gpl-3.0)
+[![License: GPL v3](https://img.shields.io/github/license/equinor/grid3d-maps)](https://www.gnu.org/licenses/gpl-3.0)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 Various scripts for generating maps from 3D grid properties.

docs/Makefile

@@ -86,17 +86,17 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/xtgeoapp_grd3dmaps.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/grid3d_maps.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/xtgeoapp_grd3dmaps.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/grid3d_maps.qhc"
 
 devhelp:
 	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 	@echo
 	@echo "Build finished."
 	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/xtgeoapp_grd3dmaps"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/xtgeoapp_grd3dmaps"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/grid3d_maps"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/grid3d_maps"
 	@echo "# devhelp"
 
 epub:

docs/conf.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# xtgeoapp_grd3dmaps documentation build configuration file, created by
+# grid3d_maps documentation build configuration file, created by
 # sphinx-quickstart on Tue Jul  9 22:26:36 2013.
 #
 # This file is execfile()d with the current directory set to its
@@ -12,8 +12,8 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys
 import os
+import sys
 
 # If extensions (or modules to document with autodoc) are in another
 # directory, add these directories to sys.path here. If the directory is
@@ -30,7 +30,7 @@
 
 sys.path.insert(0, project_root)
 
-import xtgeoapp_grd3dmaps
+import grid3d_maps
 
 # -- General configuration ---------------------------------------------
 
@@ -59,17 +59,17 @@
 master_doc = "index"
 
 # General information about the project.
-project = u"xtgeoapp_grd3dmaps"
+project = u"grid3d_maps"
 copyright = u"equinor (contact person: Jan C. Rivenæs, JRIV@equinor.com)"
 
 # The version info for the project you're documenting, acts as replacement
 # for |version| and |release|, also used in various other places throughout
 # the built documents.
 #
 # The short X.Y version.
-version = xtgeoapp_grd3dmaps.__version__
+version = grid3d_maps.__version__
 # The full version, including alpha/beta/rc tags.
-release = xtgeoapp_grd3dmaps.__version__
+release = grid3d_maps.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -192,7 +192,7 @@
 # html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "xtgeoapp_grd3dmapsdoc"
+htmlhelp_basename = "grid3d_mapsdoc"
 
 
 # -- Options for LaTeX output ------------------------------------------
@@ -212,8 +212,8 @@
 latex_documents = [
     (
         "index",
-        "xtgeoapp_grd3dmaps.tex",
-        u"xtgeoapp_grd3dmaps Documentation",
+        "grid3d_maps.tex",
+        u"grid3d_maps Documentation",
         u"Jan C. Rivenaes",
         "manual",
     ),
@@ -247,8 +247,8 @@
 man_pages = [
     (
         "index",
-        "xtgeoapp_grd3dmaps",
-        u"xtgeoapp_grd3dmaps Documentation",
+        "grid3d_maps",
+        u"grid3d_maps Documentation",
         [u"Jan C. Rivenaes"],
         1,
     )
@@ -266,10 +266,10 @@
 texinfo_documents = [
     (
         "index",
-        "xtgeoapp_grd3dmaps",
-        u"xtgeoapp_grd3dmaps Documentation",
+        "grid3d_maps",
+        u"grid3d_maps Documentation",
         u"Jan C. Rivenaes",
-        "xtgeoapp_grd3dmaps",
+        "grid3d_maps",
         "One line description of project.",
         "Miscellaneous",
     ),

docs/index.rst

@@ -1,4 +1,4 @@
-Welcome to xtgeoapp_grd3dmaps' documentation!
+Welcome to grid3d_maps' documentation!
 =============================================
 
 Contents:

docs/installation.rst

@@ -21,14 +21,14 @@ The stable release is on /project/res, so scripts can be run as:
 From sources
 ------------
 
-The sources for xtgeoapp_grd3dmaps can be downloaded from
+The sources for grid3d_maps can be downloaded from
 the `equinor Git repo`_.
 
 You can then clone the repository:
 
 .. code-block:: console
 
-    $ git clone git@github.com:equinor/xtgeoapp-grd3dmaps
+    $ git clone git@github.com:equinor/grid3d-maps
 
 Once you have a copy of the source, and you have a `virtual environment`_,
 you can install locally (for development and testing) it with:
@@ -40,5 +40,5 @@ you can install locally (for development and testing) it with:
 However, if you will like to contribute, making a personal fork is strongly
 recommended, see :ref:`Contributing`.
 
-.. _equinor Git repo: https://github.com/equinor/xtgeoapp-grd3dmaps
+.. _equinor Git repo: https://github.com/equinor/grid3d-maps
 .. _virtual environment: http://docs.python-guide.org/en/latest/dev/virtualenvs/

docs/make.bat

@@ -115,9 +115,9 @@ if "%1" == "qthelp" (
 	echo.
 	echo.Build finished; now you can run "qcollectiongenerator" with the ^
 .qhcp project file in %BUILDDIR%/qthelp, like this:
-	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\xtgeoapp_grd3dmaps.qhcp
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\grid3d_maps.qhcp
 	echo.To view the help file:
-	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\xtgeoapp_grd3dmaps.ghc
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\grid3d_maps.ghc
 	goto end
 )
 

pyproject.toml

@@ -6,10 +6,10 @@ requires = [
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools_scm]
-write_to = "src/xtgeoapp_grd3dmaps/version.py"
+write_to = "src/grid3d_maps/version.py"
 
 [project]
-name = "xtgeoapp_grd3dmaps"
+name = "grid3d_maps"
 description = "Make HC thickness, avg maps, etc directly from 3D props"
 readme = "README.md"
 requires-python = ">=3.8"
@@ -79,18 +79,18 @@ docs = [
 ]
 
 [project.urls]
-Homepage = "https://github.com/equinor/xtgeoapp-grd3dmaps"
-Repository = "https://github.com/equinor/xtgeoapp-grd3dmaps"
-Documentation = "https://equinor.github.io/xtgeoapp-grd3dmaps"
+Homepage = "https://github.com/equinor/grid3d-maps"
+Repository = "https://github.com/equinor/grid3d-maps"
+Documentation = "https://equinor.github.io/grid3d-maps"
 
 [project.scripts]
-grid3d_hc_thickness = "xtgeoapp_grd3dmaps.avghc.grid3d_hc_thickness:main"
-grid3d_average_map = "xtgeoapp_grd3dmaps.avghc.grid3d_average_map:main"
-grid3d_aggregate_map = "xtgeoapp_grd3dmaps.aggregate.grid3d_aggregate_map:main"
-grid3d_migration_time = "xtgeoapp_grd3dmaps.aggregate.grid3d_migration_time:main"
+grid3d_hc_thickness = "grid3d_maps.avghc.grid3d_hc_thickness:main"
+grid3d_average_map = "grid3d_maps.avghc.grid3d_average_map:main"
+grid3d_aggregate_map = "grid3d_maps.aggregate.grid3d_aggregate_map:main"
+grid3d_migration_time = "grid3d_maps.aggregate.grid3d_migration_time:main"
 
 [project.entry-points.ert]
-xtgeoapp_grd3dmaps_jobs = "xtgeoapp_grd3dmaps.hook_implementations.jobs"
+grid3d_maps_jobs = "grid3d_maps.hook_implementations.jobs"
 
 [tool.black]
 line-length = 88

src/xtgeoapp_grd3dmaps/__init__.py → src/grid3d_maps/__init__.py

@@ -1,4 +1,4 @@
-"""Top-level package for xtgeoapp_grd3dmaps"""
+"""Top-level package for grid3d_maps"""
 
 try:
     from ._theversion import version

src/xtgeoapp_grd3dmaps/aggregate/_grid_aggregation.py → src/grid3d_maps/aggregate/_grid_aggregation.py

@@ -8,7 +8,7 @@
 import scipy.spatial
 import xtgeo
 
-from xtgeoapp_grd3dmaps.aggregate._config import AggregationMethod
+from grid3d_maps.aggregate._config import AggregationMethod
 
 
 def aggregate_maps(

src/xtgeoapp_grd3dmaps/aggregate/_parser.py → src/grid3d_maps/aggregate/_parser.py

@@ -7,8 +7,8 @@
 import xtgeo
 import yaml
 
-from xtgeoapp_grd3dmaps.aggregate import _config
-from xtgeoapp_grd3dmaps.aggregate._config import (
+from grid3d_maps.aggregate import _config
+from grid3d_maps.aggregate._config import (
     ComputeSettings,
     Input,
     MapSettings,

src/xtgeoapp_grd3dmaps/aggregate/grid3d_aggregate_map.py → src/grid3d_maps/aggregate/grid3d_aggregate_map.py

@@ -6,15 +6,15 @@
 import xtgeo
 from xtgeo.common import XTGeoDialog
 
-from xtgeoapp_grd3dmaps.aggregate._config import (
+from grid3d_maps.aggregate._config import (
     AggregationMethod,
     ComputeSettings,
     Input,
     MapSettings,
     Output,
     Zonation,
 )
-from xtgeoapp_grd3dmaps.aggregate._parser import (
+from grid3d_maps.aggregate._parser import (
     create_map_template,
     extract_properties,
     extract_zonations,
@@ -29,7 +29,7 @@
 # Module variables for ERT hook implementation:
 DESCRIPTION = (
     "Aggregate property maps from 3D grids. Docs:\n"
-    + "https://fmu-docs.equinor.com/docs/xtgeoapp-grd3dmaps/"
+    + "https://fmu-docs.equinor.com/docs/grid3d-maps/"
 )
 CATEGORY = "modelling.reservoir"
 EXAMPLES = """