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

Ubuntu/Debian: Document better how to use the deal.II package #11529

Closed
4 tasks
tamiko opened this issue Jan 14, 2021 · 14 comments
Closed
4 tasks

Ubuntu/Debian: Document better how to use the deal.II package #11529

tamiko opened this issue Jan 14, 2021 · 14 comments

Comments

@tamiko
Copy link
Member

tamiko commented Jan 14, 2021

Currently we do a somewhat mediocre job at clearly documenting how to install deal.II on Ubuntu/Debian via the package manager.

Todo:

$ sudo apt install libdeal.ii-dev libdeal.ii-doc cmake make g++
  • Document where to find the example steps
$ cp -r /usr/share/doc/libdeal.ii-doc/examples/step-1
$ cd step-1
$ cmake .
$ make run
@peterrum
Copy link
Member

peterrum commented May 1, 2021

This does not seem to be urgent. Postponing.

@peterrum peterrum modified the milestones: Release 9.4, Release 9.5 Apr 22, 2022
@Darth-Veidim
Copy link
Contributor

Hello there,

it seems to me that most of the tasks here have already been solved:

  • the installation procedures via backports and via PPA are already documented in wiki, aren't they?
  • required packages are listed on the README page.

I didn't find the realization of the last task, so I can add it. Should the instruction to find examples be found in the README.md?

@bangerth
Copy link
Member

I think what @tamiko had in mind for that last task is to explain where users would find the tutorial programs if the library was installed in /usr via a package manager. I don't actually know where the tutorial programs end up (maybe /usr/share?) but it would be useful to document that on the wiki page where the Debian/Ubuntu package is describe.

Any help will as always be gratefully accepted!

@Darth-Veidim
Copy link
Contributor

I wasn't able to fork dealii.wiki, so, I cloned it locally via ssh indicated at the end of the page. Then, after adding the discussed changes, I wasn't able to push without having permission to push directly to the repo. Then how can I contribute to the wiki?

@Darth-Veidim
Copy link
Contributor

I suggest making the following additions to the Debian_and_Ubuntu.md:


Installing the tutorial steps

To install the tutorial steps, proceed with an installation of a documentation library:

apt-get install libdeal.ii-doc

The tutorial steps are in the /usr/share/doc/libdeal.ii-doc directory. To copy a particular tutorial step into the current folder and run it, proceed with the following commands (for example, step-1):

$ cp -r /usr/share/doc/libdeal.ii-doc/examples/step-1 .
$ cd step-1
$ cmake .
$ make run

However, I would like to add the changes myself since I want to practice the contribution mechanics.

@tamiko
Copy link
Member Author

tamiko commented Jan 24, 2023

@Darth-Veidim Thanks a lot! Do you by chance have a link to your version of the wiki repository? I am happy to apply these changes directly.

We had to restrict wiki editing sometime earlier last year due to attempted malicious edits.

@Darth-Veidim
Copy link
Contributor

Hello @tamiko.
Do you mean that I need to push the updated wiki to my repositories first and then provide you with a link?

@tamiko
Copy link
Member Author

tamiko commented Jan 25, 2023

@Darth-Veidim Yup, if you don't mind, simply push the wiki repo to your github account and tell me the URL.

@Darth-Veidim
Copy link
Contributor

@tamiko, pushed the wiki here.

@Darth-Veidim
Copy link
Contributor

I would like to ask you, if there are other not complicated tasks that I can work on? I need more practice in contributing for my Simulation Software Engineering class.

@Rombur
Copy link
Member

Rombur commented Jan 26, 2023

You could run a spell checker on the code. I am sure there are typos.

@bangerth
Copy link
Member

@Darth-Veidim There is also this page https://dealii.org/participate.html and in particular its link to "Starter projects".

@Darth-Veidim
Copy link
Contributor

Thank you for your suggestions.

@tamiko, is everything alright with my repository?

@tamiko
Copy link
Member Author

tamiko commented Feb 1, 2023

@Darth-Veidim Looks good. I have added your commit.

@tamiko tamiko closed this as completed Jun 20, 2023
General Improvements (Starter Projects) automation moved this from To do to Done Jun 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

5 participants