Coding and the Interwebs

If there is one thing you should know about learning to code, it is that the internet is your friend. Learning how to find what you need on the internet is an important skill to learn. A lot of the skill comes with time, but there are a few things that can get you going.

  1. Someone has had the same problem you are having. There is an answer.
  2. Stack Overflow and Stack Exchange are miracles of the internet. Don't worry which is which unless you want to
  3. Occam's Razor - Try the simplest solution first, but avoid hackey solutions.

How to ask a good question*


A good format to follow for asking Google a question is

language what you want to do

Say I am working on some C++ code, and I want to read in columns from a file. Suppose these have multiple data types, some are strings while others are integers. Example:
    Alice  1  10  1e3
    Bob    2  12  2e3

I would ask C++ how do I read in columns with multiple data types from a file. While this is doable, a Google search shows it's a rather difficult topic. The best solution I could find was cplusplus.com, which is a well known site, but if you read the thread it ends without any clear solution.

Pressing on


I could give up, but instead I simplify my search to c++ read in columns from a file. I get a result from StackOverflow and from cplusplus. The cplusplus result is only for 2 columns but it looks useful. The stack overflow result is much better. Not only is it reading multiple columns, each column has a different data type. Looking carefully, one sees that the second part of the answer replaces the ellipsis (...) in the first part.



Also note the arrows and the checkmark. On the Stack websites, when an answer is accepted it means it was the right answer for the question asker. The number indicates how many upvotes an answer got. More upvotes is generally a better answer, though sometimes a less great answer is fine for what you need.

The key now is to examine the answer and learn what you can from it. Learn what the functions they use are. If there is a link, follow it and read the documentation. If you are using C not C++, check to see if it works in C by running a short piece of code to check. If it doesn't work, don't start over, search for equivalencies in other languages.

When all else fails


Sometimes the answer isn't out there, or is just really hard to find. When this happens check other languages. Sometimes the easiest thing is to just find a work-around. Most programming languages have a way to make system calls and pipe the output back into your code. Take advantage of these.

Good sites and useful things


Some good places to find information are:

  • Stack Exchange
  • Stack Overflow
  • cplusplus.com
  • GitHub
  • Documentation for the language.

Hints that can make life easier:


  • On osx/unix/linux the terminal is a powerful tool. Take advantage of bash/csh. OSX's terminal defaults to bash. Check with echo $SHELL
  • astropy.io.ascii is great at reading in data
  • numpy.loadtxt allows you to simply read in numerical data, you can even select which columns
  • Pandas is huge in the python community. I don't know it, but it's popular
  • Mathematica is amazing in its versatility. It can parse data and do crazy stuff. More in a later post.
  • Comment your code.
  • If you write a useful function. Copy it to its own file so you can load it in other programs.
  • Write reusable code. Keep your programming as general as possible.

This is what I can think of for now...



*I didn't cheat, I actually did the search myself, which is why the first question fails

Comments

Post a Comment

Popular posts from this blog

A Quick Look at Spherical Coordinates

Image
Because astronomy works on the Celestial Sphere, spherical coordinates play a very important role in astronomy. Most of the time we can ignore the intricacies of physics in 3-dimensions and work in a 2D far-field regime. (The far-field regime is just fancy speak for "small-angles"). However, it can be useful to understand why spherical coordinates are they way they are. Here, we will quickly derive the spherical differential volume element. Differential, just means vanishingly small. To let the cat out of the bag, the spherical differential volume element is, \[ dV = r^2 \sin{\theta}\, dr\, d\theta \, d\phi .\] The figure above shows the coordinate system we will be working with. This form is commonly used in astronomy, and also in some physics. However, it is different from the way mathematicians define it. In mathematics the \(\theta\) and the \(\phi\) are often switched. The astronomy convention is the more commonly used one in physics and astronomy (sorry mathematica
Keep reading

On the use of Scaling Relations in Astronomy

Scaling Relations In astronomy, indeed in science, there is a dizzying array of constants, equations, and units that all need to be kept straight if we want physics to work. While it is good to know Kepler's 3rd Law for a planetary system, \[ P^2 = \frac{4 \pi^2 a^3}{G\,M_\star} \] we can also use Kepler's original form, which was a scaling relationship, \[ P^2 \sim a^3 .\] The scaling form of Kepler's law works because it is specifically for the solar system in solar system units. It says that for a planet orbiting the sun we know that \(P^2\) scales with \(a^3\). Scaling must always be done with respect to something we know or by using ratios we know. e.g. If we know two objects have some intrinsic size ratio (say two hard spheres), we can determine their relative distance by checking their observed sizes. Notice that in the scaling version of Kepler's 3rd law the various physical/mathematical constants are no longer present. Both sides of the equation are dim
Read more