-
Notifications
You must be signed in to change notification settings - Fork 41
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
add post about isolated environments #47
Conversation
@MDAnalysis/coredevs Anyone using virtual envs? |
On 03/27/2017 11:00 PM, Max Linke wrote:
@MDAnalysis/coredevs
<https://github.com/orgs/MDAnalysis/teams/coredevs> Anyone using
virtual envs?
—
You are receiving this because you are on a team that was mentioned.
Reply to this email directly, view it on GitHub
<#47 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/ABUWuukCsBxODqwmvfszaV8CAtGfCZ-Kks5rqCN-gaJpZM4MpMZf>.
I do. I'll have a look at soon as I find some time. I am quite busy at
the moment, though.
|
_posts/2017-11-11-environments.md
Outdated
More information about conda environments can be found in | ||
the [official documentation](). | ||
|
||
# Python Virtual Environments |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can't we just leave it at conda environments?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could. I thought it might be nice though for people who don't use conda yet. Most scientists I know go with never change a running system
and are rather slow to change to anything new.
_posts/2017-11-11-environments.md
Outdated
|
||
Virtual environments will only work for python packages. | ||
|
||
# Automatically Change Environment Based On Folder |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sounds a bit hacky and weird and probably a bad idea?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are some packages for bash and zsh that do that. I wanted to look for them again. If I don't find them I'll remove it again
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we don't currently use them, it's probably a bad idea to advocate that people use them. I'd rather we stuck to recommending things that we know work.
I'd generally echo @richardjgowers advice
You could have a See Also section at the end with links to other approaches and tools. But I would keep the main post straight and to the point. |
@orbeckst can you have a look over it. I added a small paragraph for virtual environments now. |
I'll extend on the virtual envs later today. I will especially add a word on virtualenvwrapper. I may also add a word on how to load a given version of gromacs with a virtual env. |
Thanks. I forgot about the wrapper package. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally good, nothing major. See inline for suggestions.
_posts/2017-11-11-environments.md
Outdated
title: Managing software versioning using Conda environments | ||
--- | ||
|
||
Research projects can often take months to years to complete, however the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
, however --> but
_posts/2017-11-11-environments.md
Outdated
this. These new versions of software will often include new features which | ||
might be of great use, but they might also introduce changes which break | ||
your existing work and introduce compatibility issues with other pieces | ||
of software. So whilst for existing projects we might wish to freeze |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe tie this to the upcoming 0.16.0 – otherwise it's not really clear why this appears in the MDAnalysis blog.
_posts/2017-11-11-environments.md
Outdated
use the most up-to-date versions, leaving us needing to install multiple | ||
versions of multiple different pieces of software. | ||
|
||
In this post we will try to explain how conda and Python virtual environments |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Highlight (and omit 'try'):
In this post we will explain how conda and Python virtual environments can be
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or even better: make these links to the sections below. With the new AnchorJS extension all headings will get anchors so you just have to run locally to find the anchor name and put in a link, something like
[conda](#conda-environments)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not clear from here if one should use either conda or virtualenvs or both.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK I added the link to the descriptions.
_posts/2017-11-11-environments.md
Outdated
{% endhighlight %} | ||
|
||
For each research project, it is advised that you create a new environment so that | ||
the software used in each project does interfere across different projects. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does not interfere
(omission of the crucial word "not")
_posts/2017-11-11-environments.md
Outdated
versions. | ||
|
||
In this guide we will concentrate only on creating and managing environments | ||
with conda. For more information on general installation of package please refer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For more information on installing packages please ...
_posts/2017-11-11-environments.md
Outdated
scientific applications. It is mostly used for Python packages but the system | ||
can be used with any programs. The [conda-forge](https://conda-forge.github.io/) | ||
community also provides a large collection of scientific software for Python, R | ||
and perl. Conda should be your first choice to manage different software |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't like the "Conda should be your first choice". It seems very paternalistic. Rather something like "Conda has shown itself to be an excellent tool to manage different software versions." or "Conda is now widely used to manage different software versions." Let your readers decide for themselves if they want to use it.
Ok I addressed @orbeckst 's comments, all that is left is for the virtualenv to be written to a similar spec to conda. |
Anything else that should be done for this post? |
If we want to release on the weekend. Everyone OK if this goes live in the evening? I would still have to change the filename for the post date. |
On 04/07/2017 05:04 PM, Max Linke wrote:
If we want to release on the weekend. Everyone OK if this goes live in
the evening? I would still have to change the filename for the post date.
—
You are receiving this because you are on a team that was mentioned.
Reply to this email directly, view it on GitHub
<#47 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/ABUWuppkTPWIhpb2WB4avzFjkf8UPfM1ks5rtlCWgaJpZM4MpMZf>.
I am all for it.
|
To complicated for our purpose
OK this now ok to go. I changed the date |
@kain88-de all merged (and added missing Do you want to do a tweet that links to the blog post? |
Sure I can try a first tweet. |
Since the new release might break some existing scripts for users I though it was a good idea to write a post about managing different software versions. This doesn't just touch python packages anymore though.
I would appreciate some help with the virtual env because I haven't used them in ages.