档案

所有帖子于2018年4月

更新(2018 Jun 6) – I’m试图学习如何使用 狮身人面像 从源代码DocStrings创建文档。 Sphinx手册令人印象深刻的不透明。一些谷歌曲出现了 这个文件,这似乎提供了有用的细节。

更新(2018年6月4日)– I’找到了一些更新的新资源:

要设置我的包,所以它可以通过pip安装,我’在这里稍微过时的教程– //python-packaging.readthedocs.io/en/latest/index.html.

I’LL培养更多的注释并按照我的方式更新这篇文章。

作为我的系列中的第二个条目,了解如何 写科学软件, 一世’m将描述选择和配置我的集成开发环境或 ide.。这是我的程序’LL用于编写和编辑我的项目的源代码。它’s更加有意义的幻想文本编辑器。

我选择的文本编辑器是 vim.. or vi improved. It’S高度可定制,强大,和那里’s lots of 网上帮助 用它。但是,它有一个非常陡峭的学习曲线和命令,速度键入,可以是非常密码的。事实上,Vim是 着名的难以退出.

在任何情况下,我开始使用vim 回来时“加勒比海盗”电影仍然很好那我’不,我没有vim guru,至少觉得至少留下了这个程序。

开放A. Mac中的终端窗口,我只是通过打字来开火“vim” or “vi”。开启编辑器窗口。 vim.. can automagically interpret and color source code, 如下:

来自Vim的屏幕截图显示语法源代码。

要打开语法着色,请转到主目录(类型“cd”在终端窗口中,通过键入编辑VIM配置文件.vimrc“vi .vimrc”。应该打开编辑器窗口。

然后,在Vim中,键入字母“i” (that starts “insert” or edit mode,允许您在文件中输入文本)和类型“syntax on” <ENTER> “filetype indent插件上”,给出一个如下所示的文件:

按转义键(退出插入模式并进入命令模式)。通过键入保存更改“:wq”。应该保存和退出。

与许多其他语言不同, Python考虑了其解释的空格,而且 Python样式指南 建议使用 每个缩进级别的四个空间。对于在Vim中的间距,具有标签键实现将很好。 ynfortony,我的vim默认情况下,为每个按下标签键插入八个空格。

但是您可以通过添加修改该行为 文件类型插件 文件到特殊的Vim配置文件夹。我按照说明 这里 在.vim目录中创建一个ftplugin目录(通过键入“cd && cd .vim && mkdir ftplugin && cd ftplugin”在终端窗口中)。然后,在目录内,我创建了python.vim(“vi python.vim”) and again pressed “i”进入插入模式。

我将以下行键入文件:

然后按转义键并键入“:wq”.

接下来,我通过键入测试新配置“vi test.py” (the “.py”很重要,因为那’vim知道您正在编辑Python文件并希望使用新的Python配置)。我按下标签,有四个空格而不是八个空间。

I’M确定还有其他配置设置是有用的,但是这个’ll do for now.

更新–2018年5月17日:我找到了这个优秀的网站– http://docs.python-guide.org/en/latest/,哪个地址 vim.. set-up以及许多其他问题。

古代软件开发人员在纸卡上精心打孔 写计划.

在我的毕业生事业之前,科学家很少,如果有史以来,如果有人公开分发他们的代码,就是为了掌握他们的编码项目。

但正如我完成博士的那样,科学家们正常见,使他们开发的代码是在互联网上随时可用的发布项目的一部分。但是,在线代码后的方法(至少 那些我知道的人)非常笨重。

如今,在线发布和共享代码的基础设施是强大的,成熟的,并且使用相对容易。因此,科学家正在创造 美好的代码存储库以及可访问的文档。

开放式代码变得越来越重要:因为代码变得更加复杂并且有能力,易于提供良好文档的代码对于支持至关重要 再现性是科学过程的基石。此外,联邦资助机构是 开始要求 调查人员将公开的代码和数据产品进行公开。

不幸的是,由于我是在这些存储库很常见之前的最后一代毕业生之一,我从未真正学习如何正确分发和文档代码。

因此,作为改善我的科学产出的持续努力的一部分(以及作为我未来的学生的助手),我’M将开始一系列半常规博客文章,描述了我学习如何编写,文档和科学代码的过程。

几个警告前期:

  • 我打算大多数(可能是专门)在Python中写下代码,它已经成为(至少在天文学)的语言中的语言,所以并非所有我写的都会是普遍相关的。
  • 我被迎来了 崇拜Mac. 很多年前,所以我写的不是所有的东西都与其他操作系统相关’s。虽然,我’缺点发现大多数天文学家使用Mac。
  • 这个博客系列绝不是全面或严谨的。一世’M只是计划描述我在我走的时候学习的内容,以及我什么时候能够奉献的时间几乎完全不够解释与项目相交的所有细节,细微差别或技术方面。

至于我打算写的实际科学代码,几年前我的同事和我写道 一篇论文 关于 椭圆形变异 巨大的外产上的肿瘤诱导非常接近他们的宿主恒星。附上的代码, 邪恶的 是写的 idl.,旧语言仍然广泛用于天文学,但需要购买昂贵的网站许可证。

我的计划是将该IDL代码转换为未来几周的Python包。

邪恶的–低质量伴侣诱导的椭圆型变化


由行星(白色/黑盘)绕过星形(橙黄盘)的潮汐扭曲(夸张)。下面的曲线显示了由于潮汐失真导致的恒星的亮度变化。