Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs #47

Closed
wants to merge 5 commits into from
Closed

Docs #47

wants to merge 5 commits into from

Conversation

willrogers
Copy link
Contributor

Minor updates to the documentation. Added README for writing integrators, although it definitely needs to be improved.

Add atpath to atmexall so that it doesn't fail on missing paths.

@lfarv
Copy link
Contributor

lfarv commented Mar 28, 2018

I do not think atpathshould be put in atmexall. Of course it will ensure atmexall runs, but it does not ensure AT will work (after restarting Matlab)! While it is quite obvious for a Matlab user that any installed file should be put in the Matlab path, one could add explicitly in the INSTALL document that atmat and atintegratorsshould be put (with all their subfoldfers) in the path. This is enough for atmexall to run.

@lfarv
Copy link
Contributor

lfarv commented Mar 28, 2018

Additionally the 'cd atmat' command in the INSTALL document is useless and potentially dangerous: it could allow atmexall to run even if atmat is not in the path, which indicates a wrong installation. Step 4 should be instead 'add recursively atmat and atintegrators to the Matlab path'
@willrogers : I cannot intervene in your branch to modify INSTALL myself (not in atcollab), so I let you do it !

@willrogers
Copy link
Contributor Author

Thanks for the comments. I am not sure I understand.

I understood that atpath was the command you run in order to 'load' AT - that is, it does the same thing as 'add recursively atmat and atintegrators to the Matlab path'. Is that not true?

I don't mind what the correct procedure is, I just think we should get the documentation saying the right thing so that a new user can get started with no problems.

@willrogers
Copy link
Contributor Author

I pushed the docs branch to the atcollab at.

@lfarv
Copy link
Contributor

lfarv commented Mar 30, 2018

@willrogers : You are right, atpath does the right thing to put AT on the Matlab path, but this will be lost when you close Matlab. And you do not want to call atpath each time you start Matlab (since it's itself not in the path…). So the user should put permanently AT in his path, which is the standard thing to do with any Matlab package. There are different ways to do that: the easiest is to use the GUI ( "Set path" in the command bar), other users like to build explicitly their path in their startup.m file… I'll propose a sentence in the INSTALL file for you to check !

@willrogers
Copy link
Contributor Author

Could we merge these changes? I have a student who is beginning to work on pyAT and a Python middle layer application, and I would like to be able to improve the documentation.

None of these things are final, they can always be improved.

@T-Nicholls T-Nicholls mentioned this pull request Oct 25, 2018
@willrogers
Copy link
Contributor Author

Close in favour of #78

@willrogers willrogers closed this Oct 29, 2018
@willrogers willrogers deleted the docs branch October 29, 2018 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants