Skip to content

Real Scanning, Real Science, at Warp Speed!

Notifications You must be signed in to change notification settings

peterclemenko/SCANsat

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

SCANsat: Real Scanning, Real Science, Warp Speed!

scan your planetoid like the big boys do

Example SAR scan of Kerbin at 1000x and then 10,000x warp

May Your Tentacles Orbit in Peace

Table of Contents

WARNING:

This add-on is a work-in-progress.

This means you should expect that it may not work, and you should be unsurprised if it does not progress.

Disclaimer aside, this add-on is widely used and it usually works just fine.

๐Ÿ” 0. Maintainers, Authors, Contributors, and Licenses


Maintainers

The current maintainer is:

Maintainers are the people who you should complain to if there is something wrong.

Complaints in various forms are prioritized as such:

  1. Pull Requests are given the highest priority possible. ~ 24 hour response
  2. Issues are given higher priority than other complaints. ~ 2 day response
  3. Forum Posts are given a medium priority. ~ 1 week response
  4. Forum Private Messages are given a low priority. We might forget!
  5. Reddit Posts and PMs are the lowest priority. We often lurk and don't login!

Authors

The current authors include:

Past authors include:

As of August 2014, the vast majority of code is damny's and DMagic's; and technogeeky and is slowly helping out here and there.

Contributors

In addition to the authors, the following people have contributed:

Licenses

For licensing information, please see the included LICENSE.txt file.

[Source Code][SCANsat:source] is available, as some licenses may require.

๐Ÿ” 1. Installation and Interoperability


โ—

๐Ÿ” a. Installation

โ—

  1. Put the SCANsat folder in your KSP installation's GameData folder.
  2. (Optional) Place the SCANsatRPM folder in your KSP installation's GameData folder.

๐Ÿ” b. GameData Layout

โ—

๐Ÿ” c. Other Add-Ons

S.C.A.N. is proud to collaborate with other KSP modding teams. Following is a table of all of the mods, add-ons, or software that we interoperate with. Do not fear though, this does not mean installation and usage of SCANsat is difficult!

Built Using Supported By
Support for Kethane Support for MKS
OpenResourceSystem Support for ALCOR
RasterPropMonitor Support for Karbonite
Blizzy78's Toolbar KSP: Interstellar
ModuleManager Extraplanetary Launchpads

As of the following versions:

  • SCANsat
    • v8.0 SCANsat Release version: v8.0
    • v9.0 SCANsat Dev version: v9.0

SCANsat is built against the following mods. MM, RPM, and Toolbar are all soft dependencies. This means your experience with SCANsat will be enhanced if you are using these mods, but they are not necessary.

  • Library Support
    • MM: ModuleManager version: 2.2.1
    • RPM: RasterPropMonitor version: v0.18.2
    • via (RPM) <- ALCOR: Blah Blah Capsule Blah Blah version: 0.9
    • Toolbar Blizzy's Toolbar version: 1.7.6

As of v8.0, SCANsat generically supports scanning for resources. These resources are powered by ORS (included with ZIP) and/or Kethane (available here, patch here). By working with these two mods, all other resource mod support follows.

  • Resource Scanning Support
    • ORS: OpenResourceSystem version: 1.1.0
    • via (ORS) <- KSPI: Interstellar version: 0.11
    • via (ORS) <- MKS: USI Kolonization Systems (MKS/OKS) version: 0.19.3
    • via (ORS) <- OKS: USI Kolonization Systems (MKS/OKS) version: 0.19.3
    • via (ORS) <- Karbonite (Release) version: 0.1.1
    • via (ORS) <- Karbonite (Dev) version: 0.1.1
    • Kethane Kethane version: 0.8.8
    • Kethane Kethane (patch by taniwha) version: 0.8.8.1
    • via (Kethane) <- EPL: Extra Planetary Launchpads version: v4.2.3

Notes

  • BOLD: is there to identify (b-)acronyms we endure
  • bold versions are those who we directly match
  • italics versions are those which use a mod we support
  • or (checked) means that we build against, test with, inter-operate with, a particular version of this mod.
  • or (unchecked) means that it may work, but we S.C.A.N. didn't verify

๐Ÿ” 2. Types of Scans


SCANsat supports several different kinds of scans (as opposed to scanning modules or parts).

As of v8.0 these include:

  • RadarLo: Basic, Low-Resolution RADAR Altimetry (b&w, limited zoom)
  • RadarHi: Advanced, High-Resolution RADAR Altimetry (in color, unlimited zoom)
  • Slope: Slope Data converted from RADAR data
  • Biome: Biome Detection and Classification (in color, unlimited zoom)
  • Anomaly: Anomaly Detection and Labeling
  • Resource: Scan for chemical or mineral resource on the surface.

Other parts and add-ons are free to include one or more of these kinds of scans. In general, we would request that similar (same order of magitude) scanning paramters and limitations are used on custom parts, but this is not a requirement.

๐Ÿ” a. Altimetry

โ—

๐Ÿ” b. Biome

โ—

๐Ÿ” c. Anomaly

โ—

๐Ÿ” d. Resources

โ—

๐Ÿ” 1. Kethane

โ—

๐Ÿ” 2. ORS

