Atom Tutorial

[eak24]

Please add a comment below about what you would like to be able to do with Atom. If you come from another text editor like Sublime, add a comment about something you miss about Sublime. If there's something you learned how to do on Atom you think others might find useful, add a comment about that!

[nataliemottl]

Will team members need github desktop?

[nataliemottl]

Can we add a section detailing how team members can collaborate on the same document?

[nataliemottl]

I tried to follow the instructions to download atom and I got a couple of errors related to not syncing with github. I couldn't figure out how to resolve them. From there I was not able to sync to the AguaClara thing from Step 3. I got multiple errors after I typed in the Gist ID. Photos might help understanding and help troubleshooting. Overall to get to this point, it took about 20 minutes including download time.

[eak24]

@nlm42 here are the answers to your Qs! Someone could add info on these in the new tutorial.

Team members do not need GH desktop - Atom has a version built in. Please include in the updated tutorial.

Team members can use teletype, an addin that is installed when they use sync-settings to sync to the AguaClara settings. Here's how to use it

Pretty short amount of time to almost get it working! I think you need to reinstall anaconda and be sure to check the add to path option. Also, you need to generate a personal token on github for the sync settings to work. My guess is that your token didn't enable your atom to create Gists. You need to check that box during this step (under setup, #2). Make sure you have the personal token entered in atom and after that try forking the Gist ID. Let me know if that doesn't work.

Thanks for helping out with this!

[eak24]

My recommendation is to make a github repo called aguaclara_tutorial. This can include all the things that normally go in the wiki - we should be moving away from the wiki because GitHub already has a mechanism for exposing a public website. Within the aguaclara_tutorial wiki, copy the Atom tutorial I wrote and change as needed.

The key step to using Anaconda with Atom (just tested on my windows from the ground up) is selecting to ADD PYTHON TO YOUR PATH during the anaconda installation! This means a reinstall for everyone who already has anaconda. Adding python to your path enables your system (and atom) to find your python installation.

The reason we should use anaconda is that it comes with a bunch of the packages that we use for aide_design, and a well-supported package manager (conda). Installation would be far more complicated is we decided to use the default system python.

Inline image 1

One thing I did notice during installation on a fresh computer was that I had to open the atom cmd pallet (cntrl-shift-p) and type Hydrogen: Start Local Kernel and then hit Python 3 in the resulting dropdown to get the kernel going. Also, note that if you use regular jupyter notebooks while using atom with hydrogen, it will steal the kernel from hydrogen and you'd have to restart atom to get the kernel again (after having quit the cmd running jupyter notebooks.) This may make things tricky for Juan - he should just use the online representation of the notebooks on github so he doesn't have to actually start the notebook.

During this transition, there will be frustrations. Running Atom is a bit complicated. Please let me know of any of these challenges as they arrive through an issue (you can mention me with @ethan92429) - these are usually ways to overcome these, whatever they may be! Let's aim for some stellar documentation!

[kevinjuan25]

@ethan92429 I was attempting to do what you said in your previous comment on my Mac, and the option to add Python to PATH didn't show up. I continued with the installation as normal, and found that it was possible to retroactively add Anaconda Python. Here's the link I found on stack overflow. Perhaps this might be a work around for people who might run into a similar issue? Let me know

[eak24]

@kj89 I'm hesitant to include this just because tinkering with the init file can get confusing quick. I have a mac and PC, and every time I have installed anaconda (at least 10 times) I have seen the add to path option during the installation process. See here:

Is it possible you clicked passed it by accident?

[kevinjuan25]

@ethan92429 So I did run the installation, and checked to see what modifications I could make. The attached image shows exactly what I was allowed to customize when installing Anaconda3 and Anaconda2. From what I can tell, the modify PATH is what needs to be checked off, and this seems to be selected by default. I'm thinking that the issue arises due to the fact that Atom was installed after Anaconda hence your reasoning to need a reinstall. Still, I did the modification to the init file and things are running fine for me.

[kevinjuan25]

@ethan92429 I'm trying to run an install on my Windows PC for the installation tutorial, and I'm running into issues where sync settings isn't installing the packages from the Gist. Do you have experience doing the installation on two machines? I'm not sure what's going on.

[eak24]

@kevinjuan25 List some errors that you are getting. I've successfully installed Atom with this method on PC and mac. Have you tried restarting ATom? Sometimes it takes a restart.

[kevinjuan25]

@ethan92429 I'll try again, the packages weren't installing, so it should be a simple fix.

[ashleyhe16]

@ethan92429 Is it alright to work on the master branch from atom? It doesn't appear that you can clone other branches from github looking at this stack overflow question... any suggestions?

[kevinjuan25]

@ach238 You can get other branches to your local drive to work on them through Atom using command shell/terminal

[ashleyhe16]

@kevinjuan25 got it, thanks!