Merge pull request #17 from scipp/common-prettyname

Use common prettyname structure

.copier-answers.yml

@@ -1,13 +1,13 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: ec09f73
+_commit: 8cfdb1b
 _src_path: gh:scipp/copier_template
 description: Data reduction for NMX at the European Spallation Source.
 max_python: '3.11'
 min_python: '3.9'
 namespace_package: ess
 nightly_deps: scipp,sciline,scippnexus,plopp
 orgname: scipp
-prettyname: Essnmx
+prettyname: ESSnmx
 projectname: essnmx
 related_projects: Scipp,Sciline,Plopp,ScippNexus
 year: 2023

CONTRIBUTING.md

@@ -1,18 +1,18 @@
-## Contributing to Essnmx
+## Contributing to ESSnmx
 
-Welcome to the developer side of Essnmx!
+Welcome to the developer side of ESSnmx!
 
 Contributions are always welcome.
 This includes reporting bugs or other issues, submitting pull requests, requesting new features, etc.
 
-If you need help with using Essnmx or contributing to it, have a look at the GitHub [discussions](https://github.com/scipp/essnmx/discussions) and start a new [Q&A discussion](https://github.com/scipp/essnmx/discussions/categories/q-a) if you can't find what you are looking for.
+If you need help with using ESSnmx or contributing to it, have a look at the GitHub [discussions](https://github.com/scipp/essnmx/discussions) and start a new [Q&A discussion](https://github.com/scipp/essnmx/discussions/categories/q-a) if you can't find what you are looking for.
 
 For bug reports and other problems, please open an [issue](https://github.com/scipp/essnmx/issues/new) in GitHub.
 
 You are welcome to submit pull requests at any time.
 But to avoid having to make large modifications during review or even have your PR rejected, please first open an issue first to discuss your idea!
 
-Check out the subsections of the [Developer documentation](https://scipp.github.io/essnmx/developer/index.html) for details on how Essnmx is developed.
+Check out the subsections of the [Developer documentation](https://scipp.github.io/essnmx/developer/index.html) for details on how ESSnmx is developed.
 
 ## Code of conduct
 

README.md

@@ -3,7 +3,7 @@
 [![Anaconda-Server Badge](https://anaconda.org/scipp/essnmx/badges/version.svg)](https://anaconda.org/scipp/essnmx)
 [![License: BSD 3-Clause](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](LICENSE)
 
-# Essnmx
+# ESSnmx
 
 ## About
 

conda/meta.yaml

@@ -22,14 +22,15 @@ requirements:
 
 test:
  imports:
- - essnmx
+ - ess.nmx
  requires:
  - pytest
  source_files:
  - pyproject.toml
  - tests/
  commands:
- - python -m pytest tests
+ # We ignore warnings during release package builds
+ - python -m pytest -Wignore tests
 
 build:
  noarch: python

docs/about/index.md

@@ -2,19 +2,19 @@
 
 ## Development
 
-Essnmx is an open source project by the [European Spallation Source ERIC](https://europeanspallationsource.se/) (ESS).
+ESSnmx is an open source project by the [European Spallation Source ERIC](https://europeanspallationsource.se/) (ESS).
 
 ## License
 
-Essnmx is available as open source under the [BSD-3 license](https://opensource.org/licenses/BSD-3-Clause).
+ESSnmx is available as open source under the [BSD-3 license](https://opensource.org/licenses/BSD-3-Clause).
 
-## Citing Essnmx
+## Citing ESSnmx
 
 Please cite the following:
 
 [![DOI](https://zenodo.org/badge/FIXME.svg)](https://zenodo.org/doi/10.5281/zenodo.FIXME)
 
-To cite a specific version of Essnmx, select the desired version on Zenodo to get the corresponding DOI.
+To cite a specific version of ESSnmx, select the desired version on Zenodo to get the corresponding DOI.
 
 ## Older versions of the documentation
 
@@ -23,4 +23,4 @@ Simply download the archive, unzip and view locally in a web browser.
 
 ## Source code and development
 
-Essnmx is hosted and developed [on GitHub](https://github.com/scipp/essnmx).
+ESSnmx is hosted and developed [on GitHub](https://github.com/scipp/essnmx).

docs/conf.py

@@ -9,7 +9,7 @@
 sys.path.insert(0, os.path.abspath('.'))
 
 # General information about the project.
-project = u'Essnmx'
+project = u'ESSnmx'
 copyright = u'2023 Scipp contributors'
 author = u'Scipp contributors'
 
@@ -167,7 +167,7 @@
  "**": ["sidebar-nav-bs", "page-toc"],
 }
 
-html_title = "Essnmx"
+html_title = "ESSnmx"
 html_logo = "_static/logo.svg"
 html_favicon = "_static/favicon.ico"
 

docs/index.md

@@ -1,4 +1,4 @@
-# Essnmx
+# ESSnmx
 
 <span style="font-size:1.2em;font-style:italic;color:#5a5a5a">
  Data reduction for NMX at the European Spallation Source.