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

Documentation update for installation and environments in miniconda #142

Merged
merged 4 commits into from
Nov 1, 2018
Merged

Documentation update for installation and environments in miniconda #142

merged 4 commits into from
Nov 1, 2018

Conversation

jbteves
Copy link
Collaborator

@jbteves jbteves commented Oct 17, 2018

Closes #140.

Changes proposed in this pull request:

  • Create documentation on creating miniconda environment
  • Update dependencies with links

Added notes for creating a conda environment for use with tedana
Added links to dependencies
@emdupre
Copy link
Member

emdupre commented Oct 17, 2018

Thanks so much @jbteves ! We're not merging PRs right now (circle builds are failing, as you can see), but we'll hopefully get this in soon.

Copy link
Member

@emdupre emdupre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much again, @jbteves ! I have one small request for formatting the updated text, but then I'm excited to see this merged ! Thanks for the contribution 👍

README.md Outdated

You can then install `tedana` with

```
pip install tedana
```

### Creating a miniconda environment for use with tedana
In order to use tedana, you can configure a miniconda environment for your user profile in Mac and Linux systems. (Systems administrators: note that global installation of miniconda in /usr/local/ may cause some trouble for individual users; user installations are recommended; pip installation will require root privileges otherwise. Some users may need you to adjust their home directory permissions during a miniconda install). This also makes it straightforward to install nibabel and nilearn. You can use [miniconda3](https://conda.io/miniconda.html). Then, use the following commands to create the environment:
Copy link
Member

@emdupre emdupre Oct 31, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any way you could put each sentence on a new line ? This would make it easier to see any edits to the text in the future !

@KirstieJane KirstieJane added this to the documentation milestone Oct 31, 2018
@KirstieJane KirstieJane added the documentation issues related to improving documentation for the project label Oct 31, 2018
@codecov
Copy link

codecov bot commented Oct 31, 2018

Codecov Report

Merging #142 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #142   +/-   ##
=======================================
  Coverage   48.67%   48.67%           
=======================================
  Files          32       32           
  Lines        2077     2077           
=======================================
  Hits         1011     1011           
  Misses       1066     1066

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 42b5bad...0cb003e. Read the comment docs.

@emdupre
Copy link
Member

emdupre commented Nov 1, 2018

Ok, I've gone ahead and updated the line lengths and modified the text slightly. Thanks again for the contribution, @jbteves !

@emdupre emdupre merged commit dd034a5 into ME-ICA:master Nov 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation issues related to improving documentation for the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants