Release v0.4.2 #100

Bachibouzouk · 2023-11-08T21:33:11Z

Remaining TODO in this PR:

update changelog
update AUTHORS
bump version number
once it is merged into main do not delete the branch but merge it into development

The old docs/input_parameters.md file was not included in the document. The new file with rst format is added to the documentations in: docs/source/input_parameters.rst

Addine the new input_parameters to index.rst and removing the old file.

pypi test release on push for main branch

Setting Workflows (issue #71)

I have made minor edits to correct small typos or improve clarity

Input pars doc

Fix and enhance documentation

Our previous settings are deprecated since September 25th 2023 https://blog.readthedocs.com/migrate-configuration-v2/

Mimimum required readthedocs config file

…ommand-cli Hotfix/hidden result files command cli

Fixed a few small spelling errors.

Fixed the mismatch between a title length and the underlying line of "~" symbols, as requested by the reviewers

This fixes the problem currently blocking PR #96

Fix/docs errors

updating the secrets for API Token for the automatic test release of software after Pushes and PRs to developemnt and main

using kebab-case for skip-exisiting and repository-url

solving the test.pypi release issue #96

The new features added will allow the user to perform some data analysis and visualization routines: changes ------ *. ramp/post_process/post_process.py - the class Plot is the main class carrying on the plotting and data analysis functionalities with custom APIs providing access to some pd.DataFrame features also easy to plot functions conencting to plotly and matplotlibe methods. - different plotting classes that include a specific plot type visualiztion using two different engines (plotly & matplotlib) *. ramp.__init__.py - adding the Plot class to the init. documentation ------------- - the functions API docuemntation is added to the API documentaiton - A full example titled "Plot class" is added to the example gallery describing the full potential of the new functionalities

- Improving the Plot class docstring - Improving the error handling with invalid inputs by user regarding the file extensions and plot engine - Improving the readability of the plotting scripts by merging the plot classes into Plot methods

Plot class for ramp visualization and data analysis routines (isse #63)

mohammadamint · 2023-11-08T22:30:38Z

Remaining TODO in this PR:

update changelog

update AUTHORS

bump version number

once it is merged into main do not delete the branch but merge it into development

@Bachibouzouk I would add black and maybe isort to the list!

Bachibouzouk · 2023-11-08T23:23:57Z

@Bachibouzouk I would add black and maybe isort to the list!

Then we should do this in separate PRs and then I will rebase the release branch on the dev branch once this has been merged. Normally the release branch should not have too much "work" done into it, only release related stuff: because for black one could apply black and setup a github action which rejects not black linted code. For that we need to pin a black version in the requirements. I would not consider those "release related" commits.

Edit --> I did open a PR in #101

FLomb · 2023-11-09T12:34:54Z

I think it would be great if we could also quickly address issue #83 as part of the new release since that is blocking several old-school users, while it seems that we have found a relatively easy fix in the related GitHub thread. I can implement myself the proposed fix if needed, but it would make more sense for @Bachibouzouk to set up a PR since he proposed such a fix.

Bachibouzouk · 2023-11-09T13:04:26Z

I can implement myself the proposed fix if needed, but it would make more sense for @Bachibouzouk to set up a PR since he proposed such a fix.

Gladly, I just cannot promise I'll to do it by tomorrow :) I will do it after the lint PR is accepted so I can work with linted code :)

FLomb · 2023-11-09T13:10:59Z

I can implement myself the proposed fix if needed, but it would make more sense for @Bachibouzouk to set up a PR since he proposed such a fix.

Gladly, I just cannot promise I'll to do it by tomorrow :) I will do it after the lint PR is accepted so I can work with linted code :)

Sure, no hurry! (: Thanks

FLomb · 2023-12-05T11:10:56Z

Having finalised PR #102 , we should proceed with the new code release. This was originally meant to be v0.4.2, but we agreed in the last developers meeting to name it instead v0.5.0.

So, I think that what needs to happen here is to update the changelog to call this v0.5.0. Are there any other missing things?

The Zenodo publication of the new release has been automated via the Zenodo web interface, so it will automatically happen.

FLomb · 2023-12-05T11:12:24Z

Having finalised PR #102 , we should proceed with the new code release. This was originally meant to be v0.4.2, but we agreed in the last developers meeting to name it instead v0.5.0.

So, I think that what needs to happen here is to update the changelog to call this v0.5.0. Are there any other missing things?

The Zenodo publication of the new release has been automated via the Zenodo web interface, so it will automatically happen.

I guess another thing is indeed to update the AUTHORS file to add those who will be part of the JOSS paper but are not yet mentioned there

Bachibouzouk · 2023-12-05T11:46:53Z

So, I think that what needs to happen here is to update the changelog to call this v0.5.0. Are there any other missing things?

I would rather create a new branch release/0.5.0 from development, close this PR and start a new one :)

What needs to be done is already listed in this PR's description

Bachibouzouk · 2023-12-05T21:29:18Z

Taken cared of in #106

mohammadamint and others added 30 commits March 1, 2023 11:58

Create the publish-pypi workflow (issue #71)

48db186

pypi test distribution workflow ( issue #71 )

392588f

Fix installation guide and small typos

bd3fbcd

Fix rst ordered list

d569ce9

Fix rst ordered list again

fa20d26

Fix rst

68a2d9c

Fix RST

9f0b982

fix rst

0e33970

fix rst

b6770a0

Add pip and rampdemand to environment.yml

4654f6b

Remove unwanted file

441d7d1

wrong path in input_file_2.py

5292b91

The parameter description are not included in the docs (issue #59)

c3f3da9

The old docs/input_parameters.md file was not included in the document. The new file with rst format is added to the documentations in: docs/source/input_parameters.rst

addin the input_parameters to index.rst

14af0a2

Addine the new input_parameters to index.rst and removing the old file.

Improving the test-pypi workflow

96dbcaf

pypi test release on push for main branch

Merge pull request #72 from RAMP-project/workflows

0c91a37

Setting Workflows (issue #71)

Minor fix to README.rst

c3292c8

fix broken path input_file_2.py

6da5b48

Minor edits to input_parameters.rst

b6aa104

I have made minor edits to correct small typos or improve clarity

Merge pull request #75 from RAMP-project/input_pars_doc

d880934

Input pars doc

update the changelog

9e81d2f

remove redundant requirements

0edfd0b

update environment.yml

091542c

Update README.rst requirement section

d9929fe

Merge pull request #76 from RAMP-project/fix-and-enhance-documentation

c333ffa

Fix and enhance documentation

Add mandatory build-os parameter to RTD config

7b9222e

Our previous settings are deprecated since September 25th 2023 https://blog.readthedocs.com/migrate-configuration-v2/

Merge branch 'development' into hotfix/hidden-result-files-command-cli

bea0769

Merge pull request #85 from RAMP-project/fix/rtd-deprecated

e82e3b3

Mimimum required readthedocs config file

Merge pull request #87 from RAMP-project/hotfix/hidden-result-files-c…

1cb8320

…ommand-cli Hotfix/hidden result files command cli

Update README.rst

6c55416

Fixed a few small spelling errors.

FLomb and others added 13 commits November 6, 2023 14:23

Fixed typos and minor edits to docs and notebooks

4c05006

Improve .rst title formatting

9ce7d7c

Fixed the mismatch between a title length and the underlying line of "~" symbols, as requested by the reviewers

Update README.rst to fix line-length issue

2a52401

This fixes the problem currently blocking PR #96

Merge pull request #95 from RAMP-project/fix/docs-erros

70368f7

Fix/docs errors

solving the test.pypi release issue #96

8b15d8d

updating the secrets for API Token for the automatic test release of software after Pushes and PRs to developemnt and main

Update python-pypi-test.yml

cda75e3

using kebab-case for skip-exisiting and repository-url

Merge pull request #97 from RAMP-project/test-pypy-action

38accd4

solving the test.pypi release issue #96

adding the new dependencies to the requirements

da26874

Update RTD

0c01599

PR #89 reviews

511d90b

- Improving the Plot class docstring - Improving the error handling with invalid inputs by user regarding the file extensions and plot engine - Improving the readability of the plotting scripts by merging the plot classes into Plot methods

Update docs requirements

5766f8c

Merge pull request #89 from RAMP-project/ramp_visualization

a57b121

Plot class for ramp visualization and data analysis routines (isse #63)

Bachibouzouk requested review from mohammadamint and FLomb November 8, 2023 21:33

Update changelog

6815a4d

FLomb mentioned this pull request Dec 4, 2023

Automatizing the conversion of jupyter examples to rst #105

Merged

FLomb changed the title ~~Release v0.4.2~~ Release v0.5.0 Dec 5, 2023

Bachibouzouk changed the title ~~Release v0.5.0~~ Release v0.4.2 Dec 5, 2023

Bachibouzouk closed this Dec 5, 2023

Bachibouzouk deleted the release/0.4.2 branch December 6, 2023 14:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release v0.4.2 #100

Release v0.4.2 #100

Bachibouzouk commented Nov 8, 2023 •

edited

Loading

mohammadamint commented Nov 8, 2023 •

edited

Loading

Bachibouzouk commented Nov 8, 2023 •

edited

Loading

FLomb commented Nov 9, 2023

Bachibouzouk commented Nov 9, 2023

FLomb commented Nov 9, 2023

FLomb commented Dec 5, 2023

FLomb commented Dec 5, 2023

Bachibouzouk commented Dec 5, 2023

Bachibouzouk commented Dec 5, 2023

Release v0.4.2 #100

Release v0.4.2 #100

Conversation

Bachibouzouk commented Nov 8, 2023 • edited Loading

mohammadamint commented Nov 8, 2023 • edited Loading

Bachibouzouk commented Nov 8, 2023 • edited Loading

FLomb commented Nov 9, 2023

Bachibouzouk commented Nov 9, 2023

FLomb commented Nov 9, 2023

FLomb commented Dec 5, 2023

FLomb commented Dec 5, 2023

Bachibouzouk commented Dec 5, 2023

Bachibouzouk commented Dec 5, 2023

Bachibouzouk commented Nov 8, 2023 •

edited

Loading

mohammadamint commented Nov 8, 2023 •

edited

Loading

Bachibouzouk commented Nov 8, 2023 •

edited

Loading