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

update installation documentation for tardis #2460

Merged
merged 5 commits into from
Feb 9, 2024

Conversation

erinvisser
Copy link
Contributor

@erinvisser erinvisser commented Nov 1, 2023

Removed conda forge for non-developers, switched order of developers and non-developers

Fixes #1591 #1924

📝 Description

Type: 📝 documentation

@tardis-bot
Copy link
Contributor

tardis-bot commented Nov 1, 2023

*beep* *bop*

Hi, human.

The docs workflow has failed

Click here to see the build log.

@tardis-bot
Copy link
Contributor

*beep* *bop*

Hi, human.

I'm the @tardis-bot and couldn't find your records in my database. I think we don't know each other, or you changed your credentials recently.

Please add your name and email to .mailmap in your current branch and push the changes to this pull request.

In case you need to map an existing alias, follow this example.

1 similar comment
@tardis-bot
Copy link
Contributor

*beep* *bop*

Hi, human.

I'm the @tardis-bot and couldn't find your records in my database. I think we don't know each other, or you changed your credentials recently.

Please add your name and email to .mailmap in your current branch and push the changes to this pull request.

In case you need to map an existing alias, follow this example.

…for non-developers and switching order of developers and non-developers
adding Erin's info to mailmap
Copy link

codecov bot commented Nov 1, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (33bea12) 67.23% compared to head (0cba48e) 68.74%.
Report is 26 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2460      +/-   ##
==========================================
+ Coverage   67.23%   68.74%   +1.50%     
==========================================
  Files         155      165      +10     
  Lines       13729    13999     +270     
==========================================
+ Hits         9231     9623     +392     
+ Misses       4498     4376     -122     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


$ pip install git+https://github.com/tardis-sn/tardis.git@release-{yyyy.mm.dd}

Please fill in the year, month, and date of the released version you want to use.
Copy link
Contributor

@DeerWhale DeerWhale Feb 8, 2024

Choose a reason for hiding this comment

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

Suggested change
Please fill in the year, month, and date of the released version you want to use.
Please fill in the year, month, and date of the `released version <https://github.com/tardis-sn/tardis/releases>` you want to use.


::

$ pip install git+https://github.com/tardis-sn/tardis.git@master

4. Once finished working, you can deactivate your environment.

Copy link
Contributor

Choose a reason for hiding this comment

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

Please add "$ wget -q https://github.com/tardis-sn/tardis/releases/latest/download/conda-{platform}-64.lock" in line 110 with the same indentation with the line below that "$ conda update xxx"

@erinvisser erinvisser force-pushed the update_documentation branch from 5d04dcd to 86f227f Compare February 9, 2024 16:57
@andrewfullard andrewfullard merged commit 38a8141 into tardis-sn:master Feb 9, 2024
10 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Installation Instructions on the Documentation are Outdated
6 participants