The Final Frontier: Documentation and Usability

 As the project nears completion, I’m focusing on what is arguably one of the most critical phases: documentation. A tool is only as good as its documentation, and my goal is to ensure that another developer or researcher can get up and running with RIPPLe with minimal friction.

I’ve been writing a comprehensive README, adding detailed docstrings to all major classes and functions, and creating a series of Jupyter Notebook tutorials that walk through common use cases (thinking of postponing notebook tutorials for later, though). It’s meticulous work, but it’s essential for the long-term success and adoption of the project within the DeepLense and wider LSST communities.

Comments

Post a Comment

Popular posts from this blog

Damn couldn't believe I got in again.

I was glued to reddit and the website the whole time for 4 hours. The results came out later than UTC 18:00 and didn't get the mail until four hours beyond the scheduled time.  None of my friends got in, so was kinda anticipating a rejection too, but to my surprise I got in. I am really excited to go through this journey again. It would be amazing. 
Read more

Proposal Sent! The Waiting Game Begins...

 Drafted, revised, got feedback (mentally, from myself mostly haha), polished, and finally hit submit on the proposal! It feels pretty comprehensive, outlined the pipeline modules, the timeline, potential hurdles... Pouring all that learning from the courses and the tests into it felt good. Now... we wait. Fingers, toes, everything crossed! Whatever happens, learned a ton already.
Read more

Proposal Mode: Activated

 Okay, tests done, now the real writing begins. The proposal. Need to show I understand LSST, DeepLense, the project goals, AND have a solid plan. Drafting sections on objectives, methodology, the timeline... This is where the deep dive into the LSST pipeline docs and the project description really matters. 
Read more