โ—

๐Ÿ” 3. Basic Usage


Put scanner part on rocket, aim rocket at sky, launch. If your rocket is not pointing at the sky, you are probably not going to map today, because most sensors only work above 5 km.

You can start scanning by selecting a SCANsat part's context menu, enabling the part. Here, you will find a small map.

๐Ÿ” 3a. FAQ: Finding a Good Altitude

Watch the data indicators on the small map to determine how well your scanners are performing.

too high

Solid ORANGE means you're too high (and therefore no data is being recorded):

too low

Flashing ORANGE/GREEN means you're too low (and therefore you have a FOV penalty):

just right

Solid GREEN means you're in an ideal orbit. Notice the larger swath width on the right:

๐Ÿ” 3b. Mismatched Scanners

In these examples, the SAR and Multi sensors are not very well matched. Because the SAR sensors is ideal above 750km, and becuase it has a large field of view penalty if it's down near the ideal for Multi (250km), these sensors probably should not be used on the same scanner.

SAR scanner with a thin swath width due to low altitude

RADAR scanner with an ideal swath width

The mapping interface consists of a small-ish map of the planet, as far as it has been scanned in your current game. It scans and updates quickly and shows positions of the active vessel, as well as other scanning vessels in orbit around the same planet. Orbital information is also provided. For a slower but more detailed view, see the big map.

Be sure to remember to pack enough batteries, radioisotope generators, and solar panels. If you forget, you'll run out of electricity, you'll stop recording data, and you'll see useless static:

Static! Oh no, adjust the rabbit ears!

๐Ÿ” 4. Big Map


A Big Big Map

A bigger map can be rendered on demand. Rendered maps are automatically saved to GameData/SCANsat/PluginData. Note that position indicators for vessels or anomalies are not visible on exported images (but they may be a future release).

You can mouse over the big map to see what sensors have data for the location, as well as terrain elevation, and other details.

Right-clicking on the big map shows a magnified view around the position where you clicked. Mouse operations work inside this magnified view just like they work outside, meaning the data displayed at the bottom window applies to your position inside the magnified view, and right-clicking inside it will increase magnification. This can be useful to find landing spots which won't kill your kerbals.

๐Ÿ” 5. Parts and Sensor Types


Part Scan Type FOV Altitude (Min) (Ideal) (Max)
RADAR Altimetry Sensor RadarLo / Slope 5 5000 m 5000 m 500 km
SAR Altimetry Sensor RadarHi 2 5000 m 750 km 800 km
Multispectral Sensor Biome ANOM 4 5000 m 250 km 500 km
Been There Done Thatยฎ Anomaly 1 0 m 0 m 2 km
MapTraqยฎ (deprecated) None N/A N/A N/A N/A

๐Ÿ” a. The RADAR Altimetry Sensor

RADAR

๐Ÿ” b. The SAR Altimetry Sensor

SAR

๐Ÿ” c. The Multispectral Sensor

Multi

๐Ÿ” d. Been There Done That

BTDT

๐Ÿ” e. MapTraq (deprecated)

MapTraq

๐Ÿ” 6. (Career Mode) Research and Development


The RADAR Altimetry sensor can be unlocked in Science Tech.

The SAR Altimetry sensor can be unlocked in Experimental Science.

The Multispectral sensor can be unlocked in Advanced Exploration.

The BTDT sensor can be unlocked in Field Science.

๐Ÿ” 6a. Minimum Scan for Science

Once you scan at least 30% of a particular map, you can use Analyze Data to get delicious science:

30% is your minimum

๐Ÿ” 6b. Getting Maximum Science

Between 30% and 100%, you will get a number of science points proportional to the percentage. Really, the upper cutoff is 95% in case you didn't scan the whole map.

Scan 95% to get all science

๐Ÿ” 7. Background Scanning


Note the background scanning (non-active vessels are scanning)

Unlike some other KSP scanning systems, SCANsat allows scanning with multiple vessels. All online scanners scan at the same time, but only when your active vessel has at least one of the parts included in this mod equipped and the mapping interface is open.

๐Ÿ” 8. Time Warp


SCANsat does not interpolate satellite paths during time warp; nevertheless, due to the relatively large field of view of each sensor, it's still possible to acquire data faster by time warping. The maximum recommended time warp speed is currently 10,000x. Scanning at this warp factor should allow identical scanning performance (in terms of swath width) as scanning at 1x.

As an example of speed, here is a BigMap rendering of a scan at 100x: this is pretty peaceful

And this is a BigMap rendering of the same orbit, but later in the scan. It starts at 1000x and then speeds up to 10,000x: this makes my OCD happy

Notice that the only gaps in coverage are those at the poles (ie, the selected inclination was not high enough to capture the poles).

๐Ÿ” 9. Note Concerning Data Sources


All data this mod shows you is pulled from your game as you play. This includes:

  • terrain elevation
  • biomes
  • anomiles

SCANsat can't guarantee that all anomalies will be found; in particular, some are so close to others that they don't show up on their own, and if the developers want to be sneaky then they can of course be sneaky.


About

Real Scanning, Real Science, at Warp Speed!

Resources

Stars

Watchers

Forks

Packages

No packages published