StarCharter 项目教程
1. 项目的目录结构及介绍
StarCharter 项目的目录结构如下:
star-charter/
├── data/
├── example_output/
├── examples/
├── src/
├── .gitignore
├── CMakeLists.txt
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── dataFetch.py
├── docker-compose.yml
├── prettymake
└── setup.sh
目录介绍
- data/: 存放项目所需的数据文件,包括星表、深空天体目录等。
- example_output/: 存放生成的示例图表输出文件。
- examples/: 存放示例配置文件和脚本。
- src/: 存放项目的源代码文件。
- .gitignore: Git 忽略文件配置。
- CMakeLists.txt: CMake 构建配置文件。
- Dockerfile: Docker 容器构建配置文件。
- LICENSE: 项目许可证文件。
- Makefile: 项目的 Makefile 文件,用于构建项目。
- README.md: 项目说明文档。
- dataFetch.py: 用于下载项目所需数据的 Python 脚本。
- docker-compose.yml: Docker Compose 配置文件,用于管理 Docker 容器。
- prettymake: 一个辅助脚本,用于美化 Makefile 输出。
- setup.sh: 项目的安装和构建脚本。
2. 项目的启动文件介绍
StarCharter 项目的启动文件是 setup.sh
。这个脚本负责下载项目所需的数据文件并编译软件。以下是 setup.sh
的主要功能:
- 下载数据文件: 脚本会从互联网下载 DE430 太阳系星历表、星表、深空天体目录以及银河系图像等数据文件。
- 编译软件: 脚本会编译 StarCharter 的源代码,生成可执行文件。
使用方法
./setup.sh
3. 项目的配置文件介绍
StarCharter 的配置文件用于指定生成星图的参数。配置文件的格式为 <option_name>=<option_value>
。以下是一些常用的配置选项:
常用配置选项
- ra_central: 星图中心的赤经(度)。
- dec_central: 星图中心的赤纬(度)。
- angular_width: 星图的角宽度(度)。
- mag_min: 显示的最小星等。
- width: 星图的宽度(单位:厘米)。
- aspect: 星图的宽高比。
- show_grid_lines: 是否显示网格线(0 或 1)。
- constellation_boundaries: 是否显示星座边界(0 或 1)。
- star_names: 是否显示星星的名称(0 或 1)。
- output_filename: 输出文件的名称。
示例配置文件
以下是一个示例配置文件的内容:
DEFAULTS
ra_central=5.5
dec_central=4.0
angular_width=29.0
mag_min=7
width=15.0
aspect=1.41421356
show_grid_lines=1
constellation_boundaries=1
constellation_sticks=1
coords=ra_dec
projection=stereographic
star_names=1
star_flamsteed_labels=0
constellation_names=1
plot_galaxy_map=1
plot_equator=0
plot_ecliptic=0
plot_galactic_plane=1
font_size=1.2
CHART
output_filename=output/orion.png
CHART
output_filename=output/orion.svg
CHART
output_filename=output/orion.pdf
这个配置文件定义了生成猎户座星座图的参数,并指定了输出的文件格式为 PNG、SVG 和 PDF。