diff --git a/CITATION.cff b/CITATION.cff index d4cbc76..96a3996 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -9,10 +9,10 @@ authors: - name: "Lasio contributors" website: "https://lasio.readthedocs.io/en/latest/contributing.html" repository-code: "https://github.com/kinverarity1/lasio" -version: 0.30 -url: https://github.com/kinverarity1/lasio/releases/tag/v0.30 +version: 0.31 +url: https://github.com/kinverarity1/lasio/releases/tag/v0.31 commit: 357cec616fbcc7d47b5a77ea4087433b6e52acdc -date-released: 2022-05-12 +date-released: 2023-05-18 license: MIT type: software diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst index 9e67636..e6160c9 100644 --- a/docs/source/changelog.rst +++ b/docs/source/changelog.rst @@ -5,6 +5,14 @@ List of changes Unreleased changes (Available on GitHub) ---------------------------------------- + +Version 0.31 (18 May 2023) +-------------------------- +- Many improvements to code style and formatting, and the documentation +- `#555` - Fix problem when writing with changed data (different number of depths) +- `#554` / `#556` - Enable DLM (delimiter) TAB +- `#552` - Remove or replace cchardet with chardet +- `#530` - Detect hyphens in data section and adjust regexp_subs as needed - Fix `#322`_ - provide a way to consistently retrieve header items which may or may not be present in the header: @@ -480,3 +488,110 @@ Version 0.2 (2015-07-08) .. _#501: https://github.com/kinverarity1/lasio/pull/501 .. _#502: https://github.com/kinverarity1/lasio/issues/502 .. _#503: https://github.com/kinverarity1/lasio/pull/503 +.. _#168: https://github.com/kinverarity1/lasio/issues/168 +.. _#221: https://github.com/kinverarity1/lasio/issues/221 +.. _#225: https://github.com/kinverarity1/lasio/issues/225 +.. _#239: https://github.com/kinverarity1/lasio/issues/239 +.. _#249: https://github.com/kinverarity1/lasio/issues/249 +.. _#252: https://github.com/kinverarity1/lasio/issues/252 +.. _#258: https://github.com/kinverarity1/lasio/issues/258 +.. _#286: https://github.com/kinverarity1/lasio/issues/286 +.. _#292: https://github.com/kinverarity1/lasio/issues/292 +.. _#293: https://github.com/kinverarity1/lasio/issues/293 +.. _#296: https://github.com/kinverarity1/lasio/issues/296 +.. _#298: https://github.com/kinverarity1/lasio/issues/298 +.. _#300: https://github.com/kinverarity1/lasio/issues/300 +.. _#302: https://github.com/kinverarity1/lasio/issues/302 +.. _#311: https://github.com/kinverarity1/lasio/issues/311 +.. _#317: https://github.com/kinverarity1/lasio/issues/317 +.. _#318: https://github.com/kinverarity1/lasio/issues/318 +.. _#325: https://github.com/kinverarity1/lasio/issues/325 +.. _#326: https://github.com/kinverarity1/lasio/issues/326 +.. _#327: https://github.com/kinverarity1/lasio/issues/327 +.. _#328: https://github.com/kinverarity1/lasio/issues/328 +.. _#329: https://github.com/kinverarity1/lasio/issues/329 +.. _#330: https://github.com/kinverarity1/lasio/issues/330 +.. _#331: https://github.com/kinverarity1/lasio/issues/331 +.. _#334: https://github.com/kinverarity1/lasio/issues/334 +.. _#335: https://github.com/kinverarity1/lasio/issues/335 +.. _#337: https://github.com/kinverarity1/lasio/issues/337 +.. _#338: https://github.com/kinverarity1/lasio/issues/338 +.. _#340: https://github.com/kinverarity1/lasio/issues/340 +.. _#341: https://github.com/kinverarity1/lasio/issues/341 +.. _#342: https://github.com/kinverarity1/lasio/issues/342 +.. _#345: https://github.com/kinverarity1/lasio/issues/345 +.. _#346: https://github.com/kinverarity1/lasio/issues/346 +.. _#347: https://github.com/kinverarity1/lasio/issues/347 +.. _#348: https://github.com/kinverarity1/lasio/issues/348 +.. _#349: https://github.com/kinverarity1/lasio/issues/349 +.. _#352: https://github.com/kinverarity1/lasio/issues/352 +.. _#353: https://github.com/kinverarity1/lasio/issues/353 +.. _#355: https://github.com/kinverarity1/lasio/issues/355 +.. _#358: https://github.com/kinverarity1/lasio/issues/358 +.. _#360: https://github.com/kinverarity1/lasio/issues/360 +.. _#361: https://github.com/kinverarity1/lasio/issues/361 +.. _#367: https://github.com/kinverarity1/lasio/issues/367 +.. _#368: https://github.com/kinverarity1/lasio/issues/368 +.. _#369: https://github.com/kinverarity1/lasio/issues/369 +.. _#372: https://github.com/kinverarity1/lasio/issues/372 +.. _#374: https://github.com/kinverarity1/lasio/issues/374 +.. _#382: https://github.com/kinverarity1/lasio/issues/382 +.. _#385: https://github.com/kinverarity1/lasio/issues/385 +.. _#387: https://github.com/kinverarity1/lasio/issues/387 +.. _#390: https://github.com/kinverarity1/lasio/issues/390 +.. _#391: https://github.com/kinverarity1/lasio/issues/391 +.. _#393: https://github.com/kinverarity1/lasio/issues/393 +.. _#396: https://github.com/kinverarity1/lasio/issues/396 +.. _#397: https://github.com/kinverarity1/lasio/issues/397 +.. _#398: https://github.com/kinverarity1/lasio/issues/398 +.. _#399: https://github.com/kinverarity1/lasio/issues/399 +.. _#400: https://github.com/kinverarity1/lasio/issues/400 +.. _#401: https://github.com/kinverarity1/lasio/issues/401 +.. _#403: https://github.com/kinverarity1/lasio/issues/403 +.. _#406: https://github.com/kinverarity1/lasio/issues/406 +.. _#410: https://github.com/kinverarity1/lasio/issues/410 +.. _#411: https://github.com/kinverarity1/lasio/issues/411 +.. _#418: https://github.com/kinverarity1/lasio/issues/418 +.. _#420: https://github.com/kinverarity1/lasio/issues/420 +.. _#423: https://github.com/kinverarity1/lasio/issues/423 +.. _#425: https://github.com/kinverarity1/lasio/issues/425 +.. _#428: https://github.com/kinverarity1/lasio/issues/428 +.. _#429: https://github.com/kinverarity1/lasio/issues/429 +.. _#430: https://github.com/kinverarity1/lasio/issues/430 +.. _#432: https://github.com/kinverarity1/lasio/issues/432 +.. _#437: https://github.com/kinverarity1/lasio/issues/437 +.. _#438: https://github.com/kinverarity1/lasio/issues/438 +.. _#441: https://github.com/kinverarity1/lasio/issues/441 +.. _#447: https://github.com/kinverarity1/lasio/issues/447 +.. _#449: https://github.com/kinverarity1/lasio/issues/449 +.. _#451: https://github.com/kinverarity1/lasio/issues/451 +.. _#452: https://github.com/kinverarity1/lasio/issues/452 +.. _#455: https://github.com/kinverarity1/lasio/issues/455 +.. _#459: https://github.com/kinverarity1/lasio/issues/459 +.. _#460: https://github.com/kinverarity1/lasio/issues/460 +.. _#461: https://github.com/kinverarity1/lasio/issues/461 +.. _#465: https://github.com/kinverarity1/lasio/issues/465 +.. _#466: https://github.com/kinverarity1/lasio/issues/466 +.. _#469: https://github.com/kinverarity1/lasio/issues/469 +.. _#470: https://github.com/kinverarity1/lasio/issues/470 +.. _#471: https://github.com/kinverarity1/lasio/issues/471 +.. _#475: https://github.com/kinverarity1/lasio/issues/475 +.. _#479: https://github.com/kinverarity1/lasio/issues/479 +.. _#480: https://github.com/kinverarity1/lasio/issues/480 +.. _#481: https://github.com/kinverarity1/lasio/issues/481 +.. _#482: https://github.com/kinverarity1/lasio/issues/482 +.. _#484: https://github.com/kinverarity1/lasio/issues/484 +.. _#485: https://github.com/kinverarity1/lasio/issues/485 +.. _#487: https://github.com/kinverarity1/lasio/issues/487 +.. _#489: https://github.com/kinverarity1/lasio/issues/489 +.. _#491: https://github.com/kinverarity1/lasio/issues/491 +.. _#495: https://github.com/kinverarity1/lasio/issues/495 +.. _#498: https://github.com/kinverarity1/lasio/issues/498 +.. _#500: https://github.com/kinverarity1/lasio/issues/500 +.. _#501: https://github.com/kinverarity1/lasio/issues/501 +.. _#503: https://github.com/kinverarity1/lasio/issues/503 +.. _#530: https://github.com/kinverarity1/lasio/issues/530 +.. _#552: https://github.com/kinverarity1/lasio/issues/552 +.. _#554: https://github.com/kinverarity1/lasio/issues/554 +.. _#555: https://github.com/kinverarity1/lasio/issues/555 +.. _#556: https://github.com/kinverarity1/lasio/issues/556 diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst index a6a50a4..a583b02 100644 --- a/docs/source/contributing.rst +++ b/docs/source/contributing.rst @@ -2,34 +2,13 @@ Contributing to lasio ========================= lasio is an open source project released under the -MIT License. It has grown over the years through the wonderful work of all these -`contributors `__: - -* `adamwulf `__ -* `ae3e `__ -* `ahjulstad `__ -* `eimerej `_ -* `dagrha `__ -* `dbhart `__ -* `dcslagel `__ -* `Fry484 `__ -* `JustinGOSSES `__ -* `Jyhess `__ -* `kinverarity1 `__ -* `kwinkunks `__ -* `MandarJKulkarni `__ -* `nasedil `__ -* `oliveirarodolfo `__ -* `roliveira `__ -* `trqmorgan `__ -* `VelizarVESSELINOV `__ - -Thank you also to everyone who has helped via email, in discussions -on GitHub, and on `software underground `__! +MIT License. It has grown over the years through the wonderful work of many +`contributors `__ +on GitHub, and through many discussions. Your help is very welcome! No contribution is too small. You can help with the documentation, adding example notebooks, posting ideas or feature requests to -GitHub, or by working on the code - or anything else! +GitHub, or by working on the code - or anything else. Places you can help ---------------------------- @@ -177,7 +156,7 @@ To run tests yourself: .. _GitHub Actions: https://github.com/kinverarity1/lasio/actions/workflows/ci-tests.yml -Comparative Benchmarking of performance when reading LAS files +Comparative benchmarking of performance when reading LAS files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The test file ``tests/test_speed.py`` reads in a large LAS file and is used @@ -240,11 +219,11 @@ Publishing a new release 3. Check for any local changes to main: ``$ git status`` - test locally and push if necessary. 4. Check that `GitHub Actions Python CI `__ for main is passing. 5. Find changes since last version release: see `list of commits `__. -6. Summarise these changes in :ref:`ChangeLog`. +6. Summarise these changes in ``changelog.rst``. 7. Run the Jupyter Noteook at `docs/Add links to GitHub for all issue and PR refs in changelog.ipynb `__ to add hyperlinks for all issue and PR references. -8. Edit the citation file: `CITATION.cff `__ -9. Commit with a message e.g. ``Release v1.3`` -10. Tag with the same message e.g. ``git tag v1.3`` +8. Edit the citation file: ``CITATION.cff`` +9. Commit with a message e.g. ``Release v0.31`` +10. Tag with the same message e.g. ``git tag v0.31`` 11. Push to github - first the commit: ``git push origin main --tags`` 12. Create a universal wheel: ``python setup.py bdist_wheel --universal`` 13. This will put a new wheel file in ``dist/``