APSIMX vs APSIM Next Generation

[hut104]

Early prototypes of the new APSIM code base used the name APSIMX. At a later stage, the official name was changed to APSIM Next Generation. However, the term APSIMX still occurs everywhere through our systems. The term occurs in places such as our Repo name "APSIMInitiative/ApsimX" Web addresses "https://apsimdev.apsim.info/ApsimX/Releases/2020.02.05.4679/SoilWater.description.pdf" Exceptions "throw new ApsimXException" The file extension ".apsimx" looks like part of this issue, but really reflects an unrelated problem in that this extention was to signify and apsim file in xml format (like a spreadsheet in xml format is .xlsx) Should we clean some of this up, at least where it is simple and easy to do so. I understand that some cases may be too late to change easily. However, I still hear people referring to NG as APSIMX and it will be hard to stop if we do the same thing ourselves.

[sarahcleary]

This question was discussed in the RP meeting. ACTION: @APSIMInitiative to seek feedback on implications on renaming (1) the repository from APSIMX to APSIMNG and the file extension to .apsimng. @hol430; @hol353 - others - any ideas?

[peter-devoil]

They say it is easy to rename a repo, and indicate that old scripts that use the old url will be redirected to the new one.

[sarahcleary]

@peter-devoil; @HamishBrownPFR - are you happy with proceeding with renaming the repository? and subsequently, the file extension?

[sarahcleary]

@peter-devoil; @HamishBrownPFR - next step/s?

[peter-devoil]

Wait for a "quiet time", and ask @hol430 to implement it. I expect that most users will be unaffected, but whether the jenkins scripts will handle the redirects is unknown right now.

[hol430]

Yes, I can look into this at some point. I think renaming the repository shouldn't be a big deal, the github docs you linked earlier say that there will be a redirect in place. We'll still want to update the jenkins scripts and other web services of course.

Changing the file extension sounds like a great way to confuse people but should be easy enough to implement (my favourite sort of change).

[hol353]

I agree with @hol430 - changing the file extension will confuse users. How will they know whether a file is for APSIM 7.10 or APSIM Next Gen?

[hut104]

Perhaps having the current extension implying XML is similarly unhelpful. Do we just be explicit and use *.apsimng or similar?

[hol353]

Yep that would work.

[peter-devoil]

What's wrong with .apsim?

[hut104]

As raised above, that extension is already used for classic.

[lie112]

What about allowing apsimx, apsimng to be loaded from the open simulation box for now. The user will be presented with an error if the file format is not suitable. From now on application saves and expects all simulations as apsimng. This will allow user transition. Maybe the previously opened list could contain apsimx files until an apsimng file is saved and then the apsimx is removed from previously opened list and deleted from HDD. This would be a similar approach to the rollout of json version of apsimx files. There wouldn't be any confusion with APSIM classic.

[hol353]

So if we're not changing the file extension then the last remaining job is to rename the repo. This will mean that everyone will have to update their git client software to point to the new URL. Anything that links to https://github.com/APSIMInitiative/ApsimX will no longer work.

We could rename it to ApsimNG or APSIMNextGeneration or ApsimNext.

Are you sure you want to do this?

[peter-devoil]

If your software handles redirects, there shouldn't be a problem. That includes git, tortoisegit, wget etc

Test in a sandbox to be sure?

[hut104]

I didn't know we weren't changing the extension.

[sarahcleary]

Sorry, finalizing the notes from the last RP meeting. Draft notes: @APSIMInitiative/reference-panel agreed that although renaming the extension from .apsimx to .apsimng would help with communication, it may cause some errors/issues which will require fixing. At this stage, agreed for the extension to stay as .apsimx and utilise the NG in ALL other communication. Agreed to look at renaming the Repository for communication purposes.

[sarahcleary]

@hol353; @peter-devoil - next step/s?

[peter-devoil]

Wait for a "quiet time"...

[stale[bot]]

This issue has been automatically marked as stale because it has not had any activity in the last 30 days. It will be closed in one week if no further activity occurs. Thank you for your contributions.