Skip to content
Snippets Groups Projects
Commit 11e8175c authored by Aaron Spring's avatar Aaron Spring
Browse files

add guide managing papers and IDE workflow

parent fc7f5763
No related branches found
No related tags found
No related merge requests found
MIT License
Copyright (c) 2018 Julius Busecke
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
# guides
A collection of guides for `mistral` specific setups. Adapted from https://github.com/jbusecke/guides.
# Advanced project workflow with JupyterLab and Atom
## Enabeling remote editing with Atom
[Atom](atom.io) offers a lot of useful packages that make it (as of now) a far better tool to write clean code compared to jupyterlabs editor. In order to edit files on remote directories, we will mount them locally using `sshfs` [DKRZ explanation](https://www.dkrz.de/up/help/faq/mistral/how-to-use-sshfs-to-mount-remote-lustre-filesystem-over-ssh).
For Mac users, install [homebrew](https://brew.sh/), before installing `sshfs`.
```
$ brew install sshfs
```
This might require [`macfuse`](https://osxfuse.github.io/).
Now create a folder for your mounted drives (here we will use the homefolder)
```
$ mkdir -p ~/mistral_home
```
and mount your project directory with
```
$ sshfs m300524@mistralpp.dkrz.de:/work/ ~/mistral_home
```
I set this as an `alias` in my `~/.bash_profile`:
```
alias sshfs_home="sshfs m300524@mistralpp.dkrz.de:/work/ mistral_home -o auto_cache,reconnect,defer_permissions,noappledouble"
```
Now you can navigate to that folder as usual and start atom with `atom .`.
If you need to unmount use
```
$ umount -f ~/mistral_home
```
## Recommended atom packages
- [atom-beautify](https://atom.io/packages/atom-beautify): automatic code cleaner
- [hydrogen](https://atom.io/packages/hydropgen): jupyter inside scripts
- [teletype](https://atom.io/packages/teletype): remote peer programming
- [kite](https://atom.io/packages/kite): autocomplete, privacy dubious
- [minimap](https://atom.io/packages/minimap): sidebar of your location in code
- [linter-flake8](https://atom.io/packages/linter-flake8): automatic linting for python
- ... many more, checkout: https://atom.io/packages
# Managing papers you are working with
- Do you read many papers, but have trouble finding your copy in that large stack of paper printouts after a year?
- If you finally found it, do you often gaze at a printout without notes?
- Or when you just quickly found to find that one sentence in a paper, you do not find it because your comments are only in the hard copy?
- Do you often switch between reading papers from printouts and your computer?
## My solution: iPad + PDF Expert + sharecloud ( + zotero)
I solved these issues for myself by annotation the papers I read digitally. Either directly on the computer with the mouse, or with the Apple pencil when reading on my iPad. I store all papers in a [`owncloud`](https://info.gwdg.de/dokuwiki/doku.php?id=de:services:storage_services:own_cloud:start) (MPG accounts have 50GB free) and use [PDF Expert](https://readdle.com/) for iPad annotations. PDF Expert accesses the `.pdf` files via `webdav` from `owncloud`. PDF Expert costs 10 Euro. If you found a well-working free and open-source solution, please send me an email.
On my local laptop I use `zotero` to manage papers. Many browsers have a [plugin](https://www.zotero.org/support/adding_items_to_zotero) to store a paper to `zotero` and save the `.pdf` to the owncloud synced folder with one click.
## Work flow
This workflow enables me to integrate papers quickly into my library of papers in `zotero`, work on them with comments, annotations and drawings with a pen and access all these papers any time with my iPad and laptop.
\ No newline at end of file
# Reading papers
- Do you read many papers, but have trouble finding your copy in that large stack of paper printouts after a year?
- If you finally found it, do you often gaze at a printout without notes?
- Or when you just quickly found to find that one sentence in a paper, you do not find it because your comments are only in the hard copy?
- Do you often switch between reading papers from printouts and your computer?
## My solution: iPad + PDF Expert + sharecloud ( + zotero)
I solved these issues for myself by annotation the papers I read digitally. Either directly on the computer with the mouse, or with the Apple pencil when reading on my iPad. I store all papers in a `sharecloud` (MPG accounts have 50GB free) and use PDF Expert from https://readdle.com/ for iPad annotations. PDF Expert accesses the `.pdf` files via `webdav` from `sharecloud`.
On my local laptop I use zotero to manage papers. plugin to store directly with one click from browser.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